Skip to content

Commit e85db98

Browse files
authored
Merge pull request #606 from tableau/gh-pages-dev
Doc update for Release v1.14.0
2 parents 6cf330f + c8015c1 commit e85db98

13 files changed

Lines changed: 96 additions & 35 deletions

website/docs/trex_release-notes.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ description: What's new for each release of the Tableau Extensions API
88

99
---
1010

11+
### Tableau Extensions API version 1.14.0
12+
13+
*June 2025*
14+
15+
* 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 />
16+
17+
* 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).
18+
19+
What's new in this release:
20+
21+
* Added `hasAlias` and `aliasValue` attributes to [DataValue](pathname:///api/interfaces/datavalue.html).
22+
23+
* Fixed a bug that caused an error when calling the `getAllDataSourcesAsync` method on a workbook with no worksheets.
24+
25+
* Fixed a bug that caused an error when calling the `applyRangeFilterAsync` method with a `max` or `min` value of `0`.
26+
27+
---
28+
29+
## Previous Releases
30+
31+
---
32+
1133
### Tableau Extensions API version 1.13.0
1234

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

2951

30-
---
31-
32-
## Previous Releases
3352

34-
---
3553

3654
### Tableau Extensions API version 1.12.0
3755

website/docs/vizext/trex_viz_create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ This example illustrates some of the components that are common need to include
298298

299299
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).
300300

301-
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.
301+
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.
302302

303303
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.
304304

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

319319
## What's next?
320320

321-
- 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.
321+
- 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.
322322

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

website/docs/vizext/trex_viz_manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The versioning of the manifest is designed to be semantically simple and support
1515

1616
:::note
1717

18-
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.
18+
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.
1919

2020
:::
2121

website/static/api/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

website/static/api/globals.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ <h3>Categorical<wbr>Value</h3>
182182
<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>
183183
<aside class="tsd-sources">
184184
<ul>
185-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/SelectionInterfaces.ts:65</li>
185+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/SelectionInterfaces.ts:66</li>
186186
</ul>
187187
</aside>
188188
<div class="tsd-comment tsd-typography">

website/static/api/index.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ <h2>Viz extensions</h2>
134134
</style>
135135
<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.
136136
Salesforce, Inc. Salesforce Tower, 415 Mission Street, 3rd Floor, San Francisco, CA 94105, United States</p>
137-
<p><sub>Documentation last generated on: <script>document.write(new Date().toLocaleString())</script></sub></p>
138137
</div>
139138
</div>
140139
</div>

website/static/api/interfaces/datatablereader.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h3>page<wbr>Count</h3>
137137
<div class="tsd-signature tsd-kind-icon">page<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
138138
<aside class="tsd-sources">
139139
<ul>
140-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:213</li>
140+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:224</li>
141141
</ul>
142142
</aside>
143143
<div class="tsd-comment tsd-typography">
@@ -154,7 +154,7 @@ <h3>total<wbr>Row<wbr>Count</h3>
154154
<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>
155155
<aside class="tsd-sources">
156156
<ul>
157-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:208</li>
157+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:219</li>
158158
</ul>
159159
</aside>
160160
<div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@ <h3>get<wbr>All<wbr>Pages<wbr>Async</h3>
178178
<li class="tsd-description">
179179
<aside class="tsd-sources">
180180
<ul>
181-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:255</li>
181+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:266</li>
182182
</ul>
183183
</aside>
184184
<div class="tsd-comment tsd-typography">
@@ -220,7 +220,7 @@ <h3>get<wbr>Page<wbr>Async</h3>
220220
<li class="tsd-description">
221221
<aside class="tsd-sources">
222222
<ul>
223-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:234</li>
223+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:245</li>
224224
</ul>
225225
</aside>
226226
<div class="tsd-comment tsd-typography">
@@ -262,7 +262,7 @@ <h3>release<wbr>Async</h3>
262262
<li class="tsd-description">
263263
<aside class="tsd-sources">
264264
<ul>
265-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:262</li>
265+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:273</li>
266266
</ul>
267267
</aside>
268268
<div class="tsd-comment tsd-typography">

