Skip to content

Commit ecbb324

Browse files
d45d45
committed
Adding v1.212 API docs for the 1.13 release
1 parent e01c89b commit ecbb324

113 files changed

Lines changed: 995 additions & 429 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎website/docs/trex_release-notes.md‎

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

99
---
1010

11+
### Tableau Extensions API version 1.13.0
12+
13+
*March 2025*
14+
15+
* Tableau Dashboard Extensions API library: `tableau.extensions.1.13.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 2025.1 or later. Download [Tableau Desktop](https://www.tableau.com/support/releases) or [Tableau Server](https://www.tableau.com/support/releases/server).
18+
19+
* To preview new features and test your extension with the latest version of Tableau in the Developer Sandbox, join the [Tableau Developer Program](http://www.tableau.com/developer) and request your own Tableau Cloud developer site.
20+
21+
What's new in this release:
22+
23+
* (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.
24+
25+
* 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).
26+
27+
* 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)).
28+
29+
30+
---
31+
32+
## Previous Releases
33+
34+
---
1135

1236
### Tableau Extensions API version 1.12.0
1337

@@ -60,10 +84,6 @@ Also in this release:
6084

6185
---
6286

63-
## Previous Releases
64-
65-
---
66-
6787
### Tableau Dashboard Extensions API version 1.11.0
6888

6989
*April 2024*

‎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/assets/tab_ext_class_worksheet.png‎

-40.1 KB
Binary file not shown.

‎website/static/api/assets/tab_viz_ext_class_worksheet.png‎

-51.8 KB
Binary file not shown.

‎website/static/api/enums/sharederrorcodes.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ <h2>Legend</h2>
516516
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
517517
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
518518

519-
ga('create', 'UA-625217-51', 'auto');
519+
ga('create', '469571326', 'auto');
520520
ga('send', 'pageview');
521521
</script>
522522
</body>

‎website/static/api/enums/tableau.analyticsobjecttype.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h2>Legend</h2>
221221
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
222222
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
223223

224-
ga('create', 'UA-625217-51', 'auto');
224+
ga('create', '469571326', 'auto');
225225
ga('send', 'pageview');
226226
</script>
227227
</body>

‎website/static/api/enums/tableau.annotationtype.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h2>Legend</h2>
221221
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
222222
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
223223

224-
ga('create', 'UA-625217-51', 'auto');
224+
ga('create', '469571326', 'auto');
225225
ga('send', 'pageview');
226226
</script>
227227
</body>

‎website/static/api/enums/tableau.classnamekey.html‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@ <h2>Index</h2>
7474
<section class="tsd-index-section ">
7575
<h3>Enumeration members</h3>
7676
<ul class="tsd-index-list">
77+
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#columndividers" class="tsd-kind-icon">Column<wbr>Dividers</a></li>
7778
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#dashboardtitle" class="tsd-kind-icon">Dashboard<wbr>Title</a></li>
79+
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#pane" class="tsd-kind-icon">Pane</a></li>
80+
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#rowdividers" class="tsd-kind-icon">Row<wbr>Dividers</a></li>
7881
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#storytitle" class="tsd-kind-icon">Story<wbr>Title</a></li>
7982
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#tooltip" class="tsd-kind-icon">Tooltip</a></li>
8083
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#worksheet" class="tsd-kind-icon">Worksheet</a></li>
@@ -86,6 +89,16 @@ <h3>Enumeration members</h3>
8689
</section>
8790
<section class="tsd-panel-group tsd-member-group ">
8891
<h2>Enumeration members</h2>
92+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
93+
<a name="columndividers" class="tsd-anchor"></a>
94+
<h3>Column<wbr>Dividers</h3>
95+
<div class="tsd-signature tsd-kind-icon">Column<wbr>Dividers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;tableau-column-dividers&quot;</span></div>
96+
<aside class="tsd-sources">
97+
<ul>
98+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:32</li>
99+
</ul>
100+
</aside>
101+
</section>
89102
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
90103
<a name="dashboardtitle" class="tsd-anchor"></a>
91104
<h3>Dashboard<wbr>Title</h3>
@@ -96,6 +109,26 @@ <h3>Dashboard<wbr>Title</h3>
96109
</ul>
97110
</aside>
98111
</section>
112+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
113+
<a name="pane" class="tsd-anchor"></a>
114+
<h3>Pane</h3>
115+
<div class="tsd-signature tsd-kind-icon">Pane<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;tableau-pane&quot;</span></div>
116+
<aside class="tsd-sources">
117+
<ul>
118+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:30</li>
119+
</ul>
120+
</aside>
121+
</section>
122+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
123+
<a name="rowdividers" class="tsd-anchor"></a>
124+
<h3>Row<wbr>Dividers</h3>
125+
<div class="tsd-signature tsd-kind-icon">Row<wbr>Dividers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;tableau-row-dividers&quot;</span></div>
126+
<aside class="tsd-sources">
127+
<ul>
128+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:31</li>
129+
</ul>
130+
</aside>
131+
</section>
99132
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
100133
<a name="storytitle" class="tsd-anchor"></a>
101134
<h3>Story<wbr>Title</h3>
@@ -156,9 +189,18 @@ <h3>Worksheet<wbr>Title</h3>
156189
<li class="current tsd-kind-enum tsd-parent-kind-module">
157190
<a href="tableau.classnamekey.html" class="tsd-kind-icon">Class<wbr>Name<wbr>Key</a>
158191
<ul>
192+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
193+
<a href="tableau.classnamekey.html#columndividers" class="tsd-kind-icon">Column<wbr>Dividers</a>
194+
</li>
159195
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
160196
<a href="tableau.classnamekey.html#dashboardtitle" class="tsd-kind-icon">Dashboard<wbr>Title</a>
161197
</li>
198+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
199+
<a href="tableau.classnamekey.html#pane" class="tsd-kind-icon">Pane</a>
200+
</li>
201+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
202+
<a href="tableau.classnamekey.html#rowdividers" class="tsd-kind-icon">Row<wbr>Dividers</a>
203+
</li>
162204
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
163205
<a href="tableau.classnamekey.html#storytitle" class="tsd-kind-icon">Story<wbr>Title</a>
164206
</li>
@@ -249,7 +291,7 @@ <h2>Legend</h2>
249291
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
250292
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
251293

252-
ga('create', 'UA-625217-51', 'auto');
294+
ga('create', '469571326', 'auto');
253295
ga('send', 'pageview');
254296
</script>
255297
</body>

‎website/static/api/enums/tableau.columntype.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h2>Legend</h2>
221221
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
222222
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
223223

224-
ga('create', 'UA-625217-51', 'auto');
224+
ga('create', '469571326', 'auto');
225225
ga('send', 'pageview');
226226
</script>
227227
</body>

‎website/static/api/enums/tableau.dashboardlayoutchange.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h3>Added</h3>
104104
<div class="tsd-signature tsd-kind-icon">Added<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;added&quot;</span></div>
105105
<aside class="tsd-sources">
106106
<ul>
107-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:80</li>
107+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:83</li>
108108
</ul>
109109
</aside>
110110
<div class="tsd-comment tsd-typography">
@@ -119,7 +119,7 @@ <h3>Dashboard<wbr>Changed</h3>
119119
<div class="tsd-signature tsd-kind-icon">Dashboard<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;dashboard-changed&quot;</span></div>
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:107</li>
122+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:110</li>
123123
</ul>
124124
</aside>
125125
<div class="tsd-comment tsd-typography">
@@ -134,7 +134,7 @@ <h3>Deselected</h3>
134134
<div class="tsd-signature tsd-kind-icon">Deselected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;deselected&quot;</span></div>
135135
<aside class="tsd-sources">
136136
<ul>
137-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:104</li>
137+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:107</li>
138138
</ul>
139139
</aside>
140140
<div class="tsd-comment tsd-typography">
@@ -149,7 +149,7 @@ <h3>Is<wbr>Floating<wbr>Changed</h3>
149149
<div class="tsd-signature tsd-kind-icon">Is<wbr>Floating<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;is-floating-changed&quot;</span></div>
150150
<aside class="tsd-sources">
151151
<ul>
152-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:86</li>
152+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:89</li>
153153
</ul>
154154
</aside>
155155
<div class="tsd-comment tsd-typography">
@@ -164,7 +164,7 @@ <h3>Is<wbr>Visible<wbr>Changed</h3>
164164
<div class="tsd-signature tsd-kind-icon">Is<wbr>Visible<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;is-visible-changed&quot;</span></div>
165165
<aside class="tsd-sources">
166166
<ul>
167-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:89</li>
167+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:92</li>
168168
</ul>
169169
</aside>
170170
<div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@ <h3>Name<wbr>Changed</h3>
179179
<div class="tsd-signature tsd-kind-icon">Name<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;name-changed&quot;</span></div>
180180
<aside class="tsd-sources">
181181
<ul>
182-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:98</li>
182+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:101</li>
183183
</ul>
184184
</aside>
185185
<div class="tsd-comment tsd-typography">
@@ -194,7 +194,7 @@ <h3>Position<wbr>Changed</h3>
194194
<div class="tsd-signature tsd-kind-icon">Position<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;position-changed&quot;</span></div>
195195
<aside class="tsd-sources">
196196
<ul>
197-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:92</li>
197+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:95</li>
198198
</ul>
199199
</aside>
200200
<div class="tsd-comment tsd-typography">
@@ -209,7 +209,7 @@ <h3>Removed</h3>
209209
<div class="tsd-signature tsd-kind-icon">Removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;removed&quot;</span></div>
210210
<aside class="tsd-sources">
211211
<ul>
212-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:83</li>
212+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:86</li>
213213
</ul>
214214
</aside>
215215
<div class="tsd-comment tsd-typography">
@@ -224,7 +224,7 @@ <h3>Selected</h3>
224224
<div class="tsd-signature tsd-kind-icon">Selected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;selected&quot;</span></div>
225225
<aside class="tsd-sources">
226226
<ul>
227-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:101</li>
227+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:104</li>
228228
</ul>
229229
</aside>
230230
<div class="tsd-comment tsd-typography">
@@ -239,7 +239,7 @@ <h3>Size<wbr>Changed</h3>
239239
<div class="tsd-signature tsd-kind-icon">Size<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;size-changed&quot;</span></div>
240240
<aside class="tsd-sources">
241241
<ul>
242-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:95</li>
242+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:98</li>
243243
</ul>
244244
</aside>
245245
<div class="tsd-comment tsd-typography">
@@ -376,7 +376,7 @@ <h2>Legend</h2>
376376
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
377377
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
378378

379-
ga('create', 'UA-625217-51', 'auto');
379+
ga('create', '469571326', 'auto');
380380
ga('send', 'pageview');
381381
</script>
382382
</body>

0 commit comments

Comments
 (0)