lottieImage

The lottieImage type can be used to create an animated layer. The provided value serves as the source of the animation.

Field Configurations

Key	Type	Description	Default Value
"autoplay"	Boolean,String	Determines if the animation starts directly after it is loaded.	true
"repeating"	Boolean,String	Determines if the animation repeats indefinitely.	true
"scaleType"	ScaleType	The scale type to apply to the animation.	"scaleAspectFit"
"speed"	Number,String	The speed the animation is played at.	1
"value"	Value	The URL to the animation. For asset animations use asset://.	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 lottieImage layer using an asset

Goal: Create a lottieImage layer that displays an animation provided as an asset.

To achieve this the following code can be used:

{
  "type": "lottieImage",
  "value": "asset://sample.json",
  "classes": [
    "fullSize"
  ]
}

Example 2: Create an lottieImage layer using an hosted animation file without autoplay

Goal: Create an lottieImage layer that displays an animation hosted on a web server. It should not start directly.

The animation must be started with a layer action. It waits untill the animation is finished. To achieve this the following code can be used:

{
  "name": "theAnimation",
  "type": "lottieImage",
  "value": "https://samples.mobilitysuite.de/animation.json",
  "classes": [
    "fullSize"
  ],
  "repeating": false,
  "autoplay": false,
  "actions": [
    {
      "type": "layerAction",
      "params": {
        "layerName": "theAnimation",
        "actions": [
          {
            "type": "play",
            "params": {
              "async": false
            }
          }
        ]
      }
    },
    {
      "type": "showMessage",
      "params": {
        "text": "animation complete"
      }
    }
  ]
}

List of available layer actions

• play (with option async which defaults to true)
• pause
• stop