CanvasRenderingContext2D.clearHitRegions()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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
HTML Living Standard
The definition of 'CanvasRenderingContext2D.clearHitRegions' in that specification.
Living Standard  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support Yes1 ?382 No No No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No No ?382 No No ?

1. This feature is behind the ExperimentalCanvasFeatures preference. To change preferences in Chrome, visit chrome://flags.

2. From version 38: this feature is behind the canvas.hitregions.enabled preference. To change preferences in Firefox, visit about:config.

See also

Document Tags and Contributors

 Contributors to this page: fscholz, nmve
 Last updated by: fscholz,