-
Notifications
You must be signed in to change notification settings - Fork 8
possible gui model
Aidan Farrell edited this page Mar 26, 2021
·
6 revisions
{
"fields": [
{
"field-id": "a-field-id",
"label": "A helpful label",
"component": "name-of-component-to-use", // this says what web component to use to render/aquire value from
"type-returned": "project-name::Type", // matches a type in the Project Model
"documentation": "<p>Some HTML</p>", // the documentation on the field (a.k.a. where to put the "field manual" for lake mungo
"component-parameters": {} // configure appearance/actions/etc. of component
},
...
],
"metas": [
{
"metadata-name": "metadata-name-from-project-model", // What the metadata is called in the project model. E.g. "annotation" or "certainty"
"global-id": "a-metadata-id",
"label": "A label that appears any time you modify/view the certainty/annotation/other metadata",
"component": "name-of-component-to-use", // Same as above fields
"type-returned": "project-name::Type", // This should exactly match the type from the project model.
"documentation": "<p> More HTML </p>", //This isn't part of FAIMS2
"component-parameters": {} //Same as above
}
]
"views": [
{
"view-id": "a-view-id",
"fields": ["field-id1", "field-id2"], // ordering sets appearance order
"next-view": "another-view-id", // either this gets handled by a component, or we stick it here
"next-view-label": "Done!"
}
],
"start-view": "my-start-view-id"
}