You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-8Lines changed: 24 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,26 @@
3
3
4
4
5
5
6
+
6
7
## Why the Tableau Extensions API?
7
-
The Extensions API lets you do more without leaving Tableau. Build Tableau extensions that can interact and communicate with Tableau, and embed them directly in your workbooks.
8
+
9
+
The Extensions API lets you do more without leaving Tableau. Build Tableau dashboard and viz extensions that can interact and communicate with Tableau, and embed them directly in your workbooks.
10
+
11
+
* Build viz extensions to create new viz types that Tableau users can access through the worksheet Marks card.
* You must have Node.js and npm installed. You can get these from [https://nodejs.org](https://nodejs.org).
13
27
14
28
### Install Extensions API SDK Components and Start Server
@@ -27,21 +41,22 @@ The Extensions API lets you do more without leaving Tableau. Build Tableau exten
27
41
28
42
**npm start**
29
43
30
-
5. Launch Tableau and try the sample extensions in a dashboard. The samples are located in the `Samples` folder.
44
+
5. Launch Tableau and try a dashboard sample extension in a dashboard, or a viz extension in a worksheet. The dashboard and viz extension samples are located in the `Samples` folder.
31
45
32
-
>**Note** The local web server you start just serves to host the extension samples and extensions used in the tutorial, which have URLs similar to the following: `http://localhost:8765/Samples/DataSources/datasources.html` or `http://localhost:8765/Samples-Typescript/DataSources/datasources.html`
33
-
> This local web server is not intended to serve the Extensions API Help pages.
46
+
>**Note** The local web server you start just serves to host the extension samples and tutorial. These extensions have URLs similar to the following: `http://localhost:8765/Samples/Dashboard/DataSources/datasources.html`.
47
+
> This local web server is not intended to serve the Extensions API Help pages.
34
48
> View the Help on GitHub at [https://tableau.github.io/extensions-api](https://tableau.github.io/extensions-api).
35
49
36
50
### Typescript Development
51
+
37
52
Samples written in Typescript are located in the `Samples-Typescript` folder.
38
53
If you want to use TypeScript to write your extensions, you can run a script that starts up the HTTP server and actively listens for changes to the `.ts` files located in the `Samples-Typescript` folder. You can then add your extension to the folder and use the script to transpile your extension to JavaScript.
39
54
40
55
* To start the the HTTP server and listen for changes to the `.ts` files.
41
56
42
57
**npm run dev**
43
58
44
-
For more information, see [Use TypeScript with the Extensions API](https://tableau.github.io/extensions-api/docs/trex_typescript.html).
59
+
For more information, see [Use TypeScript with the Extensions API](https://tableau.github.io/extensions-api/docs/core/trex_typescript).
45
60
46
61
### Sandboxed Extension Development Environment
47
62
@@ -51,18 +66,19 @@ Tableau is introducing development support for Sandboxed Extensions with Tableau
51
66
52
67
**npm run start-sandbox**
53
68
54
-
2. Launch Tableau (Tableau 2019.3 and later) and try the sample Sandboxed Extension in a dashboard. You can find the `.trex` file and sample code in the `Samples\UINamespace-sandboxed` folder.
69
+
2. Launch Tableau (Tableau 2019.3 and later) and try the sample Sandboxed dashboard extension in a dashboard. You can find the `.trex` file and sample code in the `Samples\Dashboard\UINamespace-sandboxed` folder.
55
70
56
-
For more information, see [Create and Test Sandboxed Extensions](https://tableau.github.io/extensions-api/docs/trex_sandbox_test.html).
71
+
For more information, see [Create and Test Sandboxed Extensions](https://tableau.github.io/extensions-api/docs/security/trex_sandbox_test).
57
72
58
73
## Contributions
74
+
59
75
Contributions and improvements by the community are welcomed!
60
76
See the LICENSE file for current open-source licensing and use information.
61
77
62
78
Before we can accept pull requests from contributors, we require a signed [Contributor License Agreement (CLA)](https://tableau.github.io/contributing.html). To submit a contribution, please fork the repository then submit a pull request to the `main` branch.
63
79
64
80
## Code Style
65
-
Our sample code follows the [Semi-Standard Style](https://github.com/Flet/semistandard) for JavaScript samples linting and [tslint](https://palantir.github.io/tslint/) for TypeScript. If you add your own extension code to the Samples or Samples-Typescript directories, you can run `npm run lint` to validate the style of your code. Please run this command before submitting any pull requests for Sample code.
81
+
Our sample code follows the [Semi-Standard Style](https://github.com/Flet/semistandard) for JavaScript samples linting and [tslint](https://palantir.github.io/tslint/) for TypeScript. If you add your own extension code to the Samples or Samples-Typescript directories, you can run `npm run lint` to validate the style of your code. Please run this command before submitting any pull requests for Sample code.
66
82
67
83
`npx semistandard --fix` to fix linting issues which can be fixed automatically.
0 commit comments