Schema for the UI Schema
Version of the UI Schema. Changes in a major version are backwards compatible. So a parser for version z.x must be compatible with all versions z.y where y is <=x.
Must match regular expression:^\d+\.\d+$
"2.1"
The different layouts
No Additional Properties{
"type": "VerticalLayout",
"elements": []
}
{
"type": "Group",
"elements": [],
"options": {
"label": "This is a group"
}
}
The elements of the layout
No Additional ItemsDifferent types of layout elements
Contains a form element, e. g. a text input
No Additional Properties{
"type": "Control",
"scope": "/properties/objectInJsonSchema"
}
{
"type": "Control",
"scope": "/properties/field",
"showOn": {
"scope": "/properties/referenceField",
"type": "EQUALS",
"referenceValue": "awesomeValue"
},
"options": {
"label": false,
"radiobuttons": true,
"stacked": true
}
}
"Control"
A json pointer referring to the form element in the forms json schema
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Some HTML to be rendered in the form
No Additional Properties"HTML"
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as showOninserts a simple divider
No Additional Properties"Divider"
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as showOnDisplay Information in a Modal
No Additional Properties"Modal"
The modal
No Additional PropertiesThe modal title
The modal content (html is supported)
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as showOnUsed to put a button into the form
No Additional Properties"Button"
The buttons text
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as showOnOptions for the button
No Additional PropertiesThe layout's CSS classes
Whether the button is disabled
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Specifies that the form-data should not be validated on submission
Options that are passed to the submit function. This will not change the behaviour of VueJsonForm itself, but can bes used by the application/the webcomponent to change the behaviour of the submit function.
Action to perform when the button is clicked
"request"
"save"
"print"
Settings for request actions
No Additional Properties😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
An array of URLs to send the request to
Must contain a minimum of 1 items
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonThe HTTP method to use for the request
Headers to include in the request
Each additional property must conform to the following schema
Type: stringURL to redirect to after successful request
Additional Properties of any type are allowed.
Type: objectUsed to group buttons
No Additional Properties"Buttongroup"
Display the buttons vertical
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as showOnShow field depending on value of other field
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
{
"id": "rule1",
"rule": {
"type": "and",
"arguments": [
{
"type": "atom",
"path": "member"
},
{
"type": "not",
"arguments": [
{
"type": "atom",
"path": "employee"
}
]
}
]
}
}
A comment about what the rule does
Requires at least two arguments
No Additional PropertiesMust contain a minimum of 2 items
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Requires exactly on parameter
No Additional PropertiesMust contain a minimum of 1 items
Must contain a maximum of 1 items
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonDescribes an atom. Those can be used to read Data
No Additional PropertiesThe path to the atom in the data
Must be set to true if the atom should be parsed as a date
Describes an plugin
No Additional Properties{
"type": "plugin",
"name": "http",
"options": {
"url": "https://example.com/api"
},
"formula": {
"type": "atom",
"path": "keyInResponse"
}
}
The plugins name
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonThe plugins options
Compare strings, dates or numbers with each other
No Additional Properties{
"comment": "This evaluates to \"5>2\"",
"type": "comparison",
"operation": "greater",
"arguments": [
5,
2
]
}
{
"comment": "Check two Strings for equality",
"type": "comparison",
"operation": "equal",
"arguments": [
"test",
"test1"
]
}
Selects how the arguments should be compared
Indicates if dates are compared
Indicates if different types are allowed inside a comparison. This follows the JavaScript rules for comparison (´===´ is used for ´equals´).
Must contain a minimum of 2 items
Must contain a maximum of 2 items
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Describes macros. Available macros are now and length
{
"type": "macro",
"macro": {
"type": "now"
}
}
{
"type": "macro",
"macro": {
"type": "length",
"array": {
"type": "atom",
"path": "customers"
}
}
}
Returns the current time
No Additional PropertiesReturns the length of an array
No Additional Properties😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonCalculates a result
No Additional PropertiesThe mathematical operation to be calculated. Modulo refers to the function mod(a,b)=a-(floor(a/b)*b)
Must contain a minimum of 2 items
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.json😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Calculations involving dates
No Additional PropertiesAdd/subtract a time interval to/from a date or subtract two dates to get the interval between them. If the first date is earlier than the second one, the result will be negative.
Must contain a minimum of 2 items
Must contain a maximum of 2 items
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.json😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.json😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.json😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonWhat unit time intervals given as arguments will be in.
What unit time intervals representing the result will be in.
Quantifiers that can be used to evaluate rules on arrays in Data
No Additional Properties{
"type": "forall",
"array": {
"type": "atom",
"path": "arrayOfIntValues"
},
"placeholder": "forallItem",
"rule": {
"type": "comparison",
"operation": "greater",
"arguments": [
5,
{
"type": "atom",
"path": "forallItem"
}
]
}
}
This can either be an Atom that references an array in the data, or an array of rules
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.json😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonThis is a placeholder name for the current array object. This is the property name with wich you can reference the current value in the subsequent rule
Must be at least 1 characters long
This is a placeholder name for the current index of the array object. This is the property name with wich you can reference the current index in the subsequent rule
Must be at least 1 characters long
😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonAdditional options
No Additional PropertiesThe layout's CSS classes
"bg-primary"
"bg-info headerpart"
Adds a label for groups (only for type=Group)
Adds a description for a group (only for type=Group)
A wizard
No Additional Properties😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️
Same definition as layout.schema.jsonAdditional options
No Additional PropertiesAdditional Properties of any type are allowed.
Type: object