CanvasRenderingContext2D.clearHitRegions

The CanvasRenderingContext2D.clearHitRegions() method of the Canvas 2D API removes all hit regions from the canvas.

Syntax

void ctx.clearHitRegions();

Examples

Using the clearHitRegions method

This is just a simple code snippet which uses the clearHitRegions method.

HTML

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

JavaScript

var canvas = document.getElementById('canvas');
var 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

Specification	Status	Comment
WHATWG HTML Living Standard The definition of 'CanvasRenderingContext2D.clearHitRegions' in that specification.	Living Standard

Browser compatibility

[1] This feature is behind a feature flag. Set the flag ExperimentalCanvasFeatures to true to enable it.

[2] This feature is behind a feature preference setting. In about:config, set canvas.hitregions.enabled to true.

See also

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