Tools reference

Text & Shapes

Control text content, style, and animators. Build and configure shape layers with groups, fills, strokes, and path operators.

Text content & style

add_text_layer

Add a new text layer with specified content, font, size, and color.

set_text_layer

Replace or update the text content of an existing text layer.

get_text_document

Get the full text document of a layer: content, font, size, color, tracking, leading.

set_text_style

Set text style properties (font, size, color, tracking, leading) on the whole text layer.

set_text_style_range

Apply style changes to a character range within a text layer.

set_text_justification

Set text justification: left, center, right, or justified variants.

set_text_box

Convert a point-text layer to a box-text layer with specified width and height.

Text animators

add_text_animator

Add a new text animator to a text layer.

set_text_animator_property

Set properties on a text animator (position, scale, opacity, color, etc.).

set_text_selector

Configure the range or expression selector on a text animator.

list_text_animators

List all text animators on a text layer.

remove_text_animator

Remove a text animator from a text layer.

Shape layers & groups

add_shape_layer

Add an empty shape layer to a composition.

add_shape_group

Add a named shape group inside a shape layer.

remove_shape_group

Remove a shape group from a shape layer.

list_shape_groups

List all shape groups in a shape layer with their names and contents.

add_shape_operator

Add a shape operator to a group: Rectangle, Ellipse, Star, Path, Merge Paths, etc.

Shape fills, strokes & operators

set_shape_fill

Set the fill color and opacity of a shape group.

set_shape_stroke

Set stroke color, width, opacity, line cap, and join on a shape group.

set_gradient_fill

Apply a gradient fill (linear or radial) to a shape group with color stops.

set_shape_vertices

Set the vertex points of a path shape.

get_shape_vertices

Get the vertex points of a path shape at a given time.

set_repeater

Configure a Repeater operator: copies, offset, transform.

set_trim_paths

Configure a Trim Paths operator: start, end, offset, and trim mode.

set_merge_paths

Set the mode of a Merge Paths operator: Add, Subtract, Intersect, Exclude, etc.