Class: RadialGradientStyle

RadialGradientStyle()

new RadialGradientStyle()

Radial gradient interpolates colors from a point to another point around up to a starting and finishing radius value. If the start and end point are the same it interpolates around the starting and ending radius forming a circle. Outside of the radius the color is solid. The get method returns a CanvasGradient https://developer.mozilla.org/en-US/docs/Web/API/CanvasGradient when generated.
Source:

Extends

Members

cache :string|CanvasGradient|CanvasPattern

Cached style object pre-generated from previous calls. To avoid regenerating the same style object every cycle. Inherited classes should write their own get method that returns the style object and stores it in this property.
Type:
  • string | CanvasGradient | CanvasPattern
Inherited From:
Source:

colors :Array.<GradientColorStop>

List of colors that compose this gradient ordered. You need to add at least one color stop to have a visible gradient.
Type:
Inherited From:
Source:

end :Vector2

The coordinates of the ending circle of the gradient.
Type:
Source:

endRadius :number

The radius of the ending circle.
Type:
  • number
Source:

needsUpdate :boolean

Indicates if the style object needs to be updated, should be used after applying changed to the style in order to generate a new object. Inherited classes should implement this functionality.
Type:
  • boolean
Inherited From:
Source:

start :Vector2

The coordinates of the starting circle of the gradient.
Type:
Source:

startRadius :number

The radius of the starting circle.
Type:
  • number
Source:

Methods

addColorStop(offset, color)

Add a new color stop defined by an offset and a color to the gradient. If the offset is not between 0 and 1 inclusive, or if color can't be parsed as a CSS color, an error is raised.
Parameters:
Name Type Description
offset number Offset of the color stop between 0 and 1 inclusive.
color string CSS color value.
Inherited From:
Source:

get(context) → {string|CanvasGradient|CanvasPattern}

Get generated style object from style data and the drawing context.
Parameters:
Name Type Description
context CanvasRenderingContext2D Context being used to draw the object.
Overrides:
Source:
Returns:
Return the canvas style object generated.
Type
string | CanvasGradient | CanvasPattern

parse(data)

Parse the style attributes from JSON object data created with the serialize() method.
Parameters:
Name Type Description
data Object Serialized style data.
Overrides:
Source:

serialize() → {Object}

Serialize the style to JSON object, called by the objects using these styles.
Overrides:
Source:
Returns:
Serialized style data.
Type
Object