CanvasGradient.addColorStop

The CanvasGradient.addColorStop() method adds a new color stop, defined by an offset and a color, to a given canvas gradient.

Syntax

void gradient.addColorStop(offset, color);

Parameters

offset

A number between 0 and 1, inclusive, representing the position of the color stop. 0 represents the start of the gradient and 1 represents the end; an INDEX_SIZE_ERR is raised if the number is outside that range.

color

A CSS <color> value representing the color of the stop. A SYNTAX_ERR is raised if the value cannot be parsed as a CSS <color> value.

Examples

Using the addColorStop method

This example uses the addColorStop method to add stops to a linear CanvasGradient object. The gradient is then used to fill a rectangle.

HTML

<canvas id="canvas"></canvas>

JavaScript

var canvas = document.getElementById('canvas');
var ctx = canvas.getContext('2d');

var gradient = ctx.createLinearGradient(0, 0, 200, 0);
gradient.addColorStop(0, 'green');
gradient.addColorStop(.7, 'white');
gradient.addColorStop(1, 'pink');
ctx.fillStyle = gradient;
ctx.fillRect(10, 10, 200, 100);

Edit the code below to see your changes update live in the canvas:

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• The interface defining this method: CanvasGradient
• CanvasRenderingContext2D.createLinearGradient()
• CanvasRenderingContext2D.createRadialGradient()