Extensions API v1.13 release (Tableau 2025.1) (aka 254)

.github/workflows/deploy.yaml

@@ -28,19 +28,19 @@ jobs:
         id: setup-pages
 
       - name: Checkout gh-pages
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: gh-pages
           path: gh-pages
 
       - name: Checkout gh-pages-dev
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: gh-pages-dev
           path: gh-pages-dev
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20.5'
           cache: yarn
@@ -79,10 +79,10 @@ jobs:
 
 
       - name: Upload webpage artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: 'combined'
 
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

.github/workflows/proof.yaml

@@ -14,10 +14,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20.5'
           cache: yarn
@@ -43,6 +43,6 @@ jobs:
           GITHUB_BASE_PATH: ${{ steps.setup-pages.outputs.base_path }}
 
       - name: Upload webpage artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: 'website/build'

README.md

@@ -41,5 +41,6 @@ As soon as your pull request to https://github.com/tableau/extensions-api is mer
 
 | Branch | URL |
 |---- |---- |
-| `dev` | [https://tableau.github.io/extensions-api/gh-pages-dev](https://tableau.github.io/extensions-api/gh-pages-dev) |
-| `main` | [https://tableau.github.io/extensions-api](https://tableau.github.io/extensions-api/)  |
+| `gh-pages-dev` | [https://tableau.github.io/extensions-api/gh-pages-dev](https://tableau.github.io/extensions-api/gh-pages-dev) |
+| `gh-pages` | [https://tableau.github.io/textensions-api](https://tableau.github.io/extensions-api/)  |
+

website/docs/trex_release-notes.md

@@ -8,6 +8,30 @@ description: What's new for each release of the Tableau Extensions API
 
 ---
 
+### Tableau Extensions API version 1.13.0
+
+*March 2025*
+
+* 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/>
+
+* 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).
+
+* 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.
+
+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.
+
+* 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)).
+
+
+---
+
+## Previous Releases
+
+---
 
 ### Tableau Extensions API version 1.12.0
 
@@ -60,10 +84,6 @@ Also in this release:
 
 ---
 
-## Previous Releases
-
----
-
 ### Tableau Dashboard Extensions API version 1.11.0
 
 *April 2024*

website/static/api/enums/sharederrorcodes.html

@@ -516,7 +516,7 @@ <h2>Legend</h2>
                 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
-        ga('create', 'UA-625217-51', 'auto');
+        ga('create', '469571326', 'auto');
         ga('send', 'pageview');
     </script>
 </body>

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

@@ -221,7 +221,7 @@ <h2>Legend</h2>
                 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
-        ga('create', 'UA-625217-51', 'auto');
+        ga('create', '469571326', 'auto');
         ga('send', 'pageview');
     </script>
 </body>

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

@@ -221,7 +221,7 @@ <h2>Legend</h2>
                 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
-        ga('create', 'UA-625217-51', 'auto');
+        ga('create', '469571326', 'auto');
         ga('send', 'pageview');
     </script>
 </body>

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

@@ -74,7 +74,10 @@ <h2>Index</h2>
 						<section class="tsd-index-section ">
 							<h3>Enumeration members</h3>
 							<ul class="tsd-index-list">
+								<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>
 								<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>
+								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#pane" class="tsd-kind-icon">Pane</a></li>
+								<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>
 								<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>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.classnamekey.html#tooltip" class="tsd-kind-icon">Tooltip</a></li>
 								<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>
 			</section>
 			<section class="tsd-panel-group tsd-member-group ">
 				<h2>Enumeration members</h2>
+				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
+					<a name="columndividers" class="tsd-anchor"></a>
+					<h3>Column<wbr>Dividers</h3>
+					<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>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:32</li>
+						</ul>
+					</aside>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
 					<a name="dashboardtitle" class="tsd-anchor"></a>
 					<h3>Dashboard<wbr>Title</h3>
@@ -96,6 +109,26 @@ <h3>Dashboard<wbr>Title</h3>
 						</ul>
 					</aside>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
+					<a name="pane" class="tsd-anchor"></a>
+					<h3>Pane</h3>
+					<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>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:30</li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
+					<a name="rowdividers" class="tsd-anchor"></a>
+					<h3>Row<wbr>Dividers</h3>
+					<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>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:31</li>
+						</ul>
+					</aside>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
 					<a name="storytitle" class="tsd-anchor"></a>
 					<h3>Story<wbr>Title</h3>
@@ -156,9 +189,18 @@ <h3>Worksheet<wbr>Title</h3>
 					<li class="current tsd-kind-enum tsd-parent-kind-module">
 						<a href="tableau.classnamekey.html" class="tsd-kind-icon">Class<wbr>Name<wbr>Key</a>
 						<ul>
+							<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>
 							<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>
+							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
+								<a href="tableau.classnamekey.html#pane" class="tsd-kind-icon">Pane</a>
+							</li>
+							<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>
 							<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>
@@ -249,7 +291,7 @@ <h2>Legend</h2>
                 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
-        ga('create', 'UA-625217-51', 'auto');
+        ga('create', '469571326', 'auto');
         ga('send', 'pageview');
     </script>
 </body>

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

@@ -221,7 +221,7 @@ <h2>Legend</h2>
                 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
-        ga('create', 'UA-625217-51', 'auto');
+        ga('create', '469571326', 'auto');
         ga('send', 'pageview');
     </script>
 </body>

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

@@ -104,7 +104,7 @@ <h3>Added</h3>
 					<div class="tsd-signature tsd-kind-icon">Added<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;added&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:80</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:83</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -119,7 +119,7 @@ <h3>Dashboard<wbr>Changed</h3>
 					<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>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:107</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:110</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -134,7 +134,7 @@ <h3>Deselected</h3>
 					<div class="tsd-signature tsd-kind-icon">Deselected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;deselected&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:104</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:107</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -149,7 +149,7 @@ <h3>Is<wbr>Floating<wbr>Changed</h3>
 					<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>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:86</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:89</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -164,7 +164,7 @@ <h3>Is<wbr>Visible<wbr>Changed</h3>
 					<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>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:89</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:92</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@ <h3>Name<wbr>Changed</h3>
 					<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>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:98</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:101</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -194,7 +194,7 @@ <h3>Position<wbr>Changed</h3>
 					<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>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:92</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:95</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -209,7 +209,7 @@ <h3>Removed</h3>
 					<div class="tsd-signature tsd-kind-icon">Removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;removed&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:83</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:86</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -224,7 +224,7 @@ <h3>Selected</h3>
 					<div class="tsd-signature tsd-kind-icon">Selected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;selected&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:101</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:104</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -239,7 +239,7 @@ <h3>Size<wbr>Changed</h3>
 					<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>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:95</li>
+							<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:98</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -376,7 +376,7 @@ <h2>Legend</h2>
                 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
-        ga('create', 'UA-625217-51', 'auto');
+        ga('create', '469571326', 'auto');
         ga('send', 'pageview');
     </script>
 </body>