Canvas addColorStop() Method
Example
Define a gradient from black to white and use it to fill a rectangle:
JavaScript:
const canvas = document.getElementById('myCanvas');
const ctx = canvas.getContext('2d');
// Create a Gradient
const grd = ctx.createLinearGradient(0, 0, 170, 0);
grd.addColorStop(0, "black");
grd.addColorStop(1, "white");
// Draw a filled Rectangle
ctx.fillStyle = grd;
ctx.fillRect(20, 20, 150, 100);
Try it Yourself »
Description
The addColorStop() method specifies a color and a position in a gradient object.
The addColorStop() method is used together with
Linear Gradient Objects and
Radial Gradient Objects.
Note
You must add a color stop to a gradient object to make the gradient visible.
See Also:
The createLinearGradient() Method (Create gradiant object)
The createRadialGradient() Method (Create gradiant object)
The fillStyle Property (Set fill color/style)
The strokeStyle Property (Set stroke color/style)
Syntax
| gradient.addColorStop(stop, color) |
Parameter Values
| Param | Description | Play it |
|---|---|---|
| stop | A value between 0 and 1. The position between gradian start and end | Play it » |
| color | A CSS color value to display at the stop position | Play it » |
Return Value
| NONE |
More Examples
Example
Define a gradient with multiple addColorStop() methods:
JavaScript:
const canvas = document.getElementById("myCanvas");
const ctx = canvas.getContext("2d");
const grd = ctx.createLinearGradient(0, 0, 170, 0);
grd.addColorStop(0, "black");
grd.addColorStop("0.3", "magenta");
grd.addColorStop("0.5", "blue");
grd.addColorStop("0.6", "green");
grd.addColorStop("0.8", "yellow");
grd.addColorStop(1, "red");
ctx.fillStyle = grd;
ctx.fillRect(20, 20, 150, 100);
Try it Yourself »
Browser Support
The <canvas> element is an HTML5 standard (2014).
addColorStop() is supported in all modern browsers:
| Chrome | Edge | Firefox | Safari | Opera | IE |
| Yes | Yes | Yes | Yes | Yes | 9-11 |
