tgs  0.4.4+devb8c78d9
A framework to work with lottie / tgs files
Lottie

Objects of the lottie file structure. More...

Collaboration diagram for Lottie:

Classes

class  tgs.objects.animation.Animation
 Top level object, describing the animation. More...
 
class  tgs.objects.assets.Asset
 
class  tgs.objects.assets.Image
 External image. More...
 
class  tgs.objects.assets.CharacterData
 Character shapes. More...
 
class  tgs.objects.assets.Chars
 Defines character shapes to avoid loading system fonts. More...
 
class  tgs.objects.assets.Precomp
 
class  tgs.objects.bezier.Bezier
 Single bezier curve. More...
 
class  tgs.objects.easing.KeyframeBezierHandle
 Bezier handle for keyframe interpolation. More...
 
class  tgs.objects.effects.Effect
 Layer effect. More...
 
class  tgs.objects.effects.EffectValueAngle
 
class  tgs.objects.effects.EffectNoValue
 
class  tgs.objects.effects.EffectValueSlider
 
class  tgs.objects.effects.EffectValueCheckbox
 
class  tgs.objects.effects.EffectValuePoint
 
class  tgs.objects.effects.EffectValueDropDown
 
class  tgs.objects.effects.EffectValueLayer
 
class  tgs.objects.effects.EffectValueColor
 
class  tgs.objects.effects.FillEffect
 Replaces the whole layer with the given color. More...
 
class  tgs.objects.effects.StrokeEffect
 
class  tgs.objects.effects.TritoneEffect
 Maps layers colors based on bright/mid/dark colors. More...
 
class  tgs.objects.effects.ProLevelsEffect
 
class  tgs.objects.effects.TintEffect
 Colorizes the layer. More...
 
class  tgs.objects.effects.DropShadowEffect
 Adds a shadow to the layer. More...
 
class  tgs.objects.effects.Matte3Effect
 
class  tgs.objects.effects.GaussianBlurEffect
 Gaussian blur. More...
 
class  tgs.objects.effects.ChangeColorEffect
 Gaussian blur. More...
 
class  tgs.objects.enums.TestBased
 
class  tgs.objects.enums.TextShape
 
class  tgs.objects.enums.TextGrouping
 
class  tgs.objects.helpers.Transform
 Layer transform. More...
 
class  tgs.objects.helpers.MaskMode
 How masks interact with each other. More...
 
class  tgs.objects.helpers.Mask
 
class  tgs.objects.layers.BlendMode
 
class  tgs.objects.layers.MatteMode
 
class  tgs.objects.layers.Layer
 
class  tgs.objects.layers.NullLayer
 Layer with no data, useful to group layers together. More...
 
class  tgs.objects.layers.TextLayer
 
class  tgs.objects.layers.ShapeLayer
 Layer containing ShapeElement objects. More...
 
class  tgs.objects.layers.ImageLayer
 
class  tgs.objects.layers.PreCompLayer
 
class  tgs.objects.layers.SolidColorLayer
 Layer with a solid color rectangle. More...
 
class  tgs.objects.properties.Keyframe
 
class  tgs.objects.properties.OffsetKeyframe
 Keyframe for MultiDimensional values. More...
 
class  tgs.objects.properties.MultiDimensional
 An animatable property that holds a NVector. More...
 
class  tgs.objects.properties.GradientColors
 Represents colors and offsets in a gradient. More...
 
class  tgs.objects.properties.Value
 An animatable property that holds a float. More...
 
class  tgs.objects.properties.ShapePropKeyframe
 Keyframe holding Bezier objects. More...
 
class  tgs.objects.properties.ShapeProperty
 An animatable property that holds a Bezier. More...
 
class  tgs.objects.shapes.ShapeElement
 Base class for all elements of ShapeLayer and Group. More...
 
class  tgs.objects.shapes.Shape
 Drawable shape. More...
 
class  tgs.objects.shapes.Rect
 A simple rectangle shape. More...
 
class  tgs.objects.shapes.StarType
 
class  tgs.objects.shapes.Star
 Star shape. More...
 
class  tgs.objects.shapes.Ellipse
 Ellipse shape. More...
 
