CanvasRenderingContext2D.clearHitRegions()

The CanvasRenderingContext2D method clearHitRegions() removes all hit regions from the canvas.

Syntax

void ctx.clearHitRegions();

Examples

Using the clearHitRegions method

This example demonstrates the clearHitRegions() method.

HTML

<canvas id="canvas"></canvas>

JavaScript

const canvas = document.getElementById('canvas');
const ctx = canvas.getContext('2d');

// Set some hit regions
ctx.addHitRegion({id: 'eyes'});
ctx.addHitRegion({id: 'nose'});
ctx.addHitRegion({id: 'mouth'});

// Remove them altogether from the canvas
ctx.clearHitRegions();

Specifications

Canvas hit regions have been removed from the WHATWG Living Standard, although discussions about future standardization are ongoing. See https://github.com/whatwg/html/issues/3407 for more information.

Browser compatibility

See also

• CanvasRenderingContext2D.addHitRegion()
• CanvasRenderingContext2D.removeHitRegion()