Creator API Types | Creator API

Types

Types in the Creator API.

Type	Description
APIVersion	The current Creator API version, as a semver string (e.g. '1.0.1').
AlignDirection	The direction for alignment operations.
Asset	Union type of all asset types.
AudioAsset	Represents an audio asset.
BaseAssetMixin	Base interface for all asset types.
BlendMode	Blend modes for layers and groups.
ClientStorage	Browser storage that persists across sessions.
CreatorEvent	Event types that your code can listen to.
CreatorEventData	Helper type to extract event data for a specific event name.
CreatorEventName	Union of all event types.
Easing	Represents the easing function for a keyframe.
EllipseOptions	Options for creating an ellipse shape.
FlipDirection	The direction for flip operations.
FontAsset	Represents a user-uploaded font asset in the document.
GroupOptions	Options for creating a group.
Image	Represents an image asset.
ImageLayerCreateOptions	Options for creating an image layer.
ImportFromContent	Options for importing inline content.
ImportFromURL	Options for importing content from a URL.
KeyframeAdd	Keyframe data used for creating new keyframes
LayerCreateOptions	Options for creating a layer.
LinearGradientPaintOptions	Options for creating a linear gradient paint. If start/end are not provided, they default to the lef...
MaskMode	Mode for mask operations.
MaskOptions	Options for creating a new mask.
NullLayerCreateOptions	Options for creating a null layer.
Paint	Union type of all paint types.
PaintOptions	Union type of all paint option types for creating paints.
Parent	Type helper to get valid parent types for a node.
PathOptions	Options for creating a path shape.
PluginData	Custom data on this node associated with your plugin.
PolygonOptions	Options for creating a polygon shape.
RadialGradientPaintOptions	Options for creating a radial gradient paint. If start/end are not provided, start defaults to the c...
RectangleOptions	Options for creating a rectangle shape.
ResizeUIOptions	Options for resizing the plugin UI window.
SceneCreateOptions	Options for creating a new scene.
SceneLayerCreateOptions	Options for creating a scene layer.
SelectionAPI	API for accessing the currently selected nodes and keyframes.
ShowUIOptions	Options for configuring the plugin UI window display.
SolidPaintOptions	Options for creating a solid color paint.
StarOptions	Options for creating a star shape.
StrokeOptions	Options for creating a stroke.
TextAlignment	Horizontal alignment for text within a TextLayer.
TextLayerCreateOptions	Options for creating a text layer.
TextStroke	A stroke applied to a TextLayer.
TextStrokeOptions	Options for creating or updating a stroke on a TextLayer, or for the initial stroke on stroke.
ThemeTokens	Theme token data emitted when the Creator UI theme changes.
TimelineAPI	API for controlling the animation timeline.
TrimPath	Represents a trim path effect applied to shapes.
TrimPathOptions	Options for creating a new trim path.
UIAPI	API for managing and communicating with the plugin UI window.
WindowPosition	Supported 9-grid positions for the initial plugin UI window placement.