class  tgs.objects.shapes.Path
 Animatable Bezier curve. More...
 
class  tgs.objects.shapes.Group
 ShapeElement that can contain other shapes. More...
 
class  tgs.objects.shapes.Fill
 Solid fill color. More...
 
class  tgs.objects.shapes.GradientType
 
class  tgs.objects.shapes.Gradient
 
class  tgs.objects.shapes.GradientFill
 Gradient fill. More...
 
class  tgs.objects.shapes.LineJoin
 
class  tgs.objects.shapes.LineCap
 
class  tgs.objects.shapes.StrokeDashType
 
class  tgs.objects.shapes.StrokeDash
 
class  tgs.objects.shapes.BaseStroke
 
class  tgs.objects.shapes.Stroke
 Solid stroke. More...
 
class  tgs.objects.shapes.GradientStroke
 Gradient stroke. More...
 
class  tgs.objects.shapes.TransformShape
 Group transform. More...
 
class  tgs.objects.shapes.Trim
 
class  tgs.objects.shapes.Composite
 
class  tgs.objects.shapes.RepeaterTransform
 
class  tgs.objects.shapes.Modifier
 
class  tgs.objects.shapes.Repeater
 
class  tgs.objects.shapes.RoundedCorners
 
class  tgs.objects.shapes.Merge
 
class  tgs.objects.text.MaskedPath
 
class  tgs.objects.text.TextAnimatorDataProperty
 
class  tgs.objects.text.TextMoreOptions
 
class  tgs.objects.text.TextJustify
 
class  tgs.objects.text.TextDocument
 
class  tgs.objects.text.TextDataKeyframe
 
class  tgs.objects.text.TextData
 
class  tgs.objects.text.TextAnimatorData
 
class  tgs.objects.text.Font
 
class  tgs.objects.text.FontList
 

Detailed Description

Objects of the lottie file structure.

Lottie JSON Format

Index

Animation

Python class: Animation
Top level object, describing the animation
See also
http://docs.aenhancers.com/items/compitem/
Todo:
rename to Composition?
Lottie nameTypeDescriptionAttribute
tgs 0-1 int Marks as telegram sticker. tgs
v str Bodymovin Version. version
fr float Frames per second. frame_rate
ip float The time when the composition work area begins, in frames. in_point
op float The time when the composition work area ends. out_point
w int Composition Width. width
h int Composition Height. height
nm str Composition name. name
ddd 0-1 int Composition has 3-D layers. threedimensional
assets list of Asset source items that can be used in multiple places. assets
fonts FontList Available fonts. fonts
layers list of Layer List of Composition Layers. layers
chars list of Chars source chars for text layers chars

Asset

Python class: Asset
Base class for mapping Python classes into Lottie JSON objects
Subclasses:

CharacterData

Python class: CharacterData
Character shapes
Lottie nameTypeDescriptionAttribute
shapes list of ShapeElement shapes

Chars

Python class: Chars
Defines character shapes to avoid loading system fonts
Lottie nameTypeDescriptionAttribute
ch str Character Value. character
fFamily str Character Font Family. font_family
size float Character Font Size. font_size
style str Character Font Style. font_style
w float Character Width. width
data CharacterData Character Data. data

Image

Python class: Image
External image
See also
http://docs.aenhancers.com/sources/filesource/
Lottie nameTypeDescriptionAttribute
h float Image Height. height
w float Image Width. width
id str Image ID. id
p str Image name. image
u str Image path. image_path
e 0-1 int Image data is stored as a data: url. embedded

Precomp

Python class: Precomp
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
id str Precomp ID. id
layers list of Layer List of Precomp Layers. layers

Bezier

Python class: Bezier
Single bezier curve
Lottie nameTypeDescriptionAttribute
c bool Closed property of shape. closed
i list of list of float Cubic bezier handles for the segments before each vertex. in_tangents
o list of list of float Cubic bezier handles for the segments after each vertex. out_tangents
v list of list of float Bezier curve vertices. vertices

KeyframeBezierHandle

Python class: KeyframeBezierHandle
Bezier handle for keyframe interpolation
Lottie nameTypeDescriptionAttribute
x float or list of float x position of the handle. x
y float or list of float y position of the handle. y

