XRHitTestSource: cancel() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The cancel() method of the XRHitTestSource interface unsubscribes a hit test.

Syntax

js
cancel()

Parameters

None.

Return value

None (undefined).

Examples

Unsubscribe from hit test

The cancel() method unsubscribes from a hit test source. Since the XRHitTestSource object will no longer be usable, you can clean up and set it to null.

js
hitTestSource.cancel();
hitTestSource = null;

Specifications

Specification
WebXR Hit Test Module
# dom-xrhittestsource-cancel

Browser compatibility

BCD tables only load in the browser