Skip to content

Commit 628f655

Browse files
authored
Merge pull request #614 from d45/d45/v1_15_release
v1.15 release notes; new desktop debug arg
2 parents b4e45f6 + 1823609 commit 628f655

3 files changed

Lines changed: 36 additions & 12 deletions

File tree

233 KB
Loading

website/docs/debug/trex_debugging.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,14 @@ Latest maintenance release of 2020.2.7+, 2020.3.6+, 2020.4.2+ | 87.0.4280 | Chro
4444

4545
## Start Tableau Desktop and enable debugging (Windows)
4646

47-
48-
1. Exit Tableau if it is already running on your computer.
47+
1. Exit Tableau if it is already running on your computer.
4948
2. Open a Command Prompt window.
5049
2. Start Tableau using the following command.
5150
<br/>Replace `<version>` with the version of Tableau you are using (for example, `Tableau 2018.3`).
5251

5352
```cli
5453
55-
"C:\Program Files\Tableau\Tableau <version>\bin\tableau.exe" --remote-debugging-port=8696
54+
"C:\Program Files\Tableau\Tableau <version>\bin\tableau.exe" --webEngineArgs --remote-debugging-port=8696
5655
5756
```
5857

@@ -72,9 +71,9 @@ For convenience, you could also create a shortcut for Tableau and add the remote
7271

7372
1. Select Tableau from the **Start** menu, and then right-click and select **Properties** or select **Open file location**.<br/>
7473
If you open the file location, you can create a new shortcut to `Tableau.exe` (call it something like *Tableau - Debug* ). Right click the shortcut to open the Properties dialog box.
75-
3. In the Properties dialog box, append `-remote-debugging-port=8696` at the end of the command in the **Target** text box. The debugging option goes after the closing quotation mark for `"Tableau.exe"`.
74+
3. In the Properties dialog box, append `--webEngineArgs -remote-debugging-port=8696` at the end of the command in the **Target** text box. The debugging option goes after the closing quotation mark for `"Tableau.exe"`.
7675

77-
![Debug Shortcut](../assets/Tableau_shortcut_debug.png)
76+
![Debug Shortcut](../assets/Tableau_shortcut_debug2.png)
7877

7978
---
8079
## Start Tableau Desktop and enable debugging (macOS)
@@ -85,7 +84,7 @@ If you open the file location, you can create a new shortcut to `Tableau.exe` (c
8584

8685
```cli
8786
88-
open /Applications/Tableau\ Desktop\ <version>.app --args --remote-debugging-port=8696
87+
open /Applications/Tableau\ Desktop\ <version>.app --args --webEngineArgs --remote-debugging-port=8696
8988
9089
```
9190

@@ -161,8 +160,7 @@ The debugger will pause each time the first statement of a script runs, allowing
161160

162161
While you are debugging your extension, there are times you might want to reload or refresh your web page to execute and debug different parts of your code. However, when you click **Reload** from the shortcut menu to reload your extension, the remote debugger loses the connection with the extension. The reason for this is that **Reload** option tears down and re-creates the browser control, which means you'll need to establish a new debugging session.
163162

164-
165-
Note that you do not need to close and reopen the Chromium browser every time you click **Reload**. You can start another debugging session by entering the URL (`http://localhost:8696`) in the Chromium address bar and selecting the extension from the page selector.
163+
Note that you don't need to close and reopen the Chromium browser every time you click **Reload**. You can start another debugging session by entering the URL (`http://localhost:8696`) in the Chromium address bar and selecting the extension from the page selector.
166164

167165
For more information, see [What Happens When You Reload an Extension](./trex_reload.md).
168166

website/docs/trex_release-notes.md

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

99
---
1010

11+
### Tableau Extensions API version 1.15.0
12+
13+
*September 2025*
14+
15+
* Tableau Dashboard Extensions API library: `tableau.extensions.1.15.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.3 or later. Download [Tableau Desktop](https://www.tableau.com/support/releases).
18+
19+
What's new in this release:
20+
21+
* Added `Cloud`, `PublicWeb`, and `PublicDesktop` as `Environment.context` values (`ExtensionContext`). The value indicates in which context the extension is currently running.
22+
23+
* Added `sendDialogMessageAsync` method and `DialogMessageReceived` event to the UI namespace.
24+
25+
* The `closeDialog` method can now be called from the extension frame to forcefully close the dialog.
26+
27+
* If you use Tableau Desktop for debugging your extension, there is a new command line argument you need to include when you launch Tableau in debug mode. You need to add `--webEngineArgs` in front of the remote debugging port option. For example, on Windows the command would look something like the following:
28+
29+
```cli
30+
"C:\Program Files\Tableau\Tableau <version>\bin\tableau.exe" --webEngineArgs --remote-debugging-port=8696
31+
```
32+
33+
For more information, see [Debug Extensions in Tableau Desktop](./debug/trex_debugging.md).
34+
35+
---
36+
37+
## Previous Releases
38+
39+
---
40+
1141
### Tableau Extensions API version 1.14.0
1242

1343
*June 2025*
@@ -26,10 +56,6 @@ What's new in this release:
2656

2757
---
2858

29-
## Previous Releases
30-
31-
---
32-
3359
### Tableau Extensions API version 1.13.0
3460

3561
*March 2025*

0 commit comments

Comments
 (0)