ChangeColorEffect

Python class: ChangeColorEffect
Gaussian blur
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 29 Effect type. type
ef list of EffectValue Effect parameters. [view, hue, lightness, saturation, color_to_change, tolerance, softness, match, invert_mask] effects

DropShadowEffect

Python class: DropShadowEffect
Adds a shadow to the layer
Note
Opacity is in [0, 255]
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 25 Effect type. type
ef list of EffectValue Effect parameters. [color, opacity, angle, distance, blur] effects

Effect

Python class: Effect
Layer effect
Subclasses:
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int Effect type. type
ef list of EffectValue Effect parameters. [] effects

EffectNoValue

Python class: EffectNoValue
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int Effect value type. type

EffectValue

Python class: EffectValue
Value for an effect
Subclasses:
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int Effect value type. type

EffectValueAngle

Python class: EffectValueAngle
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 1 Effect type. type
v Value Effect value. value

EffectValueCheckbox

Python class: EffectValueCheckbox
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 4 Effect type. type
v Value Effect value. value

EffectValueColor

Python class: EffectValueColor
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 2 Effect type. type
v MultiDimensional Effect value. value

EffectValueDropDown

Python class: EffectValueDropDown
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 7 Effect type. type
v Value Effect value. value

EffectValueLayer

Python class: EffectValueLayer
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 10 Effect type. type
v Value Effect value. value

EffectValuePoint

Python class: EffectValuePoint
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 3 Effect type. type
v MultiDimensional Effect value. value

EffectValueSlider

Python class: EffectValueSlider
Value for an effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 0 Effect type. type
v Value Effect value. value

FillEffect

Python class: FillEffect
Replaces the whole layer with the given color
Note
Opacity is in [0, 1]
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 21 Effect type. type
ef list of EffectValue Effect parameters. [00, 01, color, 03, 04, 05, opacity] effects

GaussianBlurEffect

Python class: GaussianBlurEffect
Gaussian blur
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 29 Effect type. type
ef list of EffectValue Effect parameters. [sigma, dimensions, wrap] effects

Matte3Effect

Python class: Matte3Effect
Layer effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 28 Effect type. type
ef list of EffectValue Effect parameters. [index] effects

ProLevelsEffect

Python class: ProLevelsEffect
Layer effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 24 Effect type. type
ef list of EffectValue Effect parameters. [00, 01, 02, comp_inblack, comp_inwhite, comp_gamma, comp_outblack, comp_outwhite, 08, 09, r_inblack, r_inwhite, r_gamma, r_outblack, r_outwhite, 15, 16, g_inblack, g_inwhite, g_gamma, g_outblack, g_outwhite, 22, b3, b_inblack, b_inwhite, b_gamma, b_outblack, b_outwhite, 29, a_inblack, a_inwhite, a_gamma, a_outblack, a_outwhite] effects

StrokeEffect

Python class: StrokeEffect
Layer effect
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 22 Effect type. type
ef list of EffectValue Effect parameters. [00, 01, 02, color, 04, 05, 06, 07, 08, 09, type] effects

TintEffect

Python class: TintEffect
Colorizes the layer
Note
Opacity is in [0, 100]
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 20 Effect type. type
ef list of EffectValue Effect parameters. [color_black, color_white, opacity] effects

TritoneEffect

Python class: TritoneEffect
Maps layers colors based on bright/mid/dark colors
Lottie nameTypeDescriptionAttribute
ix int Effect Index. effect_index
nm str After Effect's Name. name
ty int = 23 Effect type. type
ef list of EffectValue Effect parameters. [bright, mid, dark] effects

TestBased

Python class: TestBased
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Characters Characters
2 CharacterExcludingSpaces CharacterExcludingSpaces
3 Words Words
4 Lines Lines

TextGrouping

Python class: TextGrouping
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Characters Characters
2 Word Word
3 Line Line
4 All All

TextShape

Python class: TextShape
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Square Square
2 RampUp RampUp
3 RampDown RampDown
4 Triangle Triangle
5 Round Round
6 Smooth Smooth

