Skip to content

Doc update for Release v1.14.0 #606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d45 merged 8 commits into from
Jun 13, 2025
Merged

Doc update for Release v1.14.0 #606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1bc916d
Copy assets from release_extensions_v1.14.0
anyoung-tableau Jun 10, 2025
7b22c79
Merge pull request #600 from tableau/anyoung/gh-pages-dev-114
d45 Jun 10, 2025
ec6015d
fixing typo, wording, and api index
d45 Jun 11, 2025
9300080
Merge pull request #602 from d45/d45/fix_icons_known_issues
d45 Jun 11, 2025
5eb02e1
using the corrected file
d45 Jun 12, 2025
d79d772
Merge pull request #603 from d45/d45/api_index_fix
d45 Jun 12, 2025
0bd54f5
Added release notes for 1.14 (256)
d45 Jun 12, 2025
c8015c1
Merge pull request #604 from d45/d45/v1_14_release
d45 Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions website/docs/trex_release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ description: What's new for each release of the Tableau Extensions API

---

### Tableau Extensions API version 1.14.0

*June 2025*

* Tableau Dashboard Extensions API library: `tableau.extensions.1.14.0.js` <br />(download or clone the Extensions API repository on [GitHub](https://github.com/tableau/extensions-api)). <br />

* Certain features in this release are only available in Tableau Cloud and Tableau Desktop 2025.2 or later. Download [Tableau Desktop](https://www.tableau.com/support/releases).

What's new in this release:

* 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.

* Fixed a bug that caused an error when calling the `applyRangeFilterAsync` method with a `max` or `min` value of `0`.

---

## Previous Releases

---

### Tableau Extensions API version 1.13.0

*March 2025*
Expand All @@ -27,11 +49,7 @@ What's new in this release:
* 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)).


---

## Previous Releases

---

### Tableau Extensions API version 1.12.0

Expand Down
4 changes: 2 additions & 2 deletions website/docs/vizext/trex_viz_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ This example illustrates some of the components that are common need to include

This is the code that draws the viz based on the current encodings and data. This example is extremely simplified and just uses the method called to retrieve the encoding, `worksheet.getVisualSpecificationAsync()`. From the `visualSpec`, the list of encodings is collected from the Marks card. The HelloVizExtensions example just has one encoding tile labeled "Drop..." The list of fields that are dropped on the tile are displayed in the content area of the worksheet. In real life, you would use multiple encodings that would correspond to the coordinates in your visualization (for example, x, y, and r).

The other missing piece from this code example is the data. To retrieve the data from the worksheet, you call the `worksheet.getSummaryDataReaderAsync()` method. This method returns a `DataTableReader`, which you use to page through the summary data in the worksheet, to extract the rows of data. See the conncecteScatterplot viz extension sample to see an example of how this is done.
The other missing piece from this code example is the data. To retrieve the data from the worksheet, you call the `worksheet.getSummaryDataReaderAsync()` method. This method returns a `DataTableReader`, which you use to page through the summary data in the worksheet, to extract the rows of data. See the ConnectedScatterplot viz extension sample to see an example of how this is done.

Finally, after you have the data and the map of encodings to fields you can pass this to code that can generate a scatterplot, a Sankey diagram, or network visualization. This example just prints the fields to the content area of the worksheet. But it's a start.

Expand All @@ -318,7 +318,7 @@ Our sample code follows the [Semi-Standard Style](https://github.com/Flet/semist

## What's next?

- For more information about how you can use the Extensions API, go look at the [Samples](https://github.com/tableau/extensions-api/tree/main/Samples/). Study the sample, connectedScatterPlot, to see a full implementation of a viz extension.
- For more information about how you can use the Extensions API, go look at the [Samples](https://github.com/tableau/extensions-api/tree/main/Samples/). Study the sample, ConnectedScatterPlot, to see a full implementation of a viz extension.

- Get familiar with the programming interface of the Extensions API, see [API Reference](pathname:///api/).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/vizext/trex_viz_manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The versioning of the manifest is designed to be semantically simple and support

:::note

Each extension must be uniquely identified. If multiple extensions in a workbook share the same combination of URL, ID, and version number, the extension zones will not load properly. As a best practice, use unique identifiers for each viz or dashboard extension when creating the manifest file (.trex). For example, for viz extensions, make sure that the same `<worksheet-extension>` `id` and `extension-version`, and the `<source-location>` `url` aren't all used in other extensions.
Each extension must be uniquely identified. If multiple extensions in a workbook share the same combination of URL, ID, and version number, the extension zones will not load properly. As a best practice, use unique identifiers for each viz or dashboard extension when creating the manifest file (.trex). For example, for viz extensions, make sure that the same `<worksheet-extension>` `id` and `extension-version`, and the `<source-location>` `url` aren't all used together in other extensions.

:::

Expand Down
2 changes: 1 addition & 1 deletion website/static/api/assets/js/search.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion website/static/api/globals.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ <h3>Categorical<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">Categorical<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/SelectionInterfaces.ts:65</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/SelectionInterfaces.ts:66</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
1 change: 0 additions & 1 deletion website/static/api/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ <h2>Viz extensions</h2>
</style>
<p class="copyRight">&copy; Copyright <script>document.write(new Date().getFullYear())</script> Salesforce, Inc. <a href="https://www.salesforce.com/company/legal/tmcusageguidelines/">All rights reserved.</a> Various trademarks held by their respective owners.
Salesforce, Inc. Salesforce Tower, 415 Mission Street, 3rd Floor, San Francisco, CA 94105, United States</p>
<p><sub>Documentation last generated on: <script>document.write(new Date().toLocaleString())</script></sub></p>
</div>
</div>
</div>
Expand Down
10 changes: 5 additions & 5 deletions website/static/api/interfaces/datatablereader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h3>page<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">page<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:213</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:224</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -154,7 +154,7 @@ <h3>total<wbr>Row<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Row<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:208</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:219</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -178,7 +178,7 @@ <h3>get<wbr>All<wbr>Pages<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:255</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:266</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -220,7 +220,7 @@ <h3>get<wbr>Page<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:234</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:245</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -262,7 +262,7 @@ <h3>release<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:262</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:273</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
43 changes: 43 additions & 0 deletions website/static/api/interfaces/datavalue.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#aliasvalue" class="tsd-kind-icon">alias<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#formattedvalue" class="tsd-kind-icon">formatted<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#hasalias" class="tsd-kind-icon">has<wbr>Alias</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#nativevalue" class="tsd-kind-icon">native<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#value" class="tsd-kind-icon">value</a></li>
</ul>
Expand All @@ -89,6 +91,23 @@ <h3>Properties</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="aliasvalue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> alias<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">alias<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:120</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>returns</dt>
<dd><p>The alias of a value only if <code>hasAlias</code> is true.</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="formattedvalue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> formatted<wbr>Value</h3>
Expand All @@ -107,6 +126,24 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> formatted<wbr>Value</
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hasalias" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> has<wbr>Alias</h3>
<div class="tsd-signature tsd-kind-icon">has<wbr>Alias<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:126</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>returns</dt>
<dd><p>Indicates if the DataValue contains an alias (for DataValues of Parameters with domain restriction type
<code>ParameterValueType.List</code>).</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nativevalue" class="tsd-anchor"></a>
<h3>native<wbr>Value</h3>
Expand Down Expand Up @@ -172,9 +209,15 @@ <h3>value</h3>
<li class="current tsd-kind-interface">
<a href="datavalue.html" class="tsd-kind-icon">Data<wbr>Value</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datavalue.html#aliasvalue" class="tsd-kind-icon">alias<wbr>Value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datavalue.html#formattedvalue" class="tsd-kind-icon">formatted<wbr>Value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datavalue.html#hasalias" class="tsd-kind-icon">has<wbr>Alias</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datavalue.html#nativevalue" class="tsd-kind-icon">native<wbr>Value</a>
</li>
Expand Down
12 changes: 6 additions & 6 deletions website/static/api/interfaces/getsummarydataoptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> apply<wbr>Worksheet<w
<div class="tsd-signature tsd-kind-icon">apply<wbr>Worksheet<wbr>Formatting<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:166</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:177</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> columns<wbr>ToInclude
<div class="tsd-signature tsd-kind-icon">columns<wbr>ToInclude<wbr>ById<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:138</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:149</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -152,7 +152,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Aliases</h
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Aliases<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:125</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:136</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -167,7 +167,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Selection<
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Selection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:130</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:141</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -182,7 +182,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> include<wbr>Data<wbr>
<div class="tsd-signature tsd-kind-icon">include<wbr>Data<wbr>Values<wbr>Option<span class="tsd-signature-symbol">:</span> <a href="../enums/tableau.includedatavaluesoption.html" class="tsd-signature-type">IncludeDataValuesOption</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:158</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:169</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -204,7 +204,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Rows</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Rows<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:149</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:160</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading