Namespace: DuAETag

DuAETag

After Effects tag methods
Tags are markers set on the first frame of layers, displaying an info about the layer (usually, a "type" or tag).
These markers are used by DuAEF (and Duik, DuGR, ...) to recognise and manipulate the layers, and to store hidden data.
They're also used assign the layer to groups, which can be used by other scripts, especially DuGR.

Members

staticDuAETag.hideTags

Set to true so the markers are created before the composition start time and hidden

static,readonlyDuAETag.Keystring

The list of paramaters which can be set by DuAEF in tags.
Properties:
Name Type Default Description
CHILD_LAYERS string childrenLayers Used to temporarily store the list of children of the layers.
GROUPS string groups A list of groups this layer belongs to.

static,readonlyDuAETag.Namestring

The list of names used for the markers.
Names are the string shown to the user on the marker, the comment.
Note that these names may change as they may be localized and should not be used to manipulate layers, but only shown to the user.
Properties:
Name Type Default Description
EDIT_MODE string DuScriptUI.String.EDIT_MODE A layer toggled to edit mode.

static,readonlyDuAETag.Typeint

The list of types to parse values.
Properties:
Name Type Default Description
STRING int 0
BOOL int 1
INT int 2
ARRAY int 3
FLOAT int 4

Methods

staticDuAETag.addGroup(layer, groupName, tag)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18219
Assigns the layer to a group.
If the layer does not have a tag yet, a new one will be created with the group name.
Name Type Description
layer Layer The layer.
groupName string The group.
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.

staticDuAETag.get(layer){MarkerValue|null}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18055
Gets the tag.
Name Type Description
layer Layer The layer to get the tag from.
Returns:
Type Description
MarkerValue | null The marker (tag) or null if not found.

staticDuAETag.getGroups(layer, tag){Array.<string>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18203
Gest the list of the groups this layer belongs to.
Name Type Description
layer Layer
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.
Returns:
Type Description
Array.<string> The list of groups. May be an empty list.

staticDuAETag.getName(layer){string}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18120
Gets the name (comment of the marker) of the tag.
Name Type Description
layer Layer The layer to get the tag from
Returns:
Type Description
string The name.

staticDuAETag.getValue(layer, key, type, tag){any}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18157
Gets the value of a specific key in the tag parameters.
Name Type Default Description
layer Layer The layer to get the tag from.
key string The key. May be one of DuAETag.Key.
type DuAETag.Type DuAETag.Type.STRING optional The expected type for the value.
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.
Returns:
Type Description
any The value, null if the key was not found.

staticDuAETag.remove(layer, tag)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18087
Removes the tag from the layer
Name Type Description
layer Layer The layer containing the tag.
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.

staticDuAETag.removeGroup(layer, groupName, tag)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18241
Unassigns the layer from a group.
Name Type Description
layer Layer The layer.
groupName string The group.
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.

staticDuAETag.renameGroup(layer, previousName, newName, tag)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18262
Renames a group
Name Type Description
layer Layer The layer.
previousName string The current name
newName string The new name
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.

staticDuAETag.set(layer, tagName, tag, hidden){MarkerValue}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18011
Sets a new marker/tag (or gets the existing one) on the first frame of the layer.
Name Type Default Description
layer Layer The layer to set the tag on.
tagName string optional The name to display on the marker (the comment of the marker)
tag MarkerValue optional An existing tag.
hidden Boolean DuAETag.hideTags optional When true, the marker will be created before the layer and comp start time, so it's hidden.
Returns:
Type Description
MarkerValue The marker (tag), with an extra property keyIndex which is the index of the corresponding keyframe.

staticDuAETag.setName(layer, tagName, tag){string}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18103
Sets the name (comment of the marker) of the tag.
Name Type Description
layer Layer The layer to get the tag from
tagName string optional The name to display on the marker (the comment of the marker)
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.
Returns:
Type Description
string The name.

staticDuAETag.setValue(layer, key, value, tag){Boolean}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 18135
Sets a new parameter (a key/value pair) to the hidden parameters stored in the tag.
Name Type Description
layer Layer The layer to get the tag from.
key string The key. May be one of DuAETag.Key.
value string The value, which needs to be a string.
tag MarkerValue optional If you have the tag as returned by DuAETag.get or DuAETag.set, providing it here improves performance.
Returns:
Type Description
Boolean Success, may be false if there's no tag on this layer yet.