Skip to content

Commit

Permalink
Merged in colombo/add-group-page (pull request #5)
Browse files Browse the repository at this point in the history
Add a new Group page

Approved-by: Zack Lovatt
  • Loading branch information
1Resonant committed Mar 5, 2021
2 parents b37b012 + f082d08 commit c3b7183
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 0 deletions.
88 changes: 88 additions & 0 deletions docs/group.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
.. _Group:

Group
##############

All properties im the Timeline are organized into groups, which share some attributes of properties like ``name`` and ``propertyIndex``. Groups can have a fixed number of properties (e.g. an individual effect whose properties don't change) or a variable number of properties (e.g. the Effects group itself which can have any number of effect within it).

* **Top-level groups in a Layer:**
* Motion Trackers
* Text
* Contents
* Masks
* Effects
* Transform
* Layer Styles
* Geometry Options
* Material Options
* Audio
* Data
* Essential Properties
* **Nested groups**
* Individual effects
* Individual masks
* Shape groups
* Text Animators

----

.. _Group.numProperties:

numProperties
*****************

**Description**

Returns the number of properties or groups directly within a group. This does not include properties nested inside child groups.

.. tip::
Find the number of effects applied to a layer with ``thisLayer("ADBE Effect Parade").numProperties`` using the match name to remain language-agnostic.

**Type**

Number

----

.. _Group.propertyGroup:

propertyGroup(``countUp=1``)
******************************

**Description**

Returns a higher-level property group relative to the property group on which the method is called. See :ref:`Property.propertyGroup` for additional details.

**Type**

Group

----

.. _Group.propertyIndex:

propertyIndex
*****************

**Description**

Returns the index of a property group relative to other properties or groups in its property group.

**Type**

Number

----

.. _Group.name:

name
*****************

**Description**

Returns the name of the property group.

**Type**

String
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ After Effects Expression Reference
footage
camera
light
group
effect
mask
property
Expand Down

0 comments on commit c3b7183

Please sign in to comment.