gallery

Creates a gallery layer. Gallerys can retrieve children dynamically from a Database table or be configured statically using galleryItems.

note

Actions are explicitly forbidden on the gallery layer. Use the galleries children to execute actions.

Field Configurations

Key	Type	Description	Default Value
"galleryItems"	Array	The gallery items can either be defined by a JSON string literal or an array of objects.	null
"galleryPageOffset"	UnitSize	Offset of the elements.	0
"galleryPageWidth"	UnitSize	Width of each gallery item.	"100%"
"insets"	Object	Use the provided values to space the gallery content.	null
"layout"	String	The layout to be applied.	null
"layoutField"	String	Query result field to use as layout.	null
"path"	String	Specific path of gallery items.	null
"query"	String	Query in the related DB table.	null
"queryParams"	Array	The params to append to the query.	null
"scrollCircular"	Boolean	Determines, if the gallery can scroll infinite.	true
"scrollEvent"	String	Event fired when switching items (trackingKey is the tracking key of the elements or the index, if not available).	null
"table"	String	Name of the DB-Table.	null
"template"	String	The client template to be applied.	null
"templateField"	String	Query result field to use as template.	null
"timerInterval"	Number	Automatically scrolls gallery. Disable automatic scrolling by omitting this value.	0

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: Gallery layer with 3 gallery items

Show ExampleHide Example

A gallery layer uses different layouts for the gallery items. These layouts determine the content of each gallery item. In addition, a client template is required that provides the values for the different gallery items.

{
  "type": "gallery",
  "dataKey": "gallery01gallery01",
  "galleryItems": [
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.0"
    },
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.1"
    },
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.2"
    }
  ]
}

{
  "@comment": "gallery_default layout",
  "name": "gallery_default",
  "layers": [
    {
      "type": "color",
      "dataKey": "backgroundColor"
    },
    {
      "type": "text",
      "dataKey": "text",
      "maxLines": 1,
      "scaleType": "alignCenter",
      "fontColor": "#500080"
    }
  ]
}

{
  "@comment": "view_gallery client template",
  "name": "view_gallery",
  "content": {
    "content": {
      "data": [
        {
          "text": {
            "value": "01"
          },
          "backgroundColor": {
            "value": "#C0A3D1"
          }
        },
        {
          "text": {
            "value": "02"
          },
          "backgroundColor": {
            "value": "#DBCBE5"
          }
        },
        {
          "text": {
            "value": "03"
          },
          "backgroundColor": {
            "value": "#C0A3D1"
          }
        }
      ]
    }
  }
}

The gallery items can be statically defined in the galleryItems array or dynamically retrieved from a database table.

Example 2: Gallery layer with layer actions

Show ExampleHide Example

Actions are explicitly forbidden on the gallery layer. That is why two image layers are used, to which the client template assigns layer actions.

{
  "layers": [
    {
      "type": "gallery",
      "dataKey": "gallery02gallery01",
      "scrollCircular": false,
      "galleryItems": [
        {
          "layoutName": "gallery_default",
          "dataSourceType": "data",
          "dataSource": "data.0"
        },
        {
          "layoutName": "gallery_default",
          "dataSourceType": "data",
          "dataSource": "data.1"
        },
        {
          "layoutName": "gallery_default",
          "dataSourceType": "data",
          "dataSource": "data.2"
        }
      ]
    },
    {
      "type": "image",
      "dataKey": "gallery02LeftButton",
      "touchFeedback": "none",
      "value": "asset://icon_arrowBack.png"
    },
    {
      "type": "image",
      "dataKey": "gallery02RightButton",
      "touchFeedback": "none",
      "value": "asset://icon_arrowForward.png"
    }
  ]
}

{
  "@comment": "gallery_default layout",
  "name": "gallery_default",
  "layers": [
    {
      "type": "color",
      "dataKey": "backgroundColor"
    },
    {
      "type": "text",
      "dataKey": "text",
      "maxLines": 1,
      "scaleType": "alignCenter",
      "fontColor": "#500080"
    }
  ]
}

