CanvasRenderingContext2D.removeHitRegion()

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

See also

• CanvasRenderingContext2D.addHitRegion()
• CanvasRenderingContext2D.clearHitRegions()