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 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');

Browser compatibilityUpdate compatibility data on GitHub

See also

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