website/static/api/interfaces/datavalue.html

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,9 @@ <h2>Index</h2>
7979
<section class="tsd-index-section ">
8080
<h3>Properties</h3>
8181
<ul class="tsd-index-list">
82+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#aliasvalue" class="tsd-kind-icon">alias<wbr>Value</a></li>
8283
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#formattedvalue" class="tsd-kind-icon">formatted<wbr>Value</a></li>
84+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#hasalias" class="tsd-kind-icon">has<wbr>Alias</a></li>
8385
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#nativevalue" class="tsd-kind-icon">native<wbr>Value</a></li>
8486
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datavalue.html#value" class="tsd-kind-icon">value</a></li>
8587
</ul>
@@ -89,6 +91,23 @@ <h3>Properties</h3>
8991
</section>
9092
<section class="tsd-panel-group tsd-member-group ">
9193
<h2>Properties</h2>
94+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
95+
<a name="aliasvalue" class="tsd-anchor"></a>
96+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> alias<wbr>Value</h3>
97+
<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>
98+
<aside class="tsd-sources">
99+
<ul>
100+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:120</li>
101+
</ul>
102+
</aside>
103+
<div class="tsd-comment tsd-typography">
104+
<dl class="tsd-comment-tags">
105+
<dt>returns</dt>
106+
<dd><p>The alias of a value only if <code>hasAlias</code> is true.</p>
107+
</dd>
108+
</dl>
109+
</div>
110+
</section>
92111
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93112
<a name="formattedvalue" class="tsd-anchor"></a>
94113
<h3><span class="tsd-flag ts-flagOptional">Optional</span> formatted<wbr>Value</h3>
@@ -107,6 +126,24 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> formatted<wbr>Value</
107126
</dl>
108127
</div>
109128
</section>
129+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
130+
<a name="hasalias" class="tsd-anchor"></a>
131+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> has<wbr>Alias</h3>
132+
<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>
133+
<aside class="tsd-sources">
134+
<ul>
135+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:126</li>
136+
</ul>
137+
</aside>
138+
<div class="tsd-comment tsd-typography">
139+
<dl class="tsd-comment-tags">
140+
<dt>returns</dt>
141+
<dd><p>Indicates if the DataValue contains an alias (for DataValues of Parameters with domain restriction type
142+
<code>ParameterValueType.List</code>).</p>
143+
</dd>
144+
</dl>
145+
</div>
146+
</section>
110147
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
111148
<a name="nativevalue" class="tsd-anchor"></a>
112149
<h3>native<wbr>Value</h3>
@@ -172,9 +209,15 @@ <h3>value</h3>
172209
<li class="current tsd-kind-interface">
173210
<a href="datavalue.html" class="tsd-kind-icon">Data<wbr>Value</a>
174211
<ul>
212+
<li class=" tsd-kind-property tsd-parent-kind-interface">
213+
<a href="datavalue.html#aliasvalue" class="tsd-kind-icon">alias<wbr>Value</a>
214+
</li>
175215
<li class=" tsd-kind-property tsd-parent-kind-interface">
176216
<a href="datavalue.html#formattedvalue" class="tsd-kind-icon">formatted<wbr>Value</a>
177217
</li>
218+
<li class=" tsd-kind-property tsd-parent-kind-interface">
219+
<a href="datavalue.html#hasalias" class="tsd-kind-icon">has<wbr>Alias</a>
220+
</li>
178221
<li class=" tsd-kind-property tsd-parent-kind-interface">
179222
<a href="datavalue.html#nativevalue" class="tsd-kind-icon">native<wbr>Value</a>
180223
</li>

website/static/api/interfaces/getsummarydataoptions.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> apply<wbr>Worksheet<w
110110
<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>
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:166</li>
113+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:177</li>
114114
</ul>
115115
</aside>
116116
<div class="tsd-comment tsd-typography">
@@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> columns<wbr>ToInclude
131131
<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>
132132
<aside class="tsd-sources">
133133
<ul>
134-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:138</li>
134+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:149</li>
135135
</ul>
136136
</aside>
137137
<div class="tsd-comment tsd-typography">
@@ -152,7 +152,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Aliases</h
152152
<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>
153153
<aside class="tsd-sources">
154154
<ul>
155-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:125</li>
155+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:136</li>
156156
</ul>
157157
</aside>
158158
<div class="tsd-comment tsd-typography">
@@ -167,7 +167,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Selection<
167167
<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>
168168
<aside class="tsd-sources">
169169
<ul>
170-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:130</li>
170+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:141</li>
171171
</ul>
172172
</aside>
173173
<div class="tsd-comment tsd-typography">
@@ -182,7 +182,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> include<wbr>Data<wbr>
182182
<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>
183183
<aside class="tsd-sources">
184184
<ul>
185-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:158</li>
185+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:169</li>
186186
</ul>
187187
</aside>
188188
<div class="tsd-comment tsd-typography">
@@ -204,7 +204,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Rows</h3>
204204
<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>
205205
<aside class="tsd-sources">
206206
<ul>
207-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:149</li>
207+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:160</li>
208208
</ul>
209209
</aside>
210210
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)