Mask

Python class: Mask
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
inv bool Inverted Mask flag. inverted
nm str Mask name. name
pt ShapeProperty Mask vertices. shape
o Value Mask opacity. opacity
mode MaskMode Mask mode. mode
x Value dilate

MaskMode

Python class: MaskMode
How masks interact with each other
See also
https://helpx.adobe.com/after-effects/using/alpha-channels-masks-mattes.html
Lottie ValueNameDescriptionAttribute
n No No
a Add Add
s Subtract Subtract
i Intersect Intersect
l Lightent Lightent
d Darken Darken
f Difference Difference

Transform

Python class: Transform
Layer transform
Subclasses:
Lottie nameTypeDescriptionAttribute
a MultiDimensional Transform Anchor Point. anchor_point
p MultiDimensional Transform Position. position
s MultiDimensional Transform Scale. scale
r Value Transform Rotation. rotation
o Value Transform Opacity. opacity
sk Value Transform Skew. skew
sa Value Transform Skew Axis. skew_axis

BlendMode

Python class: BlendMode
An enumeration.
Lottie ValueNameDescriptionAttribute
0 Normal Normal
1 Multiply Multiply
2 Screen Screen
3 Overlay Overlay
4 Darken Darken
5 Lighten Lighten
6 ColorDodge ColorDodge
7 ColorBurn ColorBurn
8 HardLight HardLight
9 SoftLight SoftLight
10 Difference Difference
11 Exclusion Exclusion
12 Hue Hue
13 Saturation Saturation
14 Color Color
15 Luminosity Luminosity

ImageLayer

Python class: ImageLayer
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
ddd 0-1 int 3d layer flag threedimensional
hd bool Hidden layer. hidden
ty int = 2 Layer type. type
nm str After Effects Layer Name. name
parent int Layer Parent. parent
sr float Layer Time Stretching. stretch
ks Transform Transform properties. transform
ao 0-1 int Auto-Orient along path AE property. auto_orient
ip float In Point of layer. in_point
op float Out Point of layer. out_point
st float Start Time of layer. start_time
bm BlendMode Blend Mode. blend_mode
tt MatteMode Matte mode, the layer will inherit the transparency from the layer above. matte_mode
ind int Layer index in AE. index
hasMask bool Whether the layer has some masks applied. has_masks
masksProperties list of Mask List of Masks. masks
ef list of Effect List of Effects. effects
refId str id pointing to the source image defined on 'assets' object image_id

Layer

Python class: Layer
Base class for mapping Python classes into Lottie JSON objects
Subclasses:
Lottie nameTypeDescriptionAttribute
ddd 0-1 int 3d layer flag threedimensional
hd bool Hidden layer. hidden
ty int Layer type. type
nm str After Effects Layer Name. name
parent int Layer Parent. parent
sr float Layer Time Stretching. stretch
ks Transform Transform properties. transform
ao 0-1 int Auto-Orient along path AE property. auto_orient
ip float In Point of layer. in_point
op float Out Point of layer. out_point
st float Start Time of layer. start_time
bm BlendMode Blend Mode. blend_mode
tt MatteMode Matte mode, the layer will inherit the transparency from the layer above. matte_mode
ind int Layer index in AE. index
hasMask bool Whether the layer has some masks applied. has_masks
masksProperties list of Mask List of Masks. masks
ef list of Effect List of Effects. effects

MatteMode

Python class: MatteMode
An enumeration.
Lottie ValueNameDescriptionAttribute
0 Normal Normal
1 Alpha Alpha
2 InvertedAlpha InvertedAlpha
3 Luma Luma
4 InvertedLuma InvertedLuma

NullLayer

Python class: NullLayer
Layer with no data, useful to group layers together
Lottie nameTypeDescriptionAttribute
ddd 0-1 int 3d layer flag threedimensional
hd bool Hidden layer. hidden
ty int = 3 Layer type. type
nm str After Effects Layer Name. name
parent int Layer Parent. parent
sr float Layer Time Stretching. stretch
ks Transform Transform properties. transform
ao 0-1 int Auto-Orient along path AE property. auto_orient
ip float In Point of layer. in_point
op float Out Point of layer. out_point
st float Start Time of layer. start_time
bm BlendMode Blend Mode. blend_mode
tt MatteMode Matte mode, the layer will inherit the transparency from the layer above. matte_mode
ind int Layer index in AE. index
hasMask bool Whether the layer has some masks applied. has_masks
masksProperties list of Mask List of Masks. masks
ef list of Effect List of Effects. effects

