CanvasRenderingContext2D: shadowOffsetY property

{{APIRef("Canvas API")}}

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 {{domxref("CanvasRenderingContext2D.shadowColor", "shadowColor")}} property is set to a non-transparent value. One of the {{domxref("CanvasRenderingContext2D.shadowBlur", "shadowBlur")}}, {{domxref("CanvasRenderingContext2D.shadowOffsetX", "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). {{jsxref("Infinity")}} and {{jsxref("NaN")}} values are ignored.

Examples

Moving a shadow vertically

This example adds a blurred shadow to a rectangle. The {{domxref("CanvasRenderingContext2D.shadowColor", "shadowColor")}} property sets its color, shadowOffsetY sets its offset 25 units towards the bottom, and {{domxref("CanvasRenderingContext2D.shadowBlur", "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

{{ EmbedLiveSample('Moving_a_shadow_vertically', 700, 180) }}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• The interface defining this property: {{domxref("CanvasRenderingContext2D")}}
• {{domxref("CanvasRenderingContext2D.shadowOffsetX")}}
• {{domxref("CanvasRenderingContext2D.shadowColor")}}
• {{domxref("CanvasRenderingContext2D.shadowBlur")}}