{
  "@comment": "view_gallery client template",
  "name": "view_gallery",
  "content": {
    "content": {
      "gallery02LeftButton": {
        "actions": [
          {
            "type": "layerAction",
            "params": {
              "layerName": "gallery02gallery01",
              "actions": [
                {
                  "type": "goLeft"
                }
              ]
            }
          }
        ]
      },
      "gallery02RightButton": {
        "actions": [
          {
            "type": "layerAction",
            "params": {
              "layerName": "gallery02gallery01",
              "actions": [
                {
                  "type": "goRight"
                }
              ]
            }
          }
        ]
      },
      "data": [
        {
          "text": {
            "value": "01"
          },
          "backgroundColor": {
            "value": "#C0A3D1"
          }
        },
        {
          "text": {
            "value": "02"
          },
          "backgroundColor": {
            "value": "#DBCBE5"
          }
        },
        {
          "text": {
            "value": "03"
          },
          "backgroundColor": {
            "value": "#C0A3D1"
          }
        }
      ]
    }
  }
}

Example 3: Gallery layer with insets

Show ExampleHide Example

Insets can be used to space the gallery content within the constraints of the gallery layer.

{
  "type": "gallery",
  "dataKey": "gallery03gallery01",
  "insets": {
    "left": "40pt",
    "right": "40pt"
  },
  "galleryItems": [
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.0"
    },
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.1"
    },
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.2"
    }
  ]
}

{
  "@comment": "gallery_default layout",
  "name": "gallery_default",
  "layers": [
    {
      "type": "color",
      "dataKey": "backgroundColor"
    },
    {
      "type": "text",
      "dataKey": "text",
      "maxLines": 1,
      "scaleType": "alignCenter",
      "fontColor": "#500080"
    }
  ]
}

{
  "@comment": "view_gallery client template",
  "name": "view_gallery",
  "content": {
    "content": {
      "data": [
        {
          "text": {
            "value": "01"
          },
          "backgroundColor": {
            "value": "#C0A3D1"
          }
        },
        {
          "text": {
            "value": "02"
          },
          "backgroundColor": {
            "value": "#DBCBE5"
          }
        },
        {
          "text": {
            "value": "03"
          },
          "backgroundColor": {
            "value": "#C0A3D1"
          }
        }
      ]
    }
  }
}

Example 4: Gallery layer with infinite scrolling

Show ExampleHide Example

If the scrollCircular field is set to true, the gallery layer scrolls infinitely. Setting a timerInterval enables automatic scrolling for the gallery layer.

{
  "type": "gallery",
  "dataKey": "gallery04gallery01",
  "scrollCircular": true,
  "insets": {
    "left": "40pt"
  },
  "galleryItems": [
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.0"
    },
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.1"
    }
  ]
}

{
  "type": "gallery",
  "dataKey": "gallery04gallery02",
  "scrollCircular": true,
  "timerInterval": "2",
  "insets": {
    "left": "40pt"
  },
  "galleryItems": [
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.0"
    },
    {
      "layoutName": "gallery_default",
      "dataSourceType": "data",
      "dataSource": "data.1"
    }
  ]
}

{
  "@comment": "gallery_default layout",
  "name": "gallery_default",
  "layers": [
    {
      "type": "color",
      "dataKey": "backgroundColor"
    },
    {
      "type": "text",
      "dataKey": "text",
      "maxLines": 1,
      "scaleType": "alignCenter",
      "fontColor": "#500080"
    }
  ]
}

{
  "@comment": "view_gallery client template",
  "name": "view_gallery",
  "content": {
    "content": {
      "data": [
        {
          "text": {
            "value": "01"
          },
          "backgroundColor": {
            "value": "#C0A3D1"
          }
        },
        {
          "text": {
            "value": "02"
          },
          "backgroundColor": {
            "value": "#DBCBE5"
          }
        }
      ]
    }
  }
}

The gallery's pagination is done using the pagination layer.