Web/API/CanvasRenderingContext2D/clearHitRegions

ObsoleteThis feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

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

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.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
clearHitRegions Experimental'Deprecated'Non-standard'	Chrome Full support Yes Disabled' Full support Yes Disabled' Disabled' This feature is behind the Experimental Web Platform Features preference. To change preferences in Chrome, visit chrome://flags.	Edge Full support ≤79 Disabled' Full support ≤79 Disabled' Disabled' From version ≤79: this feature is behind the Experimental Web Platform Features preference.	Firefox Full support 38 Disabled' Full support 38 Disabled' Disabled' From version 38: this feature is behind the canvas.hitregions.enabled preference. To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari No support No	WebView Android No support No	Chrome Android No support No	Firefox Android Full support 38 Disabled' Full support 38 Disabled' Disabled' From version 38: this feature is behind the canvas.hitregions.enabled preference. To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS No support No	Samsung Internet Android No support No

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

Non-standard. Expect poor cross-browser support.'

Non-standard. Expect poor cross-browser support.

Deprecated. Not for use in new websites.'

Deprecated. Not for use in new websites.

User must explicitly enable this feature.'

User must explicitly enable this feature.

See also

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

CanvasRenderingContext2D.clearHitRegions() by Mozilla Contributors is licensed under CC-BY-SA 2.5.