HTMLCanvasElement

Values

addEventListener

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. Read more on MDN

let addEventListener: (
  DomTypes.htmlCanvasElement,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.addEventListenerOptions=?,
) => unit

Parameters

DomTypes.htmlCanvasElement EventTypes.eventType EventTypes.eventListener option< EventTypes.addEventListenerOptions >

Return type

unit

addEventListenerWithCapture

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. Read more on MDN

let addEventListenerWithCapture: (
  DomTypes.htmlCanvasElement,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

DomTypes.htmlCanvasElement EventTypes.eventType EventTypes.eventListener

Return type

unit

after

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let after: (DomTypes.htmlCanvasElement, DomTypes.node) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

unit

after2

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let after2: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

animate

Read more on MDN

let animate: (
  DomTypes.htmlCanvasElement,
  ~keyframes: unknown,
  ~options: float=?,
) => DomTypes.animation

Parameters

DomTypes.htmlCanvasElement unknown option< float >

Return type

DomTypes.animation

animate2

Read more on MDN

let animate2: (
  DomTypes.htmlCanvasElement,
  ~keyframes: unknown,
  ~options: DomTypes.keyframeAnimationOptions=?,
) => DomTypes.animation

Parameters

DomTypes.htmlCanvasElement unknown option< DomTypes.keyframeAnimationOptions >

Return type

DomTypes.animation

append

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let append: (DomTypes.htmlCanvasElement, DomTypes.node) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

unit

append2

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let append2: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

appendChild

Read more on MDN

let appendChild: (DomTypes.htmlCanvasElement, 't) => 't

asElement

let asElement: DomTypes.htmlCanvasElement => DomTypes.element

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.element

asEventTarget

let asEventTarget: DomTypes.htmlCanvasElement => EventTypes.eventTarget

Parameters

DomTypes.htmlCanvasElement

Return type

EventTypes.eventTarget

asHTMLElement

let asHTMLElement: DomTypes.htmlCanvasElement => HTMLElement.t

Parameters

DomTypes.htmlCanvasElement

Return type

HTMLElement.t

asNode

let asNode: DomTypes.htmlCanvasElement => DomTypes.node

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.node

attachInternals

Read more on MDN

let attachInternals: DomTypes.htmlCanvasElement => DomTypes.elementInternals

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.elementInternals

attachShadow

Creates a shadow root for element and returns it. Read more on MDN

let attachShadow: (
  DomTypes.htmlCanvasElement,
  DomTypes.shadowRootInit,
) => DomTypes.shadowRoot

Parameters

DomTypes.htmlCanvasElement DomTypes.shadowRootInit

Return type

DomTypes.shadowRoot

before

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let before: (DomTypes.htmlCanvasElement, DomTypes.node) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

unit

before2

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let before2: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

blur

Read more on MDN

let blur: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

captureStream

Read more on MDN

let captureStream: (
  DomTypes.htmlCanvasElement,
  ~frameRequestRate: float=?,
) => MediaCaptureAndStreamsTypes.mediaStream

Parameters

DomTypes.htmlCanvasElement option< float >

Return type

MediaCaptureAndStreamsTypes.mediaStream

checkVisibility

Read more on MDN

let checkVisibility: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.checkVisibilityOptions=?,
) => bool

Parameters

DomTypes.htmlCanvasElement option< DomTypes.checkVisibilityOptions >

Return type

bool

click

Read more on MDN

let click: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

cloneNode

Returns a copy of node. If deep is true, the copy also includes the node's descendants. Read more on MDN

let cloneNode: (
  DomTypes.htmlCanvasElement,
  ~deep: bool=?,
) => DomTypes.htmlCanvasElement

Parameters

DomTypes.htmlCanvasElement option< bool >

Return type

DomTypes.htmlCanvasElement

closest

Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. Read more on MDN

let closest: (DomTypes.htmlCanvasElement, string) => 'e

Parameters

DomTypes.htmlCanvasElement

Return type

string

compareDocumentPosition

Returns a bitmask indicating the position of other relative to node. Read more on MDN

let compareDocumentPosition: (DomTypes.htmlCanvasElement, DomTypes.node) => int

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

int

computedStyleMap

Read more on MDN

let computedStyleMap: DomTypes.htmlCanvasElement => DomTypes.stylePropertyMapReadOnly

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.stylePropertyMapReadOnly

contains

Returns true if other is an inclusive descendant of node, and false otherwise. Read more on MDN

let contains: (DomTypes.htmlCanvasElement, DomTypes.node) => bool

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

bool

dispatchEvent

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. Read more on MDN

let dispatchEvent: (DomTypes.htmlCanvasElement, EventTypes.event) => bool

Parameters

DomTypes.htmlCanvasElement EventTypes.event

Return type

bool

focus

Read more on MDN

let focus: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.focusOptions=?,
) => unit

