Skip to content

docs(api): add specTraversed to API documentation#83

Open
thomcsmits wants to merge 3 commits intomainfrom
thomcsmits/add-api-alt
Open

docs(api): add specTraversed to API documentation#83
thomcsmits wants to merge 3 commits intomainfrom
thomcsmits/add-api-alt

Conversation

@thomcsmits
Copy link
Copy Markdown
Collaborator

Add documentation for api added with gosling-lang/gosling.js#978

Comment thread docs/js-api.md Outdated
}
```
- For `"rawData"`, the `eventData` stores columnar data that has been used internally in Gosling to display the view:
- For `"rawData"` and `"specTraversed"`, the `eventData` stores columnar data that has been used internally in Gosling to display the view:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a separate sentence or a paragraph to describe the new API will be helpful for users. To clarify, rawData gives users the data that is shown in the visualization and not the user specification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants