Interface: GridPatternProps

Defined in: nodes/geometry/grid-pattern-node.ts:15

Extends

ShapeProps

Properties

blend

blend: "color" | "multiply" | "screen" | "overlay" | "darken" | "lighten" | "color-dodge" | "color-burn" | "hard-light" | "soft-light" | "difference" | "exclusion" | "hue" | "saturation" | "luminosity" | "normal" | "pass-through"

Defined in: nodes/base/node.ts:162

Layer blend mode. 'pass-through' (default) does not isolate the node — its opacity scales each child/fill while they blend against the backdrop. Any other mode isolates the node and blends its flattened result against the backdrop.

Inherited from

ShapeProps.blend

bottomCenter

bottomCenter: Vector2 | (() => Vector2)

Defined in: nodes/base/node.ts:194

Inherited from

ShapeProps.bottomCenter

bottomLeft

bottomLeft: Vector2 | (() => Vector2)

Defined in: nodes/base/node.ts:191

Inherited from

ShapeProps.bottomLeft

bottomRight

bottomRight: Vector2 | (() => Vector2)

Defined in: nodes/base/node.ts:192

Inherited from

ShapeProps.bottomRight

cellSize

cellSize: number | Vector2

Defined in: nodes/geometry/grid-pattern-node.ts:21

Spacing between adjacent grid cells, in world units. A single number is used for both axes; a { x, y } gives a different spacing per axis. Defaults to 100.

center

center: Vector2 | (() => Vector2)

Defined in: nodes/base/node.ts:188

Inherited from

ShapeProps.center

centerLeft

centerLeft: Vector2 | (() => Vector2)

Defined in: nodes/base/node.ts:195

Inherited from

ShapeProps.centerLeft

centerRight

centerRight: Vector2 | (() => Vector2)

Defined in: nodes/base/node.ts:196

Inherited from

ShapeProps.centerRight

children

children: NodeChildren

Defined in: nodes/base/node.ts:173

Child nodes. A single Node, or an arbitrarily-nested array of them — the constructor flattens nesting (.flat(Infinity)), so .map() results can be dropped in directly as a child without spreading, like React.

Inherited from

ShapeProps.children

clip

clip: boolean

Defined in: nodes/base/node.ts:167

When true, content drawn outside this node's outline is clipped away (see Node.clipSelf).

Inherited from

ShapeProps.clip

colSpan

colSpan: number

Defined in: nodes/base/node.ts:214

How many grid columns this child spans. Default 1.

Inherited from

ShapeProps.colSpan

column

column: number

Defined in: nodes/base/node.ts:210

1-based column index for explicit grid placement. Undefined = auto-placed.

Inherited from

ShapeProps.column

effects

effects: Effect

Defined in: nodes/base/node.ts:163

Inherited from

ShapeProps.effects

end?

optional end?: number

Defined in: nodes/geometry/shape-node.ts:52

Inherited from

ShapeProps.end

fill?

optional fill?: Fill

Defined in: nodes/geometry/shape-node.ts:31

Fill layer(s). Each item can be:

A plain CSS color string → treated as a solid fill
A fill prop object (SolidFillProp, LinearGradientFillProp, …)
An already-resolved fill object
A FillChain from the Fills builder (e.g. Fills.color('red'))

Inherited from

ShapeProps.fill

flex

flex: number

Defined in: nodes/base/node.ts:206

Proportional share of the free space along the parent's main axis, relative to sibling fill children (like Flutter's Expanded(flex:)). Only meaningful when this node fills the main axis — in a row that's width:'fill', in a column height:'fill'. Two siblings with flex 2 and 1 split the free space 2:1. Defaults to 1. Specifying flex without an explicit width/height defaults both to 'fill'.

Inherited from

ShapeProps.flex

height

height: SizeInput

Defined in: nodes/base/node.ts:146

Inherited from

ShapeProps.height

offset

offset: Vector2

Defined in: nodes/geometry/grid-pattern-node.ts:38

Pixel offset that pans the whole grid relative to the world. The grid is otherwise anchored to world coordinates, so it stays put as the camera moves over it; animate offset to scroll the pattern itself.

opacity

opacity: number

Defined in: nodes/base/node.ts:160

Inherited from

ShapeProps.opacity

overlay?

optional overlay?: Fill

Defined in: nodes/geometry/shape-node.ts:38

Overlay layer(s) — the same loose values as fill, but painted over this node's fill and its children (clipped to the node's silhouette) while still sitting under the stroke. Use for textures laid across the whole subtree, e.g. a VHS-grain image or video.

Inherited from

ShapeProps.overlay

padding

padding: Insets

Defined in: nodes/base/node.ts:165

Inner spacing between this node's edges and its content/children.

Inherited from

ShapeProps.padding

pivot

pivot: Anchor

Defined in: nodes/base/node.ts:181

Pivot point for rotation and scale. Either a named anchor ('center', 'topRight', 'bottomLeft', … — the node align vocabulary) or an explicit Vector2: (0,0)=center, (-1,1)=top-left, (1,-1)=bottom-right. Set automatically when an anchor positioning prop is used.

Inherited from

ShapeProps.pivot

rotation

rotation: number

Defined in: nodes/base/node.ts:159

Inherited from

ShapeProps.rotation

row

row: number

Defined in: nodes/base/node.ts:212

1-based row index for explicit grid placement. Undefined = auto-placed.

Inherited from

ShapeProps.row

rowSpan

rowSpan: number

Defined in: nodes/base/node.ts:216

How many grid rows this child spans. Default 1.

Inherited from

ShapeProps.rowSpan

scale

scale: number

Defined in: nodes/base/node.ts:158

Inherited from

ShapeProps.scale

seed

seed: string | number

Defined in: nodes/base/node.ts:225

Origin seed for this node's Node.random source. Defaults to 0. Set it to give the node a reproducible-but-distinct random stream without re-seeding by hand. The constructor adopts it as random's origin, and the runtime rebuilds the node each playback pass, so draws stay reproducible across scrub/precomp/HMR.

Inherited from

ShapeProps.seed

shadow?

optional shadow?: Shadow

Defined in: nodes/geometry/shape-node.ts:50

Shadow layer(s): a single ShadowProp, an array of them, or an already-resolved shadow. fill inside each shadow accepts the same loose values as the top-level fill prop.

Inherited from

ShapeProps.shadow

size

size: SizeInput

Defined in: nodes/base/node.ts:157

Sets width and height to the same value in one go. Pure sugar: at construction time, an author-facing size is expanded into width/ height before either is applied. Explicit width or height takes precedence over size (mirroring padding's side-vs-shorthand rule), so { size: 200, width: 100 } yields width: 100, height: 200. Reactive bindings and to()/set() targets both work the same as width/height — size: 'fill', size: () => ..., or node.to({ size: 300 }, 0.5) are all valid.

Inherited from

ShapeProps.size

start?

optional start?: number

Defined in: nodes/geometry/shape-node.ts:51

Inherited from

ShapeProps.start

stroke?

optional stroke?: Stroke

Defined in: nodes/geometry/shape-node.ts:44

Stroke layer(s): a single StrokeProp, an array of them, or an already-resolved stroke. fill inside each stroke accepts the same loose values as the top-level fill prop.

Inherited from

ShapeProps.stroke

subdivisions

subdivisions: number

Defined in: nodes/geometry/grid-pattern-node.ts:27

Number of finer cells each cell is split into. 1 (the default) draws no minor lines; 2 adds one minor line per cell, and so on — same as LineGrid.subdivisions.