Skip to content

Essential graphics

EssentialGraphicsController

A single controller in the Essential Graphics panel.

Each controller maps to a LIST:CCtl chunk inside LIST:CIF3. The controller name is stored in a LIST:CpS2 localized string chunk and can be renamed via the name attribute.

Attributes

controller_type

controller_type = ChunkField[int](
    "_ctyp", "value", read_only=True
)

The controller type ID. Read-only.

Known values: 1=Checkbox, 2=Slider, 4=Color, 5=Point, 6=Text, 8=Comment, 9=MultiDimensional, 10=Group, 13=Dropdown, 14=Media Replacement.

name

name = ChunkField[str](
    "_name_utf8", "value", validate=validate_name
)

The display name of the controller. Read / Write.

source_comp_id

source_comp_id = source_comp_id

The item id of the source composition that owns the controlled property (the CCId chunk), or None when not stored. Read-only.

source_layer_id

source_layer_id = source_layer_id

The layer_id of the source layer that owns the controlled property (the CLId chunk), or None when not stored. Read-only.

source_property_path

source_property_path = source_property_path

The path (root to leaf) to the source-composition property this controller exposes, as SourcePropertyRef nodes. Empty when the path is not stored. Read-only.

uuid

uuid = uuid

The unique identifier for this controller.