Web/API/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

Adding stops to a gradient

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

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

let 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);

Result

Specifications

Specification	Status	Comment
HTML Living StandardThe definition of 'CanvasGradient.addColorStop' in that specification.	Living Standard

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`addColorStop`	Chrome Full support 6	Edge Full support 12	Firefox Full support 3.6	IE Full support 9	Opera Full support 9	Safari Full support 5.1	WebView Android Full support ≤37	Chrome Android Full support 18	Firefox Android Full support 4	Opera Android Full support 10.1	Safari iOS Full support 6	Samsung Internet Android Full support 1.0

Legend

Full support: Full support