Parameters

DomTypes.htmlCanvasElement option< DomTypes.focusOptions >

Return type

unit

getAnimations

Read more on MDN

let getAnimations: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.getAnimationsOptions=?,
) => array<DomTypes.animation>

Parameters

DomTypes.htmlCanvasElement option< DomTypes.getAnimationsOptions >

Return type

array< DomTypes.animation >

getAttribute

Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. Read more on MDN

let getAttribute: (DomTypes.htmlCanvasElement, string) => null<string>

Parameters

DomTypes.htmlCanvasElement string

Return type

Stdlib.null< string >

getAttributeNames

Returns the qualified names of all element's attributes. Can contain duplicates. Read more on MDN

let getAttributeNames: DomTypes.htmlCanvasElement => array<string>

Parameters

DomTypes.htmlCanvasElement

Return type

array< string >

getAttributeNode

Read more on MDN

let getAttributeNode: (DomTypes.htmlCanvasElement, string) => DomTypes.attr

Parameters

DomTypes.htmlCanvasElement string

Return type

DomTypes.attr

getAttributeNodeNS

Read more on MDN

let getAttributeNodeNS: (
  DomTypes.htmlCanvasElement,
  ~namespace: string,
  ~localName: string,
) => DomTypes.attr

Parameters

DomTypes.htmlCanvasElement string string

Return type

DomTypes.attr

getAttributeNS

Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. Read more on MDN

let getAttributeNS: (
  DomTypes.htmlCanvasElement,
  ~namespace: string,
  ~localName: string,
) => string

Parameters

DomTypes.htmlCanvasElement string string

Return type

string

getBoundingClientRect

Read more on MDN

let getBoundingClientRect: DomTypes.htmlCanvasElement => DomTypes.domRect

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.domRect

getClientRects

Read more on MDN

let getClientRects: DomTypes.htmlCanvasElement => DomTypes.domRectList

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.domRectList

getContext2D

Returns an object that provides methods and properties for drawing and manipulating images and graphics on a canvas element in a document. A context object includes information about colors, line widths, fonts, and other graphic parameters that can be drawn on a canvas. Creates a CanvasRenderingContext2D object representing a two-dimensional rendering context.

Read more on MDN

let getContext2D: (
  DomTypes.htmlCanvasElement,
  ~options: CanvasTypes.canvasRenderingContext2DSettings=?,
) => DomTypes.canvasRenderingContext2D

Parameters

DomTypes.htmlCanvasElement option< CanvasTypes.canvasRenderingContext2DSettings >

Return type

DomTypes.canvasRenderingContext2D

getContextBitmapRenderer

Returns an object that provides methods and properties for drawing and manipulating images and graphics on a canvas element in a document. A context object includes information about colors, line widths, fonts, and other graphic parameters that can be drawn on a canvas. @param contextId The identifier (ID) of the type of canvas to create. Internet Explorer 9 and Internet Explorer 10 support only a 2-D context using canvas.getContext("2d"); IE11 Preview also supports 3-D or WebGL context using canvas.getContext("experimental-webgl"); Read more on MDN

let getContextBitmapRenderer: (
  DomTypes.htmlCanvasElement,
  ~options: CanvasTypes.imageBitmapRenderingContextSettings=?,
) => CanvasTypes.imageBitmapRenderingContext