PreCompLayer

Python class: PreCompLayer
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
ddd 0-1 int 3d layer flag threedimensional
hd bool Hidden layer. hidden
ty int = 0 Layer type. type
nm str After Effects Layer Name. name
parent int Layer Parent. parent
sr float Layer Time Stretching. stretch
ks Transform Transform properties. transform
ao 0-1 int Auto-Orient along path AE property. auto_orient
ip float In Point of layer. in_point
op float Out Point of layer. out_point
st float Start Time of layer. start_time
bm BlendMode Blend Mode. blend_mode
tt MatteMode Matte mode, the layer will inherit the transparency from the layer above. matte_mode
ind int Layer index in AE. index
hasMask bool Whether the layer has some masks applied. has_masks
masksProperties list of Mask List of Masks. masks
ef list of Effect List of Effects. effects
refId str id pointing to the source composition defined on 'assets' object reference_id
tm Value Comp's Time remapping. time_remapping
w int Width. width
h int Height. height

ShapeLayer

Python class: ShapeLayer
Layer containing ShapeElement objects
Lottie nameTypeDescriptionAttribute
ddd 0-1 int 3d layer flag threedimensional
hd bool Hidden layer. hidden
ty int = 4 Layer type. type
nm str After Effects Layer Name. name
parent int Layer Parent. parent
sr float Layer Time Stretching. stretch
ks Transform Transform properties. transform
ao 0-1 int Auto-Orient along path AE property. auto_orient
ip float In Point of layer. in_point
op float Out Point of layer. out_point
st float Start Time of layer. start_time
bm BlendMode Blend Mode. blend_mode
tt MatteMode Matte mode, the layer will inherit the transparency from the layer above. matte_mode
ind int Layer index in AE. index
hasMask bool Whether the layer has some masks applied. has_masks
masksProperties list of Mask List of Masks. masks
ef list of Effect List of Effects. effects
shapes list of ShapeElement Shape list of items. shapes

SolidColorLayer

Python class: SolidColorLayer
Layer with a solid color rectangle
Lottie nameTypeDescriptionAttribute
ddd 0-1 int 3d layer flag threedimensional
hd bool Hidden layer. hidden
ty int = 1 Layer type. type
nm str After Effects Layer Name. name
parent int Layer Parent. parent
sr float Layer Time Stretching. stretch
ks Transform Transform properties. transform
ao 0-1 int Auto-Orient along path AE property. auto_orient
ip float In Point of layer. in_point
op float Out Point of layer. out_point
st float Start Time of layer. start_time
bm BlendMode Blend Mode. blend_mode
tt MatteMode Matte mode, the layer will inherit the transparency from the layer above. matte_mode
ind int Layer index in AE. index
hasMask bool Whether the layer has some masks applied. has_masks
masksProperties list of Mask List of Masks. masks
ef list of Effect List of Effects. effects
sc str Color of the layer as a #rrggbb hex. color
sh float Height of the layer. height
sw float Width of the layer. width

TextLayer

Python class: TextLayer
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
ddd 0-1 int 3d layer flag threedimensional
hd bool Hidden layer. hidden
ty int = 5 Layer type. type
nm str After Effects Layer Name. name
parent int Layer Parent. parent
sr float Layer Time Stretching. stretch
ks Transform Transform properties. transform
ao 0-1 int Auto-Orient along path AE property. auto_orient
ip float In Point of layer. in_point
op float Out Point of layer. out_point
st float Start Time of layer. start_time
bm BlendMode Blend Mode. blend_mode
tt MatteMode Matte mode, the layer will inherit the transparency from the layer above. matte_mode
ind int Layer index in AE. index
hasMask bool Whether the layer has some masks applied. has_masks
masksProperties list of Mask List of Masks. masks
ef list of Effect List of Effects. effects
t TextAnimatorData Text Data. data

