BaseLayerMixin - Creator API

BaseLayerMixin interface

Mixin providing the properties and methods every layer has.

Signature:

interface BaseLayerMixin extends BaseNodeMixin

Extends: BaseNodeMixin

Remarks

Layers are timeline-based objects that exist within a specific frame range defined by startFrame and endFrame. Unlike shapes, layers have their own timeline that can be offset independently from their parent scene

Properties

Property	Modifiers	Type	Description
endFrame		number	The frame number at which the layer stops being visible
locked		boolean	Whether the layer is locked (prevents the user from editing it)
parent?	`readonly`	Parent<Layer> \| undefined	(Optional) The parent of this layer.
startFrame		number	The frame number at which the layer starts being visible
timelineOffset		number	The offset for the layer's timeline in frames

Methods

Method	Description
bringToFront()	Moves this layer to the top of the render stack (i.e. make it the foreground layer).
moveAfter(sibling)	Moves this layer immediately after (i.e. visually below) the given sibling in render order.
moveBefore(sibling)	Moves this layer immediately before (i.e. visually above) the given sibling in render order.
sendToBack()	Moves this layer to the bottom of the render stack (i.e. make it the background layer).
shiftTo(frame)	Shifts this layer to a specific frame in the timeline.