Web/API/CanvasRenderingContext2D/removeHitRegion

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 removeHitRegion() removes a given hit region from the canvas.

Syntax

void ctx.removeHitRegion(id);

Parameters

id

A DOMString representing the id of the region that is to be removed.

Examples

Using the removeHitRegion method

This example demonstrates the removeHitRegion() method.

HTML

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

JavaScript

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

// Set a hit region 
ctx.addHitRegion({id: 'eyes'});

// Remove it from the canvas
ctx.removeHitRegion('eyes');

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
removeHitRegion 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. No support 12 — 79	Firefox Full support 30 Disabled' Full support 30 Disabled' Disabled' From version 30: this feature is behind the canvas.hitregions.enabled preference. To change preferences in Firefox, visit about:config.	IE Full support Yes	Opera Full support Yes	Safari Full support Yes	WebView Android No support No	Chrome Android No support No	Firefox Android Full support 30 Disabled' Full support 30 Disabled' Disabled' From version 30: this feature is behind the canvas.hitregions.enabled preference. To change preferences in Firefox, visit about:config.	Opera Android Full support Yes	Safari iOS Full support Yes	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.clearHitRegions() '

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