Guide

Guide ¶

A ruler guide used for alignment in a composition.

Guides are horizontal or vertical lines placed at specific pixel positions within a composition. They are visual aids and do not affect rendering.

Note

Guide class has no ExtendScript equivalent.

Example

from py_aep import parse

app = parse("project.aep")
comp = app.project.compositions[0]
for guide in comp.guides:
    print(guide.orientation_type, guide.position)

Attributes¶

orientation_type ¶

orientation_type = enum(
    GuideOrientationType, "_guide_item", "orientation_type"
)

The orientation of the guide. Read / Write.

position ¶

position = ChunkField[float](
    "_guide_item",
    "position",
    validate=validate_number(min=0.0),
)

The position of the guide in pixels from the top (horizontal) or left (vertical) edge of the composition. Read / Write.

position_type ¶

position_type = ChunkField[int](
    "_guide_item", "position_type"
)

The position type of the guide. Always 0 (pixels). Read / Write.