LottieConfig class

Constructors

LottieConfig({void onLoaded(LottieComposition)?, Animation<double>? controller, FrameRate? frameRate, bool? animate, bool? repeat = false, bool? reverse, LottieDelegates? delegates, LottieOptions? options, double? width, double? height, BoxFit? fit, AlignmentGeometry? alignment, bool? addRepaintBoundary, FilterQuality? filterQuality, WarningCallback? onWarning, ImageErrorWidgetBuilder? errorBuilder, RenderCache? renderCache, bool overrideBoxFit = true, double aspectRatio = 9 / 16, VisibilityEnum visibilityEnum = VisibilityEnum.useFullScreen})
const

Properties

addRepaintBoundary → bool?
Indicate to automatically add a RepaintBoundary widget around the animation. This allows to optimize the app performance by isolating the animation in its own Layer.
final
alignment → AlignmentGeometry?
How to align the animation within its bounds.
final
animate → bool?
If no controller is specified, this value indicate whether or not the Lottie animation should be played automatically (default to true). If there is an animation controller specified, this property has no effect.
final
aspectRatio → double
Specifies the aspect ratio of the lottie
final
controller → Animation<double>?
The animation controller of the Lottie animation. The animated value will be mapped to the progress property of the Lottie animation.
final
delegates → LottieDelegates?
A group of options to further customize the lottie animation.
final
errorBuilder → ImageErrorWidgetBuilder?
A builder function that is called if an error occurs during loading.
final
filterQuality → FilterQuality?
The quality of the image layer. See FilterQuality FilterQuality.high is highest quality but slowest.
final
fit → BoxFit?
How to inscribe the animation into the space allocated during layout.
final
frameRate → FrameRate?
The number of frames per second to render. Use FrameRate.composition to use the original frame rate of the Lottie composition (default) Use FrameRate.max to advance the animation progression at every frame.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
If non-null, require the lottie animation to have this height.
final
onLoaded → void Function(LottieComposition)?
A callback called when the LottieComposition has been loaded. You can use this callback to set the correct duration on the AnimationController with composition.duration
final
onWarning → WarningCallback?
A callback called when there is a warning during the loading or painting of the animation.
final
options → LottieOptions?
Some options to enable/disable some feature of Lottie
final
overrideBoxFit → bool
Sets BoxFit to fill which removes padding around the lottie file. Defaults to true.
final
renderCache → RenderCache?
Opt-in to a special render mode where the frames of the animation are lazily rendered and kept in a cache. Subsequent runs of the animation will be cheaper to render.
final
repeat → bool?
Specify that the automatic animation should repeat in a loop (default to true). The property has no effect if animate is false or controller is not null.
final
reverse → bool?
Specify that the automatic animation should repeat in a loop in a "reverse" mode (go from start to end and then continuously from end to start). It default to false. The property has no effect if animate is false, repeat is false or controller is not null.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
visibilityEnum → VisibilityEnum
Specifies how video will be visible (defaults to VisibilityEnum.useFullScreen)
final
width → double?
If non-null, require the lottie animation to have this width.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited