property

aeq. property

Source:

Module for dealing with Property objects.

Methods

(static) getLayer(property) → {Layer}

Source:

Gets the layer the given property is contained in.

Parameters:
Name Type Description
property Property

The Property to get layer from.
Returns:

The containing Layer object.

Type
Layer

(static) type(property) → {string}

Source:

Returns the property type as a string.

Parameters:
Name Type Description
property Property

The property to get the type of
Returns:

The property type, on of:

  • PROPERTY: A single property such as position or zoom.
  • INDEXED_GROUP: A property group whose members have an editable name and an index. Effects and masks are indexed groups. For example, the masks property of a layer refers to a variable number of individual masks by index number.
  • NAMED_GROUP: A property group in which the member names are not editable. Layers are named groups.
Type
string

(static) valueType(property) → {string}

Source:

Returns the property value type of a Property as a string.

Example

Returns "ThreeD_SPATIAL"

aeq.property.valueType( layer.Transform.Position )
Parameters:
Name Type Description
property Property

The property to get the value type of.
Returns:

The property value type, on of:

  • NO_VALUE: Stores no data.
  • ThreeD_SPATIAL: Array of three floating-point positional values. For example, an Anchor Point value might be [10.0, 20.2, 0.0]
  • ThreeD: Array of three floating-point quantitative values. For example, a Scale value might be [100.0, 20.2, 0.0]
  • TwoD_SPATIAL: Array of 2 floating-point positional values. For example, an Anchor Point value might be [5.1, 10.0]
  • TwoD: Array of 2 floating-point quantitative values. For example, a Scale value might be [5.1, 100.0]
  • OneD: A floating-point value.
  • COLOR:Array of 4 floating-point values, in the range [0.0..1.0]. For example, [0.8, 0.3, 0.1, 1.0]
  • CUSTOM_VALUE: Custom property value, such as the Histogram property for the Levels effect.
  • MARKER: MarkerValue object
  • LAYER_INDEX: Integer; a value of 0 means no layer.
  • MASK_INDEX: Integer; a value of 0 means no mask.
  • SHAPE: Shape object
  • TEXT_DOCUMENT: TextDocument object
Type
string