GradientColors

Python class: GradientColors
Represents colors and offsets in a gradient
Lottie nameTypeDescriptionAttribute
k MultiDimensional Animatable colors, as a vector containing [offset, r, g, b] values as a flat array. colors
p int Number of colors. count

Keyframe

Python class: Keyframe
Base class for mapping Python classes into Lottie JSON objects
Subclasses:
Lottie nameTypeDescriptionAttribute
t float Start time of keyframe segment. time
i KeyframeBezierHandle Bezier curve easing in value. in_value
o KeyframeBezierHandle Bezier curve easing out value. out_value
h 0-1 int Jump to the end value. jump

MultiDimensional

Python class: MultiDimensional
An animatable property that holds a NVector
Lottie nameTypeDescriptionAttribute
k list of float Non-animated value. value
ix int Property index. property_index
a 0-1 int Whether it's animated. animated
k list of OffsetKeyframe Keyframe list. keyframes

OffsetKeyframe

Python class: OffsetKeyframe
Keyframe for MultiDimensional values
Bezier easing

Imagine a quadratic bezier, with starting point at (0, 0) and end point at (1, 1).

out_value and in_value are the other two handles for a quadratic bezier, expressed as absoulte values in this 0-1 space.

See also https://cubic-bezier.com/

Lottie nameTypeDescriptionAttribute
t float Start time of keyframe segment. time
i KeyframeBezierHandle Bezier curve easing in value. in_value
o KeyframeBezierHandle Bezier curve easing out value. out_value
h 0-1 int Jump to the end value. jump
s list of float Start value of keyframe segment. start
e list of float End value of keyframe segment. end
ti list of float In Spatial Tangent. in_tan
to list of float Out Spatial Tangent. out_tan

ShapePropKeyframe

Python class: ShapePropKeyframe
Keyframe holding Bezier objects
Lottie nameTypeDescriptionAttribute
t float Start time of keyframe segment. time
i KeyframeBezierHandle Bezier curve easing in value. in_value
o KeyframeBezierHandle Bezier curve easing out value. out_value
h 0-1 int Jump to the end value. jump
s Bezier or list of Bezier Start value of keyframe segment. start
e Bezier or list of Bezier End value of keyframe segment. end

ShapeProperty

Python class: ShapeProperty
An animatable property that holds a Bezier
Lottie nameTypeDescriptionAttribute
k Bezier Non-animated value. value
ix float Property index. property_index
a 0-1 int Whether it's animated. animated
k list of ShapePropKeyframe Keyframe list. keyframes

Value

Python class: Value
An animatable property that holds a float
Lottie nameTypeDescriptionAttribute
k float Non-animated value. value
ix int Property index. property_index
a 0-1 int Whether it's animated. animated
k list of OffsetKeyframe Keyframe list. keyframes

BaseStroke

Python class: BaseStroke
Base class for mapping Python classes into Lottie JSON objects
Subclasses:
Lottie nameTypeDescriptionAttribute
lc LineCap Stroke Line Cap. line_cap
lj LineJoin Stroke Line Join. line_join
ml float Stroke Miter Limit. miter_limit
o Value Stroke Opacity. opacity
w Value Stroke Width. width
d list of StrokeDash Dashes. dashes

Composite

Python class: Composite
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Above Above
2 Below Below

Ellipse

Python class: Ellipse
Ellipse shape
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'el' Shape type. type
ix int Property index. property_index
bm int bm
d float After Effect's Direction. direction
p MultiDimensional Ellipse's position. position
s MultiDimensional Ellipse's size. size

Fill

Python class: Fill
Solid fill color
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'fl' Shape type. type
ix int Property index. property_index
bm int bm
o Value Fill Opacity. opacity
c MultiDimensional Fill Color. color
r int r

Gradient

Python class: Gradient
Base class for mapping Python classes into Lottie JSON objects
Subclasses:
Lottie nameTypeDescriptionAttribute
s MultiDimensional Gradient Start Point. start_point
e MultiDimensional Gradient End Point. end_point
t GradientType Gradient Type. gradient_type
h Value Gradient Highlight Length. highlight_length
a Value Highlight Angle. highlight_angle
g GradientColors Gradient Colors. colors