Parameters

DomTypes.htmlCanvasElement option< CanvasTypes.imageBitmapRenderingContextSettings >

Return type

CanvasTypes.imageBitmapRenderingContext

getContextWebGL

Returns an object that provides methods and properties for drawing and manipulating images and graphics on a canvas element in a document. A context object includes information about colors, line widths, fonts, and other graphic parameters that can be drawn on a canvas. @param contextId The identifier (ID) of the type of canvas to create. Internet Explorer 9 and Internet Explorer 10 support only a 2-D context using canvas.getContext("2d"); IE11 Preview also supports 3-D or WebGL context using canvas.getContext("experimental-webgl"); Read more on MDN

let getContextWebGL: (
  DomTypes.htmlCanvasElement,
  ~options: CanvasTypes.webGLContextAttributes=?,
) => CanvasTypes.webGLRenderingContext

Parameters

DomTypes.htmlCanvasElement option< CanvasTypes.webGLContextAttributes >

Return type

CanvasTypes.webGLRenderingContext

getContextWebGL2

Returns an object that provides methods and properties for drawing and manipulating images and graphics on a canvas element in a document. A context object includes information about colors, line widths, fonts, and other graphic parameters that can be drawn on a canvas. @param contextId The identifier (ID) of the type of canvas to create. Internet Explorer 9 and Internet Explorer 10 support only a 2-D context using canvas.getContext("2d"); IE11 Preview also supports 3-D or WebGL context using canvas.getContext("experimental-webgl"); Read more on MDN

let getContextWebGL2: (
  DomTypes.htmlCanvasElement,
  ~options: CanvasTypes.webGLContextAttributes=?,
) => CanvasTypes.webGL2RenderingContext

Parameters

DomTypes.htmlCanvasElement option< CanvasTypes.webGLContextAttributes >

Return type

CanvasTypes.webGL2RenderingContext

getElementsByClassName

Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes. Read more on MDN

let getElementsByClassName: (
  DomTypes.htmlCanvasElement,
  string,
) => DomTypes.htmlCollection<DomTypes.element>

Parameters

DomTypes.htmlCanvasElement string

Return type

DomTypes.htmlCollection< DomTypes.element >

getElementsByTagName

Read more on MDN

let getElementsByTagName: (
  DomTypes.htmlCanvasElement,
  string,
) => DomTypes.htmlCollection<DomTypes.element>

Parameters

DomTypes.htmlCanvasElement string

Return type

DomTypes.htmlCollection< DomTypes.element >

getElementsByTagNameNS

Read more on MDN

let getElementsByTagNameNS: (
  DomTypes.element,
  ~namespace: string,
  ~localName: string,
) => DomTypes.htmlCollection<DomTypes.element>

Parameters

DomTypes.element string string

Return type

DomTypes.htmlCollection< DomTypes.element >

getHTML

Read more on MDN

let getHTML: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.getHTMLOptions=?,
) => string

Parameters

DomTypes.htmlCanvasElement option< DomTypes.getHTMLOptions >

Return type

string

getRootNode

Returns node's root. Read more on MDN

let getRootNode: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.getRootNodeOptions=?,
) => DomTypes.node

Parameters

DomTypes.htmlCanvasElement option< DomTypes.getRootNodeOptions >

Return type

DomTypes.node

hasAttribute

Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. Read more on MDN

let hasAttribute: (DomTypes.htmlCanvasElement, string) => bool

Parameters

DomTypes.htmlCanvasElement string

Return type

bool

hasAttributeNS

Returns true if element has an attribute whose namespace is namespace and local name is localName. Read more on MDN

let hasAttributeNS: (
  DomTypes.htmlCanvasElement,
  ~namespace: string,
  ~localName: string,
) => bool

Parameters

DomTypes.htmlCanvasElement string string

Return type

bool

hasAttributes

Returns true if element has attributes, and false otherwise. Read more on MDN

