Update trex_overview.md #160
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a what you can do list
jz-huang
reviewed
Oct 11, 2018
| * You can use the Extensions API for integrating web applications into zones in Tableau dashboards. | ||
|
|
||
| The Extensions API and Embedded API share a similar programming model, but there are differences. The two APIs are not designed to be used together. In the Embedded API, the `Viz` or `VizManager` is the highest-level object. However, in the Extensions API there is no object model or concept for a `Viz` or `VizManager`. For the Extensions API, the workbook is the highest-level object a developer interacts with. | ||
| The Extensions API and Embedded API share a similar programming model, but there are differences. The two APIs are not designed to be used together. In the Embedded API, the `Viz` or `VizManager` is the highest-level object. However, in the Extensions API there is no object model or concept for a `Viz` or `VizManager`. For the Extensions API, the workbook is the highest-level object a developer interacts with. |
Contributor
There was a problem hiding this comment.
I realize this isn't part of your changes, but few things jumped out to me..
i don't think the workbook exists in the extensions api? There are some high level namespaces... ui, dashboard, environement, etc...
"The two APIs are not designed to be used together." this also seems a bit misleading, theoretically you should be able to embed a viz with a dashboard extension.
@Kovner thoughts?
Contributor
There was a problem hiding this comment.
The working deck PPT for "Explore a whole new world..." TC 18 presentation has a nice list of the differences.
JavaScript is on the left|Extensions is on the right:
| Brings Tableau into other web applications | Brings other web applications into Tableau |
|---|---|
| Requires embedding Tableau dashboard into a web page | Can be used in Desktop, Server, or embedded dashboard |
| Custom-built for each embed scenario | Can be made as a re-usable, generic-built dashboard component |
| Written in JavaScript | Written in JavaScript (similar calls) |
Contributor
Author
There was a problem hiding this comment.
@jz-huang @johnDance Thanks for the feedback on this section. I'll update it with your corrections. I like the table. Thanks for that, John. I'll use it here. You are right, Jackson. The comparison of the Viz object in JS API and the workbook in the extensions API is off base, and saying "not designed to be used together" is not accurate or very helpful.
d45
added a commit
that referenced
this pull request
Oct 22, 2018
* Update readme.md (#152) Fixed typo of the word 'extension' in third sentence. * Update trex_configure.md (#156) Fixed JavaScript typo found by @jakkyn * Update trex_getstarted.md (#157) Fixed error found by @jakkyn - In the Choose dialog box, the Choose button is now My Extensions. * Update trex_overview.md (#160) Added the "what you can do list" to the overview page * Doc update to add design guidelines, tableau UI links, and localhost info (#165) Adding the doc updates for TC18 (Design Guidelines, Tableau UI link). * Update trex_security.md adding a comma to help fix a weird sentence.
d45
added a commit
that referenced
this pull request
Dec 19, 2018
* Update readme.md (#152) Fixed typo of the word 'extension' in third sentence. * Update trex_configure.md (#156) Fixed JavaScript typo found by @jakkyn * Update trex_getstarted.md (#157) Fixed error found by @jakkyn - In the Choose dialog box, the Choose button is now My Extensions. * Update trex_overview.md (#160) Added the "what you can do list" to the overview page * Doc update to add design guidelines, tableau UI links, and localhost info (#165) Adding the doc updates for TC18 (Design Guidelines, Tableau UI link). * Update trex_security.md adding a comma to help fix a weird sentence. * Update datasource.html (#170) * Update datasource.html This patch is temporary and will be superseded when we update the reference pages. This patch updates DataSourceInterfaces.ts - adding a note to explain that refreshAsync() should not be used to automatically refresh the viz, and that doing so on Tableau Online might result in the removal of the extension. * Update datasource.html refined note with John's suggestion (blocked vs. removal) * Doc updates for 2018.3 (#178) * updated docs for debugging, error handling, getting started, creating first extension * Updated debugging gifs, minor doc updates * Image used for the Extensions API Reference pages * Fixed typos * Fixing broken link * Fixed broken link to error codes topic * fixed typo * More tech review updates and CX editorial fixes * Added Keshia's allow/deny flowchart; more CX edits * Update trex_publish.md Adding a note that hosting extensions on Tableau Server is not recommended. * Update trex_debugging.md * Update trex_publish.md Refining the message that the web server needs to be on a different computer than the one running Tableau Server. * Update trex_publish.md Removed "the" from "the Tableau Server or Tableau Online." * Update trex_publish.md Changed the wording about hosting extensions on Tableau Server back to what it was before the last commit (as not recommended).
seanmakesgames
added a commit
that referenced
this pull request
Feb 27, 2019
* Update readme.md (#152) Fixed typo of the word 'extension' in third sentence. * Update trex_configure.md (#156) Fixed JavaScript typo found by @jakkyn * Update trex_getstarted.md (#157) Fixed error found by @jakkyn - In the Choose dialog box, the Choose button is now My Extensions. * Update trex_overview.md (#160) Added the "what you can do list" to the overview page * Doc update to add design guidelines, tableau UI links, and localhost info (#165) Adding the doc updates for TC18 (Design Guidelines, Tableau UI link). * Update trex_security.md adding a comma to help fix a weird sentence. * Update datasource.html (#170) * Update datasource.html This patch is temporary and will be superseded when we update the reference pages. This patch updates DataSourceInterfaces.ts - adding a note to explain that refreshAsync() should not be used to automatically refresh the viz, and that doing so on Tableau Online might result in the removal of the extension. * Update datasource.html refined note with John's suggestion (blocked vs. removal) * Doc updates for 2018.3 (#178) * updated docs for debugging, error handling, getting started, creating first extension * Updated debugging gifs, minor doc updates * Image used for the Extensions API Reference pages * Fixed typos * Fixing broken link * Fixed broken link to error codes topic * fixed typo * More tech review updates and CX editorial fixes * Added Keshia's allow/deny flowchart; more CX edits * Update trex_publish.md Adding a note that hosting extensions on Tableau Server is not recommended. * Update trex_debugging.md * Update trex_publish.md Refining the message that the web server needs to be on a different computer than the one running Tableau Server. * Update trex_publish.md Removed "the" from "the Tableau Server or Tableau Online." * Update trex_publish.md Changed the wording about hosting extensions on Tableau Server back to what it was before the last commit (as not recommended). * Doc updates for 2019.1 and v1.2 library; show-hide, chromium, API syn… (#195) * Doc updates for 2019.1 and v1.2 library; show-hide, chromium, API sync fix, best practices * removed best practices, changed to 1.1, modified visbility-error workaround * correcting version number to 1.1 * fixing library 1.1 references; drop-down menu fix * Update ux_controls_ui_patterns.md (#199) Adding a heading to a column in a table. The Markdown looked fine, but Jekyll didn't recognize it as a table without a heading to the column. * Fixing missing .gif file Added the .gif file with the correct name. The previous file name had a `(`` instead of an `_`. * Delete 3-Small)on_Dark_Background.gif Had a typo in the file name. Added the file with the correct name. * Release 1.1.0
nikhillakshman
added a commit
that referenced
this pull request
Apr 19, 2019
* Update readme.md (#152) Fixed typo of the word 'extension' in third sentence. * Update trex_configure.md (#156) Fixed JavaScript typo found by @jakkyn * Update trex_getstarted.md (#157) Fixed error found by @jakkyn - In the Choose dialog box, the Choose button is now My Extensions. * Update trex_overview.md (#160) Added the "what you can do list" to the overview page * Doc update to add design guidelines, tableau UI links, and localhost info (#165) Adding the doc updates for TC18 (Design Guidelines, Tableau UI link). * Update trex_security.md adding a comma to help fix a weird sentence. * Update datasource.html (#170) * Update datasource.html This patch is temporary and will be superseded when we update the reference pages. This patch updates DataSourceInterfaces.ts - adding a note to explain that refreshAsync() should not be used to automatically refresh the viz, and that doing so on Tableau Online might result in the removal of the extension. * Update datasource.html refined note with John's suggestion (blocked vs. removal) * Doc updates for 2018.3 (#178) * updated docs for debugging, error handling, getting started, creating first extension * Updated debugging gifs, minor doc updates * Image used for the Extensions API Reference pages * Fixed typos * Fixing broken link * Fixed broken link to error codes topic * fixed typo * More tech review updates and CX editorial fixes * Added Keshia's allow/deny flowchart; more CX edits * Update trex_publish.md Adding a note that hosting extensions on Tableau Server is not recommended. * Update trex_debugging.md * Update trex_publish.md Refining the message that the web server needs to be on a different computer than the one running Tableau Server. * Update trex_publish.md Removed "the" from "the Tableau Server or Tableau Online." * Update trex_publish.md Changed the wording about hosting extensions on Tableau Server back to what it was before the last commit (as not recommended). * Doc updates for 2019.1 and v1.2 library; show-hide, chromium, API syn… (#195) * Doc updates for 2019.1 and v1.2 library; show-hide, chromium, API sync fix, best practices * removed best practices, changed to 1.1, modified visbility-error workaround * correcting version number to 1.1 * fixing library 1.1 references; drop-down menu fix * Update ux_controls_ui_patterns.md (#199) Adding a heading to a column in a table. The Markdown looked fine, but Jekyll didn't recognize it as a table without a heading to the column. * Fixing missing .gif file Added the .gif file with the correct name. The previous file name had a `(`` instead of an `_`. * Delete 3-Small)on_Dark_Background.gif Had a typo in the file name. Added the file with the correct name. * Release 1.1.0 * [Security] Fix DOM XSS vulnerability in search * Update trex_examples.md (#203) fixed broken link (typo in path) to getting started topic * Release 1.2 * updating release notes for the version 1.2 library (#214) * Updating documentation for version 1.2 of the library * Renaming library files to new naming format * updated the library file name with new convention; removed page visibilit (#222) * Nlakshman/library reference (#221) * The format of the extension library name has changed from tableau-extensions-n.n.n.js to tableau.extensions.n.n.n.js . Updating the references in your samples, tutorials and docs. * Reverting the format of older versions * updated the library file name with new convention; removed page visibilit (#222) * The format of the extension library name has changed from tableau-extensions-n.n.n.js to tableau.extensions.n.n.n.js . Updating the references in your samples, tutorials and docs. * Reverting the format of older versions * Update trex_security.md (#224) changing the lib version to reference the `1.latest`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@Kovner, @jz-huang Here's the quick addition to add the "What you can do with extensions". Could one of you approve and merge into Dev branch?
I'm not sure if we can merge the same patch into the master branch, or if someone will need to cherry pick this patch.