CanvasRenderingContext2D.shadowOffsetY
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.
Syntax
ctx.shadowOffsetY = offset;
offset
-
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
andNaN
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'); // Shadow ctx.shadowColor = 'red'; ctx.shadowOffsetY = 25; ctx.shadowBlur = 10; // Rectangle ctx.fillStyle = 'blue'; ctx.fillRect(20, 20, 150, 80);
Result
Specifications
Specification |
---|
HTML Standard (HTML) # dom-context-2d-shadowoffsety-dev |
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 |
1 |
18 |
4 |
≤12.1 |
1 |
1.0 |
See also
- The interface defining this property:
CanvasRenderingContext2D
CanvasRenderingContext2D.shadowOffsetX
CanvasRenderingContext2D.shadowColor
CanvasRenderingContext2D.shadowBlur
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY