layout

Type layout can be used to create an additional layout layer within the parent layout. If the data in dependent database table change, the layout will be reloaded.

Field Configurations

Key	Type	Description	Default Value
"data"	Object	Defines a static data object.	null
"query"	String	Defines the name of the query.	null
"queryParams"	Array	The params to append to the query.	null
"staticTemplate"	String	Defines the name of the static template. Should be used for cases when table and query is not provided or fails to retrieve any applicable data.	null
"table"	String	Defines the name of the database table.	null
"template"	String	Defines the name of the template.	null
"templateData"	Object	Defines data that is applied to the template.	null
"value"	String	Defines the name of the layout.	null

Inherited

From Base Layer

Base Layer

Field Configurations

Key	Type	Description	Default Value
"_value"	Value	[PREVIEW] Dynamic value of the layer.	null
"accessibilityAppendState"	String	Defines this layer appends its state to the accessibility text.	null
"accessibilityText"	String	Text for accessibility navigation. Can be translated.	null
"actions"	ActionList	List of actions, which will be executed when the layer is tapped.	null
"borderColor"	Color	The color of the border in hex color value.	null
"borderRadius"	UnitSize	The radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.	0
"borderWidth"	UnitSize	The width of the border.	0
"bottomLeftRadius"	UnitSize	Radius for the bottom left corner.	0
"bottomRightRadius"	UnitSize	Radius for the bottom right corner.	0
"classes"	Array	List of classes for layer styles.	null
"conditions"	Conditions	List of conditions to alter the layer state.	null
"constraints"	Constraints	A list of constraints defining the position of the layer in a layout.	null
"consumesKeyboard"	Boolean	This layer will be used to shrink, if a keyboard is shown.	null
"dataKey"	String	Name for assigning data to this layer.	null
"focusColor"	Color	The highlight color of this layer when it is focused. Mainly used on TV. If no color is provided, the pressedColor will be used.	null
"hidden"	Boolean	Indicates whether the layer is hidden. Default: false.	false
"isAccessibilityElement"	String	Defines if this layer is important for accessibility navigation. The default depends on the layer type.	null
"layerRotation"	Number	The layer is rotated by the specified degree.	0
"name"	String	Unique name in the layout. Used for alignment or actions.	null
"opacity"	Number	The opacity of the layer.	1
"overInsetBottom"	Boolean	Determines if this layer ignores the save space at the bottom of the device.	false
"overInsetTop"	Boolean	Determines if this layer ignores the save space at the top of the device.	false
"pressedColor"	Color	The highlight color of this layer when it is pressed. Mainly used on TV. If no color is provided, the focusColor will be used.	null
"safeArea"	SafeAreaTypeObject	Determines the safe area behaviour.	null
"shadowElevation"	Number	The elevation of this layer for casting shadows.	0
"state"	String	The state the layer will use as default.	"default"
"states"	LayerStates	A list of named states that affect the appearance of the layer.	null
"topLeftRadius"	UnitSize	Radius for the top left corner.	0
"topRightRadius"	UnitSize	Radius for the top right corner.	0
"touchFeedback"	TouchFeedback	Determines if the layer should show a touch feedback if touched.	"visible"
"trackingKey"	String	Defines a key for a scroll event.	null
"type"	LayerType	The type of the layer	null
"value"	Value	(Initial) value of the layer.	null

Examples

Example 1: Create a layout layer.

Goal: Create an additional layout within the parent layout that will take half of the screen.

To achieve this the following code can be used:

{
  "name": "include_menu",
  "type": "layout",
  "value": "layout_menu",
  "data": {
    "titleLayer": {
      "value": "Post of the day"
    }
  },
  "constraints": [
    {
      "type": "pos",
      "x": 0,
      "y": 0
    },
    {
      "type": "size",
      "width": "100%",
      "height": "50%"
    }
  ]
}

Referenced layout file layout_menu

{
  "name": "layout_menu",
  "layers": [
    {
      "type": "color",
      "value": "#34A7C9",
      "classes": [
        "fullSize"
      ]
    },
    {
      "name": "titleLayer",
      "dataKey": "titleLayer",
      "type": "text",
      "classes": [
        "titleLayer"
      ]
    }
  ]
}

The data field of the layout layer sets the value of the titleLayer text layer in the displayed layout.

Result:

A layout layer has been created.