nx.js
Classes

OffscreenCanvas

See

https://developer.mozilla.org/docs/Web/API/OffscreenCanvas

Extends

Implements

Constructors

new OffscreenCanvas()

new OffscreenCanvas(width, height): OffscreenCanvas

Parameters

ParameterTypeDescription
widthnumberThe width of the offscreen canvas.
heightnumberThe height of the offscreen canvas.

Returns

OffscreenCanvas

Overrides

EventTarget.constructor

Properties

PropertyTypeDefault valueDescription
heightnumberundefinedSpecifies the height (in pixels) of the canvas. See https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/height
oncontextlostnullnull-
oncontextrestorednullnull-
widthnumberundefinedSpecifies the width (in pixels) of the canvas. See https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/height

Methods

addEventListener()

addEventListener(type, callback, options?): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

Parameters

ParameterType
typestring
callbacknull | EventListenerOrEventListenerObject<any>
options?boolean | AddEventListenerOptions

Returns

void

Implementation of

Omit.addEventListener

Inherited from

EventTarget.addEventListener

See

https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener


convertToBlob()

convertToBlob(options?): Promise<Blob>

Parameters

ParameterType
options?ImageEncodeOptions

Returns

Promise<Blob>

Implementation of

Omit.convertToBlob


dispatchEvent()

dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters

ParameterType
eventEvent

Returns

boolean

Implementation of

Omit.dispatchEvent

Inherited from

EventTarget.dispatchEvent

See

https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent


getContext()

getContext(contextId, options?): OffscreenCanvasRenderingContext2D

Parameters

ParameterType
contextId"2d"
options?any

Returns

OffscreenCanvasRenderingContext2D


removeEventListener()

removeEventListener(type, callback, options?): void

Removes the event listener in target's event listener list with the same type, callback, and options.

Parameters

ParameterType
typestring
callbacknull | EventListenerOrEventListenerObject<any>
options?boolean | EventListenerOptions

Returns

void

Implementation of

Omit.removeEventListener

Inherited from

EventTarget.removeEventListener

See

https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener


transferToImageBitmap()

transferToImageBitmap(): ImageBitmap

Returns

ImageBitmap

Implementation of

Omit.transferToImageBitmap

On this page