Property
Property(
enabled: bool,
match_name: str,
name: str,
animated: bool,
color: bool,
dimensions_separated: bool,
dimensions: int,
expression_enabled: bool,
expression: str,
integer: bool,
is_spatial: bool,
keyframes: list[Keyframe],
locked_ratio: bool,
no_value: bool,
property_control_type: PropertyControlType,
property_value_type: PropertyValueType,
value: Any,
vector: bool,
elided: bool = False,
default_value: Any = None,
last_value: Any = None,
max_value: Any = None,
min_value: Any = None,
nb_options: int | None = None,
property_parameters: list[str] | None = None,
)
Bases: PropertyBase
The Property object contains value, keyframe, and expression information
about a particular AE property of a layer. An AE property is a value,
often animatable, of an effect, mask, or transform within an individual
layer.
Info
Property is a subclass of PropertyBase. All methods and attributes
of PropertyBase are available when working with Property.
See: https://ae-scripting.docsforadobe.dev/property/property/
Attributes¶
dimensions_separated: bool
When True, the property's dimensions are represented as separate
properties. For example, if the layer's position is represented as X
Position and Y Position properties in the Timeline panel, the Position
property has this attribute set to True. This attribute applies only
when the property is a "separation leader" (a multidimensional property
that can be separated).
expression: str
The expression for the named property. Writeable only when
can_set_expression for the named property is True.
expression_enabled: bool
When True, the named property uses its associated expression to generate
a value. When False, the keyframe information or static value of the
property is used.
is_dropdown_effect: bool
True if the property is the Menu property of a Dropdown Menu Control effect.
is_spatial: bool
When True, the named property defines a spatial value. Examples are
position and effect point controls.
is_time_varying: bool
True if the named property has keyframes or an enabled expression.
match_name: str
A special name for the property used to build unique naming paths. The match name is not displayed, but you can refer to it in scripts. Every property has a unique match-name identifier.
max_value: Any = None
The maximum permitted value of the named property. Only valid if
has_max is True.
min_value: Any = None
The minimum permitted value of the named property. Only valid if
has_min is True.
property_control_type: PropertyControlType
The type of effect control (scalar, color, enum, etc.) for this property.
An array of all item strings in a dropdown menu property. This attribute applies to dropdown menu properties of effects and layers, including custom strings in the Menu property of the Dropdown Menu Control.
property_value_type: PropertyValueType
The type of value stored in the named property. Each type of data is stored and retrieved in a different kind of structure. For example, a 3D spatial property (such as a layer's position) is stored as an array of three floating-point values.
value: Any
The value of the named property at the current time. If expression_enabled
is True, returns the evaluated expression value. If there are keyframes,
returns the keyframed value at the current time. Otherwise, returns the
static value.