Skip to main content
Version: 4.60

lottieImage

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

Field Configurations

KeyTypeDescriptionDefault Value
"autoplay"Boolean,StringDetermines if the animation starts directly after it is loaded.true
"repeating"Boolean,StringDetermines if the animation repeats indefinitely.true
"scaleType"ScaleTypeThe scale type to apply to the animation."scaleAspectFit"
"speed"Number,StringThe speed the animation is played at.1
"value"ValueThe URL to the animation. For asset animations use asset://.null

Inherited

From Base Layer

Base Layer

Field Configurations

KeyTypeDescriptionDefault Value
"_value"Value[PREVIEW] Dynamic value of the layer.null
"accessibilityAppendState"StringDefines this layer appends its state to the accessibility text.null
"accessibilityText"StringText for accessibility navigation. Can be translated.null
"actions"ActionListList of actions, which will be executed when the layer is tapped.null
"borderColor"ColorThe color of the border in hex color value.null
"borderRadius"UnitSizeThe radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.0
"borderWidth"UnitSizeThe width of the border.0
"bottomLeftRadius"UnitSizeRadius for the bottom left corner.0
"bottomRightRadius"UnitSizeRadius for the bottom right corner.0
"classes"ArrayList of classes for layer styles.null
"conditions"ConditionsList of conditions to alter the layer state.null
"constraints"ConstraintsA list of constraints defining the position of the layer in a layout.null
"consumesKeyboard"BooleanThis layer will be used to shrink, if a keyboard is shown.null
"dataKey"StringName for assigning data to this layer.null
"focusColor"ColorThe 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"BooleanIndicates whether the layer is hidden. Default: false.false
"isAccessibilityElement"StringDefines if this layer is important for accessibility navigation. The default depends on the layer type.null
"layerRotation"NumberThe layer is rotated by the specified degree.0
"name"StringUnique name in the layout. Used for alignment or actions.null
"opacity"NumberThe opacity of the layer.1
"overInsetBottom"BooleanDetermines if this layer ignores the save space at the bottom of the device.false
"overInsetTop"BooleanDetermines if this layer ignores the save space at the top of the device.false
"pressedColor"ColorThe 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"SafeAreaTypeObjectDetermines the safe area behaviour.null
"shadowElevation"NumberThe elevation of this layer for casting shadows.0
"state"StringThe state the layer will use as default."default"
"states"LayerStatesA list of named states that affect the appearance of the layer.null
"topLeftRadius"UnitSizeRadius for the top left corner.0
"topRightRadius"UnitSizeRadius for the top right corner.0
"touchFeedback"TouchFeedbackDetermines if the layer should show a touch feedback if touched."visible"
"trackingKey"StringDefines a key for a scroll event.null
"type"LayerTypeThe type of the layernull
"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