GradientFill

Python class: GradientFill
Gradient fill
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'gf' Shape type. type
ix int Property index. property_index
bm int bm
s MultiDimensional Gradient Start Point. start_point
e MultiDimensional Gradient End Point. end_point
t GradientType Gradient Type. gradient_type
h Value Gradient Highlight Length. highlight_length
a Value Highlight Angle. highlight_angle
g GradientColors Gradient Colors. colors
o Value Fill Opacity. opacity
r int r

GradientStroke

Python class: GradientStroke
Gradient stroke
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'gs' Shape type. type
ix int Property index. property_index
bm int bm
lc LineCap Stroke Line Cap. line_cap
lj LineJoin Stroke Line Join. line_join
ml float Stroke Miter Limit. miter_limit
o Value Fill Opacity. opacity
w Value Stroke Width. width
d list of StrokeDash Dashes. dashes
s MultiDimensional Gradient Start Point. start_point
e MultiDimensional Gradient End Point. end_point
t GradientType Gradient Type. gradient_type
h Value Gradient Highlight Length. highlight_length
a Value Highlight Angle. highlight_angle
g GradientColors Gradient Colors. colors

GradientType

Python class: GradientType
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Linear Linear
2 Radial Radial

Group

Python class: Group
ShapeElement that can contain other shapes
Note
Shapes inside the same group will create "holes" in other shapes
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'gr' Shape type. type
ix int Property index. property_index
bm int bm
np float Group number of properties. number_of_properties
it list of ShapeElement Group list of items. shapes

LineCap

Python class: LineCap
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Butt Butt
2 Round Round
3 Square Square

LineJoin

Python class: LineJoin
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Miter Miter
2 Round Round
3 Bevel Bevel

Merge

Python class: Merge
Base class for all elements of ShapeLayer and Group
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'mm' Shape type. type
ix int Property index. property_index
bm int bm
mm float Merge Mode. merge_mode

Modifier

Python class: Modifier
Base class for all elements of ShapeLayer and Group
Subclasses:
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str Shape type. type
ix int Property index. property_index
bm int bm

Path

Python class: Path
Animatable Bezier curve
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'sh' Shape type. type
ix int Property index. property_index
bm int bm
d float After Effect's Direction. direction
ks ShapeProperty Shape's vertices. shape
ind int index

Rect

Python class: Rect
A simple rectangle shape
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'rc' Shape type. type
ix int Property index. property_index
bm int bm
d float After Effect's Direction. direction
p MultiDimensional Rect's position. position
s MultiDimensional Rect's size. size
r Value Rect's rounded corners. rounded

Repeater

Python class: Repeater
Duplicates previous shapes in a group
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'rp' Shape type. type
ix int Property index. property_index
bm int bm
c Value Number of Copies. copies
o Value Offset of Copies. offset
m Composite Composite of copies. composite
tr RepeaterTransform Transform values for each repeater copy. transform

RepeaterTransform

Python class: RepeaterTransform
Layer transform
Lottie nameTypeDescriptionAttribute
a MultiDimensional Transform Anchor Point. anchor_point
p MultiDimensional Transform Position. position
s MultiDimensional Transform Scale. scale
r Value Transform Rotation. rotation
o Value Transform Opacity. opacity
sk Value Transform Skew. skew
sa Value Transform Skew Axis. skew_axis
so Value start_opacity
eo Value end_opacity

RoundedCorners

Python class: RoundedCorners
Rounds corners of other shapes
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'rd' Shape type. type
ix int Property index. property_index
bm int bm
r Value Rounded Corner Radius. radius

Shape

Python class: Shape
Drawable shape
Subclasses:
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str Shape type. type
ix int Property index. property_index
bm int bm
d float After Effect's Direction. direction

ShapeElement

Python class: ShapeElement
Base class for all elements of ShapeLayer and Group
Subclasses:
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str Shape type. type
ix int Property index. property_index
bm int bm

Star

