CanvasRenderingContext2D.removeHitRegion

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 DOMString representing the id of 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

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.clearHitRegions()