CanvasRenderingContext2D: shadowOffsetY property
The CanvasRenderingContext2D.shadowOffsetY
property of the Canvas 2D API specifies the distance that shadows will be offset vertically.
Note: Shadows are only drawn if the shadowColor
property is set to a non-transparent value. One of the shadowBlur
, shadowOffsetX
, or shadowOffsetY
properties must be non-zero, as well.
Value
A float specifying the distance that shadows will be offset vertically. Positive values are down, and negative are up. The default value is 0
(no vertical offset). Infinity
and NaN
values are ignored.
Examples
Moving a shadow vertically
This example adds a blurred shadow to a rectangle. The shadowColor
property sets its color, shadowOffsetY
sets its offset 25 units towards the bottom, and shadowBlur
gives it a blur level of 10.
HTML
<canvas id="canvas"></canvas>
JavaScript
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");
ctx.shadowColor = "red";
ctx.shadowOffsetY = 25;
ctx.shadowBlur = 10;
ctx.fillStyle = "blue";
ctx.fillRect(20, 20, 150, 80);
Result
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
shadowOffsetY |
1 |
12 |
1.5 |
9 |
≤12.1 |
2 |
4.4 |
18 |
4 |
≤12.1 |
1 |
1.0 |
See also