Skip to content

Commit f27c6e4

Browse files
d45d45
authored
Merge branch 'gh-pages-dev' into d45/trailing_comma
2 parents f277294 + 35c03d6 commit f27c6e4

File tree

122 files changed

+4118
-1025
lines changed

Some content is hidden

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

122 files changed

+4118
-1025
lines changed

Diff for: ‎.github/workflows/deploy.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,19 @@ jobs:
2828
id: setup-pages
2929

3030
- name: Checkout gh-pages
31-
uses: actions/checkout@v3
31+
uses: actions/checkout@v4
3232
with:
3333
ref: gh-pages
3434
path: gh-pages
3535

3636
- name: Checkout gh-pages-dev
37-
uses: actions/checkout@v3
37+
uses: actions/checkout@v4
3838
with:
3939
ref: gh-pages-dev
4040
path: gh-pages-dev
4141

4242
- name: Setup node
43-
uses: actions/setup-node@v3
43+
uses: actions/setup-node@v4
4444
with:
4545
node-version: '20.5'
4646
cache: yarn
@@ -79,10 +79,10 @@ jobs:
7979
8080
8181
- name: Upload webpage artifact
82-
uses: actions/upload-pages-artifact@v1
82+
uses: actions/upload-pages-artifact@v3
8383
with:
8484
path: 'combined'
8585

8686
- name: Deploy to GitHub Pages
8787
id: deployment
88-
uses: actions/deploy-pages@v2
88+
uses: actions/deploy-pages@v4

Diff for: ‎.github/workflows/proof.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ jobs:
1414
runs-on: ubuntu-latest
1515
steps:
1616
- name: Checkout
17-
uses: actions/checkout@v3
17+
uses: actions/checkout@v4
1818

1919
- name: Setup node
20-
uses: actions/setup-node@v3
20+
uses: actions/setup-node@v4
2121
with:
2222
node-version: '20.5'
2323
cache: yarn
@@ -43,6 +43,6 @@ jobs:
4343
GITHUB_BASE_PATH: ${{ steps.setup-pages.outputs.base_path }}
4444

4545
- name: Upload webpage artifact
46-
uses: actions/upload-pages-artifact@v1
46+
uses: actions/upload-pages-artifact@v3
4747
with:
4848
path: 'website/build'

Diff for: ‎README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@ As soon as your pull request to https://github.com/tableau/extensions-api is mer
4141

