Skip to main content

Class: FillChain

Defined in: attributes/shape/fill/chain.ts:40

Immutable, chainable list of fill layers.

Each builder method returns a new FillChain with the layer appended, so chains are safe to share and branch — mirroring EffectChain.

Example​

const bg = Fill.image('./background.jpg', { blend: 'overlay', opacity: 0.2 })
               .color('red', { opacity: 0.3 });
node.fill = bg;                 // assign directly
node.fill = [...bg, 'white'];   // spread into an array

Constructors​

Constructor​

new FillChain(list?): FillChain

Defined in: attributes/shape/fill/chain.ts:41

Parameters​

list?​

FillProp[] = []

Returns​

FillChain

Properties​

list​

list: FillProp[] = []

Defined in: attributes/shape/fill/chain.ts:41

Methods​

[iterator]()​

[iterator](): Generator<FillProp, void, unknown>

Defined in: attributes/shape/fill/chain.ts:86

Allows spreading the chain into an array: [...Fill.color('red')].

Returns​

Generator<FillProp, void, unknown>

color()​

color(color, options?): FillChain

Defined in: attributes/shape/fill/chain.ts:44

Append a solid color fill. A CSS string or normalized [r,g,b,a].

Parameters​

color​

Color

options?​

FillOptions

Returns​

FillChain

conicGradient()​

conicGradient(colors, options?): FillChain

Defined in: attributes/shape/fill/chain.ts:68

Append a conic gradient between colors.

Parameters​

colors​

Color[]

options?​

FillOptions & object

Returns​

FillChain

image()​

image(src, options?): FillChain

Defined in: attributes/shape/fill/chain.ts:49

Append an image fill from src.

Parameters​

src​

string

options?​

FillOptions & object

Returns​

FillChain

linearGradient()​

linearGradient(colors, options?): FillChain

Defined in: attributes/shape/fill/chain.ts:56

Append a linear gradient between colors.

Parameters​

colors​

Color[]

options?​

FillOptions & object

Returns​

FillChain

noise()​

noise(options?): FillChain

Defined in: attributes/shape/fill/chain.ts:74

Append a noise fill.

Parameters​

options?​

FillOptions & object

Returns​

FillChain

radialGradient()​

radialGradient(colors, options?): FillChain

Defined in: attributes/shape/fill/chain.ts:62

Append a radial gradient between colors.

Parameters​

colors​

Color[]

options?​

FillOptions & object

Returns​

FillChain

stripe()​

stripe(options?): FillChain

Defined in: attributes/shape/fill/chain.ts:80

Append a stripe (hatch) fill.

Parameters​

options?​

FillOptions & object

Returns​

FillChain

toJSON()​

toJSON(): FillProp[]

Defined in: attributes/shape/fill/chain.ts:91

Serializes to the raw fill array so frameworks that call toJSON get a plain value.

Returns​

FillProp[]