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
and1
, inclusive, representing the position of the color stop.0
represents the start of the gradient and1
represents the end; anINDEX_SIZE_ERR
is raised if the number is outside that range. color
-
A CSS
<color>
value representing the color of the stop. ASYNTAX_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 |
---|
HTML Standard # dom-canvasgradient-addcolorstop-dev |
Browser compatibility
BCD tables only load in the browser
See also
- The interface defining this method:
CanvasGradient
CanvasRenderingContext2D.createLinearGradient()
CanvasRenderingContext2D.createRadialGradient()