-
Notifications
You must be signed in to change notification settings - Fork 260
Adding Tableau Viz to dashboard extensions #399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
johnDance
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is a meta comment: This is really the first time that an API is documented outside of the normal documentation. Should the trex_tableau_viz_ref.md be merged into the normal documentation for createVizImageAsync?
I think we should think about that. If we decide that this should be documented externally, then the main documentation should at least reference this.
|
@alicemhsiao @johnDance - in the Tableau Viz reference page ( Do we want to change the JSON example so that the example doesn't quote the keys ("mark", "description", "encoding", etc.)? I'm not sure if we will confuse developers about whether they need to create a JSON formatted object, or a JavaScript one? The both work (createVizImageAsync() doesn't care) since we convert JS script to JSON anyway. What do you think? Thanks. |
|
It is an object, so it should behave and be described as an object. I like your idea of dropping JSON. And yes, our example should remove the quotes from the keys. Good ideas all around. Thanks! |
|
Thanks, John. Revised the reference page to refer to a JavaScript object, rather than a JSON one. |
@filippostableau @johnDance @seanmakesgames @Kovner @alicemhsiao
Added two new topics:
trex_tableau_viz.md- How to add Tableau Viz to a dashboard extension; Tableau Viz error messagestrex_tableau_viz_ref.md- Reference information about what goes into theinputSpecparameter for thecreateVizImageAsyncmethod; options for encoding, etc.Updates:
.trexfile (trex_create.md)_config.yml-gemsdeprecated and replaced byplugins