# Two.Gradient

Extends: Two.Element

This is the base class for constructing different types of gradients with Two.js. The two common gradients are Two.LinearGradient and Two.RadialGradient.

Source

# Constructor

Argument Description
stops A list of Two.Stops that contain the gradient fill pattern for the gradient.

# Stop

See: Two.Stop

gradient.js:57

# Properties

A list of properties that are on every Two.Gradient.

gradient.js:63

# fromObject

Returns: Two.Gradient

Argument Description
obj Object notation of a Two.Gradient to create a new instance

Create a new Two.Gradient from an object notation of a Two.Gradient.

gradient.js:69

nota-bene

Works in conjunction with Two.Gradient.toObject

# spread

Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle. Possible values are 'pad', 'reflect', and 'repeat'.

See: https://www.w3.org/TR/SVG11/pservers.html#LinearGradientElementSpreadMethodAttribute (opens new window) for more information

gradient.js:34

# units

Indicates how coordinate values are interpreted by the renderer. Possible values are 'userSpaceOnUse' and 'objectBoundingBox'.

See: https://www.w3.org/TR/SVG11/pservers.html#RadialGradientElementGradientUnitsAttribute (opens new window) for more information

gradient.js:41

# stops

An ordered list of Two.Stops for rendering the gradient.

gradient.js:48

# clone

Returns: Two.Gradient

Argument Description
parent The parent group or scene to add the clone to.

Create a new instance of Two.Gradient with the same properties of the current path.

gradient.js:91

# copy

Argument Description
gradient The reference Two.Gradient

Copy the properties of one Two.Gradient onto another.

gradient.js:120

# toObject

Returns: Object

Return a JSON compatible plain object that represents the path.

gradient.js:139

# dispose

Detach instance from renderer including any <defs /> or textures stored in memory.

gradient.js:193

← Two.LinearGradient →