Skip to content
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

Requirements for externalData #616

Closed
bryfox opened this issue Jul 25, 2018 · 1 comment
Closed

Requirements for externalData #616

bryfox opened this issue Jul 25, 2018 · 1 comment
Labels

Comments

@bryfox
Copy link
Contributor

bryfox commented Jul 25, 2018

In order for an externalData node to display something other than undefined, it must include one of the following properties: label, id, or type. The first two props seem like nice conventions; type refers to an entry in the variable registry, where a displayVariable can define the property to use as the label.

At a minimum, we should document that one of those three properties must exist in each node in a data source.

To be more flexible, we could allow this type to be injected from another place; e.g., defining type in the external data configuration instead of every object inside it. For example: "students": {"type": "person", "nodes": []}. This will matter more after #413.

@bryfox
Copy link
Contributor Author

bryfox commented Aug 16, 2018

I added a Node Labeling page which briefly documents how external data may be labeled, including the requirement for a type property.

I'll leave this issue open in case we want to support the second suggestion above.

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

No branches or pull requests

2 participants