This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The CanvasRenderingContext2D.removeHitRegion() method of the Canvas 2D API removes a given hit region from the canvas.
Syntax
void ctx.removeHitRegion(id);
Parameters
- id
- A
DOMStringrepresenting theidof the region that is to be removed.
Examples
Using the removeHitRegion method
This is just a simple code snippet which uses the removeHitRegion method.
HTML
<canvas id="canvas"></canvas>
JavaScript
var canvas = document.getElementById('canvas');
var ctx = canvas.getContext('2d');
// set a hit region
ctx.addHitRegion({id: 'eyes'});
// remove it from the canvas
ctx.removeHitRegion('eyes');
Specifications
| Specification | Status | Comment |
|---|---|---|
| WHATWG HTML Living Standard The definition of 'CanvasRenderingContext2D.removeHitRegion' in that specification. |
Living Standard |
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|
| Basic support | (Yes) [1] | 30 (30) [2] | No support | No support | No support |
| Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | No support | No support | 30 (30) [2] | No support | No support | No support |
[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.