Python class: Star
Star shape
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'sr' Shape type. type
ix int Property index. property_index
bm int bm
d float After Effect's Direction. direction
p MultiDimensional Star's position. position
ir Value Star's inner radius. inner_radius
is Value Star's inner roundness. inner_roundness
or Value Star's outer radius. outer_radius
os Value Star's outer roundness. outer_roundness
r Value Star's rotation. rotation
pt Value Star's number of points. points
sy StarType Star's type. star_type

StarType

Python class: StarType
An enumeration.
Lottie ValueNameDescriptionAttribute
1 Star Star
2 Polygon Polygon

Stroke

Python class: Stroke
Solid stroke
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'st' Shape type. type
ix int Property index. property_index
bm int bm
lc LineCap Stroke Line Cap. line_cap
lj LineJoin Stroke Line Join. line_join
ml float Stroke Miter Limit. miter_limit
o Value Stroke Opacity. opacity
w Value Stroke Width. width
d list of StrokeDash Dashes. dashes
c MultiDimensional Stroke Color. color

StrokeDash

Python class: StrokeDash
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
nm str name
n StrokeDashType type
v Value length

StrokeDashType

Python class: StrokeDashType
An enumeration.
Lottie ValueNameDescriptionAttribute
d Dash Dash
g Gap Gap
o Offset Offset

TransformShape

Python class: TransformShape
Group transform
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'tr' Shape type. type
ix int Property index. property_index
bm int bm
a MultiDimensional anchor_point
p MultiDimensional Transform Position. position
s MultiDimensional Transform Scale. scale
r Value Transform Rotation. rotation
o Value Transform Opacity. opacity
sk Value Transform Skew. skew
sa Value Transform Skew Axis. skew_axis

Trim

Python class: Trim
Trims shapes into a segment
Lottie nameTypeDescriptionAttribute
hd bool Hide element. hidden
nm str After Effect's Name. name
ty str = 'tm' Shape type. type
ix int Property index. property_index
bm int bm
s Value Start of the segment, as a percentage. start
e Value End of the segment, as a percentage. end
o Value Angle where to start. angle
m int m

Font

Python class: Font
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
ascent float ascent
fFamily str font_family
fName str name
fStyle str font_style

FontList

Python class: FontList
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
list list of Font list

MaskedPath

Python class: MaskedPath
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
m float Type? mask
f Value First? f
l Value Last? l
r float ?? r

TextAnimatorData

Python class: TextAnimatorData
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
a list of TextAnimatorDataProperty properties
d TextData data
m TextMoreOptions more_options
p MaskedPath masked_path

TextAnimatorDataProperty

Python class: TextAnimatorDataProperty
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
r Value Rotation Angle: z? rotation
rx Value Angle? rx
ry Value Angle? ry
sk Value Skew Angle. skew
sa Value Skew Axis. skew_axis
s MultiDimensional Scale 0-100? scale
a MultiDimensional anchor
o Value Opacity 0-100? opacity
p MultiDimensional Position. position
sw Value Stroke width. stroke_width
sc MultiDimensional Stroke color. stroke_color
fc MultiDimensional Fill color. fill_color
fh Value fh
fs Value 0-100? fs
fb Value 0-100? fb
t Value Tracking. tracking

TextData

Python class: TextData
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
k list of TextDataKeyframe keyframes

TextDataKeyframe

Python class: TextDataKeyframe
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
s TextDocument Start value of keyframe segment. start
t float Start time of keyframe segment. time

TextDocument

Python class: TextDocument
See also
http://docs.aenhancers.com/other/textdocument/
Lottie nameTypeDescriptionAttribute
f str font_family
fc list of float Text color. color
s float Font Size. font_size
lh float Line height when wrapping. line_height
sz list of float Size of the box containing the text. wrap_size
t str Text. text
j TextJustify Text alignment. justify

TextJustify

Python class: TextJustify
An enumeration.
Lottie ValueNameDescriptionAttribute
0 Left Left
1 Right Right
2 Center Center

TextMoreOptions

Python class: TextMoreOptions
Base class for mapping Python classes into Lottie JSON objects
Lottie nameTypeDescriptionAttribute
a MultiDimensional alignment
g float g