Base class for layer holders. More...
Public Member Functions | |
| def | __init__ (self) |
| def | layer (self, index) |
| def | add_layer (self, Layer layer) |
| Appends a layer to the composition. More... | |
| def | load (cls, lottiedict) |
| Loads from a JSON object. More... | |
| def | insert_layer (self, index, Layer layer) |
| Inserts a layer to the composition. More... | |
| def | prepare_layer (self, Layer layer) |
| def | clone (self) |
| Returns a copy of the object. More... | |
| def | remove_layer (self, Layer layer) |
| Removes a layer (and all of its children) from this composition. More... | |
 Public Member Functions inherited from lottie.objects.base.LottieObject | |
| def | to_dict (self) |
| Serializes into a JSON object fit for the Lottie format. More... | |
| def | find (self, search, propname="name") |
| Recursively searches for child objects with a matching property. More... | |
| def | find_all (self, type, predicate=None, include_self=True) |
| Find all child objects that match a predicate. More... | |
| def | clone_into (self, other) |
| def | __str__ (self) |
| Public Member Functions inherited from lottie.objects.base.LottieObjectMeta | |
| def | __new__ (cls, name, bases, attr) |
Public Attributes | |
| layers | |
| List of Composition Layers. More... | |
Detailed Description
Base class for layer holders.
- Lottie JSON
Lottie name Type Description Attribute layers list of Layer List of Composition Layers. layers
Definition at line 6 of file composition.py.
Constructor & Destructor Documentation
◆ __init__()
| def lottie.objects.composition.Composition.__init__ | ( | self | ) |
Reimplemented from lottie.objects.base.LottieObject.
Definition at line 14 of file composition.py.
Member Function Documentation
◆ add_layer()
| def lottie.objects.composition.Composition.add_layer | ( | self, | |
| Layer | layer | ||
| ) |
Appends a layer to the composition.
- See also
- insert_layer
Definition at line 27 of file composition.py.
◆ clone()
| def lottie.objects.composition.Composition.clone | ( | self | ) |
Returns a copy of the object.
Reimplemented from lottie.objects.base.LottieObject.
Definition at line 62 of file composition.py.
◆ insert_layer()
| def lottie.objects.composition.Composition.insert_layer | ( | self, | |
| index, | |||
| Layer | layer | ||
| ) |
Inserts a layer to the composition.
- Note
- Layers added first will be rendered on top of later layers
Definition at line 44 of file composition.py.
◆ layer()
| def lottie.objects.composition.Composition.layer | ( | self, | |
| index | |||
| ) |
Definition at line 21 of file composition.py.
◆ load()
| def lottie.objects.composition.Composition.load | ( | cls, | |
| lottiedict | |||
| ) |
Loads from a JSON object.
- Returns
- An instance of the class
Reimplemented from lottie.objects.base.LottieObject.
Definition at line 35 of file composition.py.
◆ prepare_layer()
| def lottie.objects.composition.Composition.prepare_layer | ( | self, | |
| Layer | layer | ||
| ) |
Definition at line 53 of file composition.py.
◆ remove_layer()
| def lottie.objects.composition.Composition.remove_layer | ( | self, | |
| Layer | layer | ||
| ) |
Removes a layer (and all of its children) from this composition.
- Parameters
-
layer Layer to be removed
Definition at line 67 of file composition.py.
Member Data Documentation
◆ layers
| lottie.objects.composition.Composition.layers |
List of Composition Layers.
Definition at line 17 of file composition.py.
The documentation for this class was generated from the following file:
- lottie/objects/composition.py
