CanvasGradient: addColorStop() method
The CanvasGradient.addColorStop()
method adds a new color stop,
defined by an offset
and a color
, to a given canvas gradient.
Syntax
js
addColorStop(offset, color)
Parameters
Return value
None (undefined
).
Exceptions
IndexSizeError
DOMException
-
Thrown if
offset
is not between 0 and 1 (both included). SyntaxError
DOMException
-
Thrown if
color
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
html
<canvas id="canvas"></canvas>
JavaScript
js
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");
let gradient = ctx.createLinearGradient(0, 0, 200, 0);
gradient.addColorStop(0, "green");
gradient.addColorStop(0.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()