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 | Status | Comment |
---|---|---|
HTML Living Standard The definition of 'CanvasRenderingContext2D.shadowOffsetY' in that specification. |
Living Standard |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
shadowOffsetY | Chrome Full support Yes | Edge Full support 12 | Firefox Full support 1.5 | IE Full support Yes | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support 4 | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android Full support Yes |
Legend
- Full support
- Full support
See also
- The interface defining this property:
CanvasRenderingContext2D
CanvasRenderingContext2D.shadowOffsetX
CanvasRenderingContext2D.shadowColor
CanvasRenderingContext2D.shadowBlur