Property

aeq. Property

new Property(property) → {aeq.Property}

Source:

Converts a Property into an aeq.Property object

Parameters:
Name Type Description
property Property

Property to convert

Returns:

aeq.Property object

Type
aeq.Property

Methods

addKey(time) → {Key}

Source:

Adds & returns a new key at time

Parameters:
Name Type Description
time number

The time in seconds; a floating-point value. The beginning of the composition is 0.

Returns:

Newly-created key

Type
Key

expression(newValueopt) → {string|boolean}

Source:

Gets or sets expression on property

Parameters:
Name Type Attributes Description
newValue string <optional>

Expression to set

Returns:

Returns current expression, current expression error, or true if expression was set

Type
string | boolean

forEachKey(callback)

Source:

Runs a function on each key in current property

Parameters:
Name Type Description
callback function

Function to execute on each key

get() → {Property}

Source:

Get the original object

Returns:
Type
Property

key(keyIndex) → {aeq.Key}

Source:

Returns a aeq.Key object for specific key index

Parameters:
Name Type Description
keyIndex number

Index of target key

Returns:

aeq.Key object for target key

Type
aeq.Key

maxValue() → {number|null}

Source:

Returns maximum permitted value of property

Returns:

Max value, or null if there isn't one

Type
number | null

minValue() → {number|null}

Source:

Returns minimum permitted value of property

Returns:

Max value, or null if there isn't one

Type
number | null

nearestKeyIndex(time) → {Key}

Source:

Returns the index of the keyframe nearest to the specified time.

Parameters:
Name Type Description
time number

The time in seconds; a floating-point value. The beginning of the composition is 0.

Returns:

Nearest key

Type
Key

removeKey(keyIndex)

Source:

Removes key by index or key object

Parameters:
Name Type Description
keyIndex number | Key

Index of target key, or key itself

selectedKeys() → {Array.<Key>}

Source:

Gets array of selected keys

Returns:

Array of keys to return

Type
Array.<Key>

separationDimension() → {number|null}

Source:

Returns the dimension number it represents in the multidimensional leader Can only be accessed if the property is one of the separated properties (e.g Y Position), otherwise AE throws an error

Returns:

Dimension number, or null

Type
number | null

separationFollower(dim) → {Property}

Source:

Retrieves property following passed dimension

Parameters:
Name Type Description
dim number

The dimension number (starting at 0).

Returns:

Property following passed dimension

Type
Property

separationLeader() → {Property|null}

Source:

Returns the original multidimensional property for this separated follower Can only be accessed if the property is one of the separated properties (e.g Y Position), otherwise AE throws an error

Returns:

Original multidimensional property, or null

Type
Property | null

value(newValueopt) → {any}

Source:

Gets or sets property value If expressionEnabled is true, returns the evaluated expression value. If there are keyframes, returns the keyframed value at the current time. Otherwise, returns the static value.

Parameters:
Name Type Attributes Description
newValue any <optional>

New value to try to set

Returns:

Current value

Type
any

valueAtTime(time, valueopt) → {any|number}

Source:

Get or set the value of the current property as evaluated at the specified time

Parameters:
Name Type Attributes Description
time number

The time in seconds; a floating-point value. The beginning of the composition is 0.

value any <optional>

Property value at time

Returns:

Set value, or index of nearest key to time

Type
any | number

valuesAtTimes(time, valueopt) → {Array.<any>|Array.<number>}

Source:

Get or sets values for a set of keyframes at specified times

Parameters:
Name Type Attributes Description
time Array.<number>

Array of times

value Array.<any> <optional>

Array of values

Returns:

Array of set values, or array of indices of nearest key to time

Type
Array.<any> | Array.<number>