4242
| Branch | URL |
4343
|---- |---- |
44-
| `dev` | [https://tableau.github.io/extensions-api/gh-pages-dev](https://tableau.github.io/extensions-api/gh-pages-dev) |
45-
| `main` | [https://tableau.github.io/textensions-api](https://tableau.github.io/extensions-api/) |
44+
| `gh-pages-dev` | [https://tableau.github.io/extensions-api/gh-pages-dev](https://tableau.github.io/extensions-api/gh-pages-dev) |
45+
| `gh-pages` | [https://tableau.github.io/textensions-api](https://tableau.github.io/extensions-api/) |
46+

Diff for: ‎website/docs/dashext/trex_examples.md

+5
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ The [Samples-Typescript](https://github.com/tableau/extensions-api/tree/master/S
3939

4040
Finds and displays all the parameters in the dashboard and then sets an event listener that waits for a parameter to change, which triggers a refresh.
4141

42+
- **[PdfViewer (Typescript)](https://github.com/tableau/extensions-api/tree/master/Samples-Typescript/Dashboard/PdfViewer?=target="_blank")**
43+
44+
Demonstrates how to use Extensions API features, such as settings, configuration, and parameters in a Typescript application. The sample allows PDF files to be viewed in a networked dashboard extension.
45+
46+
4247
- **[Settings](https://github.com/tableau/extensions-api/tree/master/Samples/Dashboard/Settings?=target="_blank")**
4348

4449
Uses the `settings` namespace to save settings (key-value pairs) for the extension. Demonstrates how you can save settings for each instance of an extension, which enables sharing common views of a workbook.

Diff for: ‎website/docs/trex_release-notes.md

+24-4
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*

Diff for: ‎website/docusaurus.config.js

+41-10
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ const getConfig = async () => {
5757
// Please change this to your repo.
5858
// Remove this to remove the "edit this page" links.
5959
editUrl:
60-
'https://github.dev/tableau/extensions-api/blob/main/website/',
60+
'https://github.com/tableau/extensions-api/blob/gh-pages-dev/website',
6161
remarkPlugins: [remarkDefList],
6262
sidebarCollapsed: true,
6363
},
@@ -231,12 +231,12 @@ const getConfig = async () => {
231231
'@docusaurus/plugin-google-gtag',
232232
{
233233
// trackingID: 'UA-625217-51',
234-
trackingID: '376609887',
234+
trackingID: '469571326',
235235
anonymizeIP: true,
236236
},
237237
],
238238

239-
/* [
239+
[
240240
'@docusaurus/plugin-client-redirects',
241241
{
242242
redirects: [
@@ -246,22 +246,53 @@ const getConfig = async () => {
246246
to: '/docs/publish/trex_publish',
247247
from: '/docs/trex_publish',
248248
},
249-
{
250-
to: '/docs/publish/trex_contributing',
251-
from: '/docs/trex_contributing',
252-
},
253249
{
254250
to: '/docs/publish/trex_sandbox_publish',
255251
from: '/docs/trex_sandbox_publish',
256252
},
257-
// dashext folder
253+
// (portal page fix)
258254
{
259-
to: '/docs/dashext/trex_getstarted',
255+
to: '/docs',
260256
from: '/docs/trex_getstarted',
261257
},
258+
// (dev portal page fix)
259+
{
260+
to: '/docs/publish/trex_contributing',
261+
from: '/docs/trex_contributing',
262+
},
263+
// (dev portal page fix)
264+
{
265+
to: '/docs/security/trex_security',
266+
from: '/docs/trex_security',
267+
},
268+
// dev portal page fix
269+
{
270+
to: '/docs/debug/trex_debugging',
271+
from: '/docs/trex_debugging',
272+
},
273+
// dev portal page fix
274+
{
275+
to: '/docs/debug/trex_debug_server',
276+
from: '/docs/trex_debug_server',
277+
},
278+
// dev portal page fix
279+
{
280+
to: '/docs/debug/trex_logging',
281+
from: '/docs/trex_logging',
282+
},
283+
// dev portal page fix
284+
{
285+
to: '/docs/security/trex_xss_guidance',
286+
from: '/docs/trex_xss_guidance',
287+
},
288+
// dev portal page fix
289+
{
290+
to: '/docs/security/trex_sandbox_test',
291+
from: '/docs/trex_sandbox_test',
292+
},
262293
],
263294
},
264-
], */
295+
],
265296

266297
],
267298

Diff for: ‎website/package.json

+8-7
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@
1919
},
2020
"dependencies": {
2121
"@babel/helper-explode-assignable-expression": "^7.18.6",
22-
"@docusaurus/core": "^3.4.0",
23-
"@docusaurus/plugin-google-tag-manager": "^3.4.0",
24-
"@docusaurus/preset-classic": "^3.4.0",
25-
"@docusaurus/theme-mermaid": "^3.4.0",
26-
"@docusaurus/utils-validation": "^3.4.0",
22+
"@docusaurus/core": "^3.7.0",
23+
"@docusaurus/plugin-client-redirects": "^3.7.0",
24+
"@docusaurus/plugin-google-tag-manager": "^3.7.0",
25+
"@docusaurus/preset-classic": "^3.7.0",
26+
"@docusaurus/theme-mermaid": "^3.7.0",
27+
"@docusaurus/utils-validation": "^3.7.0",
2728
"@easyops-cn/docusaurus-search-local": "^0.40.1",
2829
"@mdx-js/react": "^3.0.0",
2930
"clsx": "^1.2.1",
@@ -36,8 +37,8 @@
3637
"tslib": "^2.6.2"
3738
},
3839
"devDependencies": {
39-
"@docusaurus/module-type-aliases": "^3.4.0",
40-
"@docusaurus/types": "^3.4.0",
40+
"@docusaurus/module-type-aliases": "^3.7.0",
41+
"@docusaurus/types": "^3.7.0",
4142
"@tsconfig/docusaurus": "^1.0.5",
4243
"prettier": "^2.8.4",
4344
"ts-node": "^10.9.1",

Diff for: ‎website/static/api/assets/js/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎website/static/api/assets/tab_ext_class_worksheet.png

-40.1 KB
Binary file not shown.

Diff for: ‎website/static/api/assets/tab_viz_ext_class_worksheet.png

-51.8 KB
Binary file not shown.

Diff for: ‎website/static/api/enums/sharederrorcodes.html

+1-1
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>

Diff for: ‎website/static/api/enums/tableau.analyticsobjecttype.html

+1-1
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>

Diff for: ‎website/static/api/enums/tableau.annotationtype.html

+1-1
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>

Diff for: ‎website/static/api/enums/tableau.classnamekey.html

+43-1
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>

Diff for: ‎website/static/api/enums/tableau.columntype.html

+1-1
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>

0 commit comments

Comments
 (0)