let hasAttributes: DomTypes.htmlCanvasElement => bool

Parameters

DomTypes.htmlCanvasElement

Return type

bool

hasChildNodes

Returns whether node has children. Read more on MDN

let hasChildNodes: DomTypes.htmlCanvasElement => bool

Parameters

DomTypes.htmlCanvasElement

Return type

bool

hasPointerCapture

Read more on MDN

let hasPointerCapture: (DomTypes.htmlCanvasElement, int) => bool

Parameters

DomTypes.htmlCanvasElement int

Return type

bool

hidePopover

Read more on MDN

let hidePopover: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

insertAdjacentElement

Read more on MDN

let insertAdjacentElement: (
  DomTypes.htmlCanvasElement,
  ~where: DomTypes.insertPosition,
  ~element: DomTypes.element,
) => DomTypes.element

Parameters

DomTypes.htmlCanvasElement DomTypes.insertPosition DomTypes.element

Return type

DomTypes.element

insertAdjacentHTML

Read more on MDN

let insertAdjacentHTML: (
  DomTypes.htmlCanvasElement,
  ~position: DomTypes.insertPosition,
  ~string: string,
) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.insertPosition string

Return type

unit

insertAdjacentText

Read more on MDN

let insertAdjacentText: (
  DomTypes.htmlCanvasElement,
  ~where: DomTypes.insertPosition,
  ~data: string,
) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.insertPosition string

Return type

unit

insertBefore

Read more on MDN

let insertBefore: (
  DomTypes.htmlCanvasElement,
  't,
  ~child: DomTypes.node,
) => 't

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.node

isDefaultNamespace

Read more on MDN

let isDefaultNamespace: (DomTypes.htmlCanvasElement, string) => bool

Parameters

DomTypes.htmlCanvasElement string

Return type

bool

isEqualNode

Returns whether node and otherNode have the same properties. Read more on MDN

let isEqualNode: (DomTypes.htmlCanvasElement, DomTypes.node) => bool

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

bool

isSameNode

Read more on MDN

let isSameNode: (DomTypes.htmlCanvasElement, DomTypes.node) => bool

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

bool

lookupNamespaceURI

Read more on MDN

let lookupNamespaceURI: (DomTypes.htmlCanvasElement, string) => string

Parameters

DomTypes.htmlCanvasElement string

Return type

string

lookupPrefix

Read more on MDN

let lookupPrefix: (DomTypes.htmlCanvasElement, string) => string

Parameters

DomTypes.htmlCanvasElement string

Return type

string

matches

Returns true if matching selectors against element's root yields element, and false otherwise. Read more on MDN

let matches: (DomTypes.htmlCanvasElement, string) => bool

Parameters

DomTypes.htmlCanvasElement string

Return type

bool

normalize

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. Read more on MDN

let normalize: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

prepend

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let prepend: (DomTypes.htmlCanvasElement, DomTypes.node) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

unit

prepend2

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let prepend2: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

querySelector

Returns the first element that is a descendant of node that matches selectors. Read more on MDN

let querySelector: (
  DomTypes.htmlCanvasElement,
  string,
) => Null.t<DomTypes.element>

Parameters

DomTypes.htmlCanvasElement string

Return type

Stdlib.Null.t< DomTypes.element >

querySelectorAll

Returns all element descendants of node that match selectors. Read more on MDN

let querySelectorAll: (
  DomTypes.htmlCanvasElement,
  string,
) => DomTypes.nodeList<DomTypes.element>

Parameters

DomTypes.htmlCanvasElement string

Return type

DomTypes.nodeList< DomTypes.element >

releasePointerCapture

Read more on MDN

let releasePointerCapture: (DomTypes.htmlCanvasElement, int) => unit

Parameters

DomTypes.htmlCanvasElement int

Return type

unit

remove

Removes node. Read more on MDN

let remove: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

removeAttribute

Removes element's first attribute whose qualified name is qualifiedName. Read more on MDN

let removeAttribute: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

removeAttributeNode

Read more on MDN

let removeAttributeNode: (DomTypes.htmlCanvasElement, DomTypes.attr) => DomTypes.attr

Parameters

DomTypes.htmlCanvasElement DomTypes.attr

Return type

DomTypes.attr

removeAttributeNS

Removes element's attribute whose namespace is namespace and local name is localName. Read more on MDN

let removeAttributeNS: (
  DomTypes.htmlCanvasElement,
  ~namespace: string,
  ~localName: string,
) => unit

Parameters

DomTypes.htmlCanvasElement string string

Return type

unit

removeChild

Read more on MDN

let removeChild: (DomTypes.htmlCanvasElement, 't) => 't

removeEventListener

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

let removeEventListener: (
  DomTypes.htmlCanvasElement,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.eventListenerOptions=?,
) => unit

Parameters

DomTypes.htmlCanvasElement EventTypes.eventType EventTypes.eventListener option< EventTypes.eventListenerOptions >

Return type

unit

removeEventListenerUseCapture

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

let removeEventListenerUseCapture: (
  DomTypes.htmlCanvasElement,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

DomTypes.htmlCanvasElement EventTypes.eventType EventTypes.eventListener

Return type

unit

replaceChild

Read more on MDN

let replaceChild: (DomTypes.htmlCanvasElement, ~node: DomTypes.node, 't) => 't

Parameters

DomTypes.htmlCanvasElement

Return type

DomTypes.node

replaceChildren

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let replaceChildren: (DomTypes.htmlCanvasElement, DomTypes.node) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

unit

replaceChildren2

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let replaceChildren2: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

replaceWith

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let replaceWith: (DomTypes.htmlCanvasElement, DomTypes.node) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.node

Return type

unit

replaceWith2

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let replaceWith2: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

requestFullscreen

Displays element fullscreen and resolves promise when done.

When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference. Read more on MDN

let requestFullscreen: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.fullscreenOptions=?,
) => promise<unit>

Parameters

DomTypes.htmlCanvasElement option< DomTypes.fullscreenOptions >

Return type

promise< unit >

requestPointerLock

Read more on MDN

let requestPointerLock: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.pointerLockOptions=?,
) => promise<unit>

Parameters

DomTypes.htmlCanvasElement option< DomTypes.pointerLockOptions >

Return type

promise< unit >

scroll

Read more on MDN

let scroll: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.scrollToOptions=?,
) => unit

Parameters

DomTypes.htmlCanvasElement option< DomTypes.scrollToOptions >

Return type

unit

scroll2

Read more on MDN

let scroll2: (DomTypes.htmlCanvasElement, ~x: float, ~y: float) => unit

Parameters

DomTypes.htmlCanvasElement float float

Return type

unit

scrollBy

Read more on MDN

let scrollBy: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.scrollToOptions=?,
) => unit

Parameters

DomTypes.htmlCanvasElement option< DomTypes.scrollToOptions >

Return type

unit

scrollBy2

Read more on MDN

let scrollBy2: (DomTypes.htmlCanvasElement, ~x: float, ~y: float) => unit

Parameters

DomTypes.htmlCanvasElement float float

Return type

unit

scrollIntoView

scrollIntoView()

Scrolls the element's ancestor containers such that the element on which scrollIntoView() is called is visible to the user.

element->Element.scrollIntoView()

Read more on MDN

let scrollIntoView: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

scrollIntoViewAlignToTop

scrollIntoView(true)

Scrolls the element's ancestor containers such that the element on which scrollIntoView() is called is visible to the user.

element->Element.scrollIntoView_alignToTop()

Read more on MDN

let scrollIntoViewAlignToTop: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

scrollIntoViewWithOptions

scrollIntoView({ behavior: "smooth" })

Scrolls the element's ancestor containers such that the element on which scrollIntoView() is called is visible to the user.

element->Element.scrollIntoViewWithOptions({ behavior: DOMAPI.Smooth })

Read more on MDN

let scrollIntoViewWithOptions: (
  DomTypes.htmlCanvasElement,
  DomTypes.scrollIntoViewOptions,
) => unit

Parameters

DomTypes.htmlCanvasElement DomTypes.scrollIntoViewOptions

Return type

unit

scrollTo

Read more on MDN

let scrollTo: (
  DomTypes.htmlCanvasElement,
  ~options: DomTypes.scrollToOptions=?,
) => unit

Parameters

DomTypes.htmlCanvasElement option< DomTypes.scrollToOptions >

Return type

unit

scrollTo2

Read more on MDN

let scrollTo2: (DomTypes.htmlCanvasElement, ~x: float, ~y: float) => unit

Parameters

DomTypes.htmlCanvasElement float float

Return type

unit

setAttribute

Sets the value of element's first attribute whose qualified name is qualifiedName to value. Read more on MDN

let setAttribute: (
  DomTypes.htmlCanvasElement,
  ~qualifiedName: string,
  ~value: string,
) => unit

Parameters

DomTypes.htmlCanvasElement string string

Return type

unit

setAttributeNode

Read more on MDN

let setAttributeNode: (DomTypes.htmlCanvasElement, DomTypes.attr) => DomTypes.attr

Parameters

DomTypes.htmlCanvasElement DomTypes.attr

Return type

DomTypes.attr

setAttributeNodeNS

Read more on MDN

let setAttributeNodeNS: (DomTypes.htmlCanvasElement, DomTypes.attr) => DomTypes.attr

Parameters

DomTypes.htmlCanvasElement DomTypes.attr

Return type

DomTypes.attr

setAttributeNS

Sets the value of element's attribute whose namespace is namespace and local name is localName to value. Read more on MDN

let setAttributeNS: (
  DomTypes.element,
  ~namespace: string,
  ~qualifiedName: string,
  ~value: string,
) => unit

Parameters

DomTypes.element string string string

Return type

unit

setHTMLUnsafe

Read more on MDN

let setHTMLUnsafe: (DomTypes.htmlCanvasElement, string) => unit

Parameters

DomTypes.htmlCanvasElement string

Return type

unit

setPointerCapture

Read more on MDN

let setPointerCapture: (DomTypes.htmlCanvasElement, int) => unit

Parameters

DomTypes.htmlCanvasElement int

Return type

unit

showPopover

Read more on MDN

let showPopover: DomTypes.htmlCanvasElement => unit

Parameters

DomTypes.htmlCanvasElement

Return type

unit

toBlob

Read more on MDN

let toBlob: (
  DomTypes.htmlCanvasElement,
  ~callback: FileTypes.blob => unit,
  ~type_: string=?,
  ~quality: JSON.t=?,
) => unit

Parameters

DomTypes.htmlCanvasElement FileTypes.blob unit option< string > option< Stdlib.JSON.t >

Return type

unit

toDataURL

Returns the content of the current canvas as an image that you can use as a source for another canvas or an HTML element. @param type The standard MIME type for the image format to return. If you do not specify this parameter, the default value is a PNG format image. Read more on MDN

let toDataURL: (
  DomTypes.htmlCanvasElement,
  ~type_: string=?,
  ~quality: JSON.t=?,
) => string

Parameters

DomTypes.htmlCanvasElement option< string > option< Stdlib.JSON.t >

Return type

string

toggleAttribute

If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

Returns true if qualifiedName is now present, and false otherwise. Read more on MDN

let toggleAttribute: (
  DomTypes.htmlCanvasElement,
  ~qualifiedName: string,
  ~force: bool=?,
) => bool

Parameters

DomTypes.htmlCanvasElement string option< bool >

Return type

bool

togglePopover

Read more on MDN

let togglePopover: (DomTypes.htmlCanvasElement, ~force: bool=?) => bool

Parameters

DomTypes.htmlCanvasElement option< bool >

Return type

bool

transferControlToOffscreen

Read more on MDN

let transferControlToOffscreen: DomTypes.htmlCanvasElement => CanvasTypes.offscreenCanvas

Parameters

DomTypes.htmlCanvasElement

Return type

CanvasTypes.offscreenCanvas