Class TwistyPlayer

TwistyPlayer is the heart of cubing.js. It can be used to display a puzzle on a web page like this:

<script src="path/to/cubing/twisty" type="module"></script>
<twisty-player alg="R U R'"></twisty-player>

You can also construct it directly in JavaScript:

import { TwistyPlayer } from "cubing/twisty";
const twistyPlayer = new TwistyPlayer({alg: "R U R'"});
// Once the page has loaded, you can do this:
document.body.appendChild(twistyPlayer);

See https://js.cubing.net/cubing/ for more examples.

Hierarchy

TwistyPlayerSettable
- TwistyPlayer

Implements

TwistyAnimationControllerDelegate

Index

Constructors

constructor

new TwistyPlayer(config?): TwistyPlayer
Parameters
- config: TwistyPlayerConfig = {}
Returns TwistyPlayer
Overrides TwistyPlayerSettable.constructor
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:207

Properties

accessKey

accessKey: string

MDN Reference

`Readonly`accessKeyLabel

accessKeyLabel: string

MDN Reference

ariaAtomic

ariaAtomic: null | string

MDN Reference

ariaAutoComplete

ariaAutoComplete: null | string

MDN Reference

ariaBrailleLabel

ariaBrailleLabel: null | string

MDN Reference

ariaBrailleRoleDescription

ariaBrailleRoleDescription: null | string

MDN Reference

ariaBusy

ariaBusy: null | string

MDN Reference

ariaChecked

ariaChecked: null | string

MDN Reference

ariaColCount

ariaColCount: null | string

MDN Reference

ariaColIndex

ariaColIndex: null | string

MDN Reference

ariaColSpan

ariaColSpan: null | string

MDN Reference

ariaCurrent

ariaCurrent: null | string

MDN Reference

ariaDescription

ariaDescription: null | string

MDN Reference

ariaDisabled

ariaDisabled: null | string

MDN Reference

ariaExpanded

ariaExpanded: null | string

MDN Reference

ariaHasPopup

ariaHasPopup: null | string

MDN Reference

ariaHidden

ariaHidden: null | string

MDN Reference

ariaInvalid

ariaInvalid: null | string

ariaKeyShortcuts

ariaKeyShortcuts: null | string

MDN Reference

ariaLabel

ariaLabel: null | string

MDN Reference

ariaLevel

ariaLevel: null | string

MDN Reference

ariaLive

ariaLive: null | string

MDN Reference

ariaModal

ariaModal: null | string

MDN Reference

ariaMultiLine

ariaMultiLine: null | string

MDN Reference

ariaMultiSelectable

ariaMultiSelectable: null | string

MDN Reference

ariaOrientation

ariaOrientation: null | string

MDN Reference

ariaPlaceholder

ariaPlaceholder: null | string

MDN Reference

ariaPosInSet

ariaPosInSet: null | string

MDN Reference

ariaPressed

ariaPressed: null | string

MDN Reference

ariaReadOnly

ariaReadOnly: null | string

MDN Reference

ariaRequired

ariaRequired: null | string

MDN Reference

ariaRoleDescription

ariaRoleDescription: null | string

MDN Reference

ariaRowCount

ariaRowCount: null | string

MDN Reference

ariaRowIndex

ariaRowIndex: null | string

MDN Reference

ariaRowSpan

ariaRowSpan: null | string

MDN Reference

ariaSelected

ariaSelected: null | string

MDN Reference

ariaSetSize

ariaSetSize: null | string

MDN Reference

ariaSort

ariaSort: null | string

MDN Reference

ariaValueMax

ariaValueMax: null | string

MDN Reference

ariaValueMin

ariaValueMin: null | string

MDN Reference

ariaValueNow

ariaValueNow: null | string

MDN Reference

ariaValueText

ariaValueText: null | string

MDN Reference

`Readonly`assignedSlot

assignedSlot: null | HTMLSlotElement

MDN Reference

`Readonly`ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

`Readonly`attributes

attributes: NamedNodeMap

MDN Reference

`Readonly`attributeStyleMap

attributeStyleMap: StylePropertyMap

MDN Reference

autocapitalize

autocapitalize: string

MDN Reference

autofocus

autofocus: boolean

MDN Reference

`Readonly`baseURI

baseURI: string

Returns node's node document's document base URL.

MDN Reference

buttons

buttons: TwistyButtons

`Readonly`CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

`Readonly`childElementCount

childElementCount: number

MDN Reference

`Readonly`childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

`Readonly`children

children: HTMLCollection

Returns the child elements.

MDN Reference

`Readonly`classList

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

MDN Reference

className

className: string

Returns the value of element's class content attribute. Can be set to change it.

MDN Reference

`Readonly`clientHeight

clientHeight: number

MDN Reference

`Readonly`clientLeft

clientLeft: number

MDN Reference

`Readonly`clientTop

clientTop: number

MDN Reference

`Readonly`clientWidth

clientWidth: number

MDN Reference

`Readonly`COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

contentEditable

contentEditable: string

MDN Reference

`Readonly`contentWrapper

contentWrapper: HTMLDivElement

controller

controller: TwistyPlayerController = ...

`Readonly`dataset

dataset: DOMStringMap

MDN Reference

dir

dir: string

MDN Reference

`Readonly`DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

`Readonly`DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

`Readonly`DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

`Readonly`DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

Set when node and other are not in the same tree.

`Readonly`DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

`Readonly`DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

`Readonly`DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

draggable

draggable: boolean

MDN Reference

`Readonly`ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

enterKeyHint

enterKeyHint: string

MDN Reference

`Readonly`ENTITY_NODE

ENTITY_NODE: 6

`Readonly`ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

experimentalCanvasClickCallback

experimentalCanvasClickCallback: ((...args: any) => void) = ...

experimentalGet

experimentalGet: ExperimentalGetters = ...

experimentalModel

experimentalModel: TwistyPlayerModel = ...

`Readonly`firstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

`Readonly`firstElementChild

firstElementChild: null | Element

Returns the first child that is an element, and null otherwise.

MDN Reference

hidden

hidden: boolean

MDN Reference

id

id: string

Returns the value of element's id content attribute. Can be set to change it.

MDN Reference

inert

inert: boolean

MDN Reference

innerHTML

innerHTML: string

MDN Reference

innerText

innerText: string

MDN Reference

inputMode

inputMode: string

MDN Reference

`Readonly`isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

`Readonly`isContentEditable

isContentEditable: boolean

MDN Reference

lang

lang: string

MDN Reference

`Readonly`lastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

`Readonly`lastElementChild

lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

MDN Reference

`Readonly`localName

localName: string

Returns the local name.

MDN Reference

`Readonly`namespaceURI

namespaceURI: null | string

Returns the namespace.

MDN Reference

`Readonly`nextElementSibling

nextElementSibling: null | Element

Returns the first following sibling that is an element, and null otherwise.

MDN Reference

`Readonly`nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

`Readonly`nodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

`Readonly`nodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

`Optional`nonce

nonce?: string

MDN Reference

`Readonly`NOTATION_NODE

NOTATION_NODE: 12

`Readonly`offsetHeight

offsetHeight: number

MDN Reference

`Readonly`offsetLeft

offsetLeft: number

MDN Reference

`Readonly`offsetParent

offsetParent: null | Element

MDN Reference

`Readonly`offsetTop

offsetTop: number

MDN Reference

`Readonly`offsetWidth

offsetWidth: number

MDN Reference

onabort

onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)

Fires when the user aborts the download.

Param: ev

The event.

MDN Reference

onanimationcancel

onanimationcancel: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)

MDN Reference

onanimationend

onanimationend: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)

MDN Reference

onanimationiteration

onanimationiteration: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)

MDN Reference

onanimationstart

onanimationstart: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)

MDN Reference

onauxclick

onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

MDN Reference

onbeforeinput

onbeforeinput: null | ((this: GlobalEventHandlers, ev: InputEvent) => any)

MDN Reference

onbeforetoggle

onbeforetoggle: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

onbeforexrselect

onbeforexrselect: null | ((this: GlobalEventHandlers, ev: XRSessionEvent) => any)

An XRSessionEvent of type beforexrselect is dispatched on the DOM overlay element before generating a WebXR selectstart input event if the -Z axis of the input source's targetRaySpace intersects the DOM overlay element at the time the input device's primary action is triggered.

onblur

onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object loses the input focus.

Param: ev

The focus event.

MDN Reference

oncancel

oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

oncanplay

oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is possible, but would require further buffering.

Param: ev

The event.

MDN Reference

oncanplaythrough

oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

onchange

onchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the contents of the object or selection have changed.

Param: ev

The event.

MDN Reference

onclick

onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the left mouse button on the object

Param: ev

The mouse event.

MDN Reference

onclose

onclose: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

oncontextlost

oncontextlost: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

oncontextmenu

oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Param: ev

The mouse event.

MDN Reference

oncontextrestored

oncontextrestored: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

oncopy

oncopy: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)

MDN Reference

oncuechange

oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

oncut

oncut: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)

MDN Reference

ondblclick

ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user double-clicks the object.

Param: ev

The mouse event.

MDN Reference

ondrag

ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object continuously during a drag operation.

Param: ev

The event.

MDN Reference

ondragend

ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user releases the mouse at the close of a drag operation.

Param: ev

The event.

MDN Reference

ondragenter

ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element when the user drags the object to a valid drop target.

Param: ev

The drag event.

MDN Reference

ondragleave

ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

Param: ev

The drag event.

MDN Reference

ondragover

ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element continuously while the user drags the object over a valid drop target.

Param: ev

The event.

MDN Reference

ondragstart

ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user starts to drag a text selection or selected object.

Param: ev

The event.

MDN Reference

ondrop

ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

MDN Reference

ondurationchange

ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration attribute is updated.

Param: ev

The event.

MDN Reference

onemptied

onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the media element is reset to its initial state.

Param: ev

The event.

MDN Reference

onended

onended: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the end of playback is reached.

Param: ev

The event

MDN Reference

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

onfocus

onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object receives focus.

Param: ev

The event.

MDN Reference

onformdata

onformdata: null | ((this: GlobalEventHandlers, ev: FormDataEvent) => any)

MDN Reference

onfullscreenchange

onfullscreenchange: null | ((this: Element, ev: Event) => any)

MDN Reference

onfullscreenerror

onfullscreenerror: null | ((this: Element, ev: Event) => any)

MDN Reference

ongotpointercapture

ongotpointercapture: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

oninput

oninput: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

oninvalid

oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

onkeydown

onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses a key.

Param: ev

The keyboard event

MDN Reference

onkeypress

onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses an alphanumeric key.

Param: ev

The event.

Deprecated

MDN Reference

onkeyup

onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user releases a key.

Param: ev

The keyboard event

MDN Reference

onload

onload: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires immediately after the browser loads the object.

Param: ev

The event.

MDN Reference

onloadeddata

onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when media data is loaded at the current playback position.

Param: ev

The event.

MDN Reference

onloadedmetadata

onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration and dimensions of the media have been determined.

Param: ev

The event.

MDN Reference

onloadstart

onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when Internet Explorer begins looking for media data.

Param: ev

The event.

MDN Reference

onlostpointercapture

onlostpointercapture: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onmousedown

onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the object with either mouse button.

Param: ev

The mouse event.

MDN Reference

onmouseenter

onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

MDN Reference

onmouseleave

onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

MDN Reference

onmousemove

onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse over the object.

Param: ev

The mouse event.

MDN Reference

onmouseout

onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer outside the boundaries of the object.

Param: ev

The mouse event.

MDN Reference

onmouseover

onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer into the object.

Param: ev

The mouse event.

MDN Reference

onmouseup

onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user releases a mouse button while the mouse is over the object.

Param: ev

The mouse event.

MDN Reference

onpaste

onpaste: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)

MDN Reference

onpause

onpause: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is paused.

Param: ev

The event.

MDN Reference

onplay

onplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the play method is requested.

Param: ev

The event.

MDN Reference

onplaying

onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the audio or video has started playing.

Param: ev

The event.

MDN Reference

onpointercancel

onpointercancel: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onpointerdown

onpointerdown: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onpointerenter

onpointerenter: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onpointerleave

onpointerleave: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onpointermove

onpointermove: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onpointerout

onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onpointerover

onpointerover: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onpointerup

onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)

MDN Reference

onprogress

onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any)

Occurs to indicate progress while downloading media data.

Param: ev

The event.

MDN Reference

onratechange

onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the playback rate is increased or decreased.

Param: ev

The event.

MDN Reference

onreset

onreset: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user resets a form.

Param: ev

The event.

MDN Reference

onresize

onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)

MDN Reference

onscroll

onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user repositions the scroll box in the scroll bar on the object.

Param: ev

The event.

MDN Reference

onscrollend

onscrollend: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

onsecuritypolicyviolation

onsecuritypolicyviolation: null | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any)

MDN Reference

onseeked

onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the seek operation ends.

Param: ev

The event.

MDN Reference

onseeking

onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the current playback position is moved.

Param: ev

The event.

MDN Reference

onselect

onselect: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the current selection changes.

Param: ev

The event.

MDN Reference

onselectionchange

onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

onselectstart

onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

onslotchange

onslotchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

onstalled

onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the download has stopped.

Param: ev

The event.

MDN Reference

onsubmit

onsubmit: null | ((this: GlobalEventHandlers, ev: SubmitEvent) => any)

MDN Reference

onsuspend

onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs if the load operation has been intentionally halted.

Param: ev

The event.

MDN Reference

ontimeupdate

ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs to indicate the current playback position.

Param: ev

The event.

MDN Reference

ontoggle

ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any)

MDN Reference

`Optional`ontouchcancel

ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)

MDN Reference

`Optional`ontouchend

ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)

MDN Reference

`Optional`ontouchmove

ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)

MDN Reference

`Optional`ontouchstart

ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)

MDN Reference

ontransitioncancel

ontransitioncancel: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)

MDN Reference

ontransitionend

ontransitionend: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)

MDN Reference

ontransitionrun

ontransitionrun: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)

MDN Reference

ontransitionstart

ontransitionstart: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)

MDN Reference

onvolumechange

onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the volume is changed, or playback is muted or unmuted.

Param: ev

The event.

MDN Reference

onwaiting

onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback stops because the next frame of a video resource is not available.

Param: ev

The event.

MDN Reference

onwebkitanimationend

onwebkitanimationend: null | ((this: GlobalEventHandlers, ev: Event) => any)

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration

onwebkitanimationiteration: null | ((this: GlobalEventHandlers, ev: Event) => any)

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart

onwebkitanimationstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend

onwebkittransitionend: null | ((this: GlobalEventHandlers, ev: Event) => any)

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel

onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any)

MDN Reference

outerHTML

outerHTML: string

MDN Reference

outerText

outerText: string

MDN Reference

`Readonly`ownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

`Readonly`parentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

`Readonly`parentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

`Readonly`part

part: DOMTokenList

MDN Reference

popover

popover: null | string

MDN Reference

`Readonly`prefix

prefix: null | string

Returns the namespace prefix.

MDN Reference

`Readonly`previousElementSibling

previousElementSibling: null | Element

Returns the first preceding sibling that is an element, and null otherwise.

MDN Reference

`Readonly`previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

`Readonly`PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

role

role: null | string

`Readonly`scrollHeight

scrollHeight: number

MDN Reference

scrollLeft

scrollLeft: number

MDN Reference

scrollTop

scrollTop: number

MDN Reference

`Readonly`scrollWidth

scrollWidth: number

MDN Reference

`Readonly`shadow

shadow: ShadowRoot

`Readonly`shadowRoot

shadowRoot: null | ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

MDN Reference

slot

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

MDN Reference

spellcheck

spellcheck: boolean

MDN Reference

`Readonly`style

style: CSSStyleDeclaration

MDN Reference

tabIndex

tabIndex: number

MDN Reference

`Readonly`tagName

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

`Readonly`TEXT_NODE

TEXT_NODE: 3

node is a Text node.

textContent

textContent: null | string

MDN Reference

title

title: string

MDN Reference

translate

translate: boolean

MDN Reference

webkitRequestFullscreen

webkitRequestFullscreen: (() => Promise<void>)

Accessors

alg

get alg(): never
Returns never
Inherited from TwistyPlayerSettable.alg
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:35
set alg(newAlg): void
Parameters
- newAlg: string | Alg
Returns void
Inherited from TwistyPlayerSettable.alg
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:32

background

get background(): never
Returns never
Inherited from TwistyPlayerSettable.background
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:117
set background(backgroundTheme): void
Parameters
- backgroundTheme: BackgroundThemeWithAuto
Returns void
Inherited from TwistyPlayerSettable.background
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:114

backView

get backView(): never
Returns never
Inherited from TwistyPlayerSettable.backView
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:110
set backView(backView): void
Parameters
- backView: BackViewLayoutWithAuto
Returns void
Inherited from TwistyPlayerSettable.backView
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:107

cameraDistance

get cameraDistance(): never
Returns never
Inherited from TwistyPlayerSettable.cameraDistance
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:209
set cameraDistance(distance): void
Parameters
- distance: number
Returns void
Inherited from TwistyPlayerSettable.cameraDistance
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:204

cameraLatitude

get cameraLatitude(): never
Returns never
Inherited from TwistyPlayerSettable.cameraLatitude
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:191
set cameraLatitude(latitude): void
Parameters
- latitude: number
Returns void
Inherited from TwistyPlayerSettable.cameraLatitude
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:186

cameraLatitudeLimit

get cameraLatitudeLimit(): never
Returns never
Inherited from TwistyPlayerSettable.cameraLatitudeLimit
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:216
set cameraLatitudeLimit(latitudeLimit): void
Parameters
- latitudeLimit: number
Returns void
Inherited from TwistyPlayerSettable.cameraLatitudeLimit
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:213

cameraLongitude

get cameraLongitude(): never
Returns never
Inherited from TwistyPlayerSettable.cameraLongitude
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:200
set cameraLongitude(longitude): void
Parameters
- longitude: number
Returns void
Inherited from TwistyPlayerSettable.cameraLongitude
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:195

colorScheme

get colorScheme(): never
Returns never
Inherited from TwistyPlayerSettable.colorScheme
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:124
set colorScheme(colorScheme): void
Parameters
- colorScheme: ColorSchemeWithAuto
Returns void
Inherited from TwistyPlayerSettable.colorScheme
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:121

controlPanel

get controlPanel(): never
Returns never
Inherited from TwistyPlayerSettable.controlPanel
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:131
set controlPanel(newControlPanel): void
Parameters
- newControlPanel: ControlPanelThemeWithAuto
Returns void
Inherited from TwistyPlayerSettable.controlPanel
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:128

experimentalCompetitionID

get experimentalCompetitionID(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalCompetitionID
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:159
set experimentalCompetitionID(competitionID): void
Parameters
- competitionID: null | string
Returns void
Inherited from TwistyPlayerSettable.experimentalCompetitionID
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:156

experimentalDragInput

get experimentalDragInput(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalDragInput
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:267
set experimentalDragInput(dragInputMode): void
Parameters
- dragInputMode: "auto" | "none"
Returns void
Inherited from TwistyPlayerSettable.experimentalDragInput
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:264

experimentalFaceletScale

get experimentalFaceletScale(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalFaceletScale
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:103
set experimentalFaceletScale(faceletScale): void
Parameters
- faceletScale: FaceletScale
Returns void
Inherited from TwistyPlayerSettable.experimentalFaceletScale
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:99

experimentalHintSprite

get experimentalHintSprite(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalHintSprite
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:244
set experimentalHintSprite(url): void
Parameters
- url: string | URL
Returns void
Inherited from TwistyPlayerSettable.experimentalHintSprite
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:241

experimentalInitialHintFaceletsAnimation

get experimentalInitialHintFaceletsAnimation(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalInitialHintFaceletsAnimation
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:260
set experimentalInitialHintFaceletsAnimation(anim): void
Parameters
- anim: InitialHintFaceletsAnimation
Returns void
Inherited from TwistyPlayerSettable.experimentalInitialHintFaceletsAnimation
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:255

experimentalMovePressCancelOptions

get experimentalMovePressCancelOptions(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalMovePressCancelOptions
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:182
set experimentalMovePressCancelOptions(movePressCancelOptions): void
Parameters
- movePressCancelOptions: AppendCancelOptions
Returns void
Inherited from TwistyPlayerSettable.experimentalMovePressCancelOptions
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:177

experimentalMovePressInput

get experimentalMovePressInput(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalMovePressInput
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:173
set experimentalMovePressInput(movePressInput): void
Parameters
- movePressInput: "basic" | "auto" | "none"
Returns void
Inherited from TwistyPlayerSettable.experimentalMovePressInput
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:170

experimentalPuzzleDescription

get experimentalPuzzleDescription(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalPuzzleDescription
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:63
set experimentalPuzzleDescription(puzzleDescription): void
Parameters
- puzzleDescription: string
Returns void
Inherited from TwistyPlayerSettable.experimentalPuzzleDescription
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:60

experimentalSetupAlg

get experimentalSetupAlg(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalSetupAlg
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:42
set experimentalSetupAlg(newSetup): void
Parameters
- newSetup: string | Alg
Returns void
Inherited from TwistyPlayerSettable.experimentalSetupAlg
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:39

experimentalSetupAnchor

get experimentalSetupAnchor(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalSetupAnchor
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:49
set experimentalSetupAnchor(anchor): void
Parameters
- anchor: "end" | "start"
Returns void
Inherited from TwistyPlayerSettable.experimentalSetupAnchor
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:46

experimentalSprite

get experimentalSprite(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalSprite
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:237
set experimentalSprite(url): void
Parameters
- url: string | URL
Returns void
Inherited from TwistyPlayerSettable.experimentalSprite
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:234

experimentalStickering

get experimentalStickering(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalStickering
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:84
set experimentalStickering(stickering): void
Parameters
- stickering: string
Returns void
Inherited from TwistyPlayerSettable.experimentalStickering
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:81

experimentalStickeringMaskOrbits

get experimentalStickeringMaskOrbits(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalStickeringMaskOrbits
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:95
set experimentalStickeringMaskOrbits(stickeringMask): void
Parameters
- stickeringMask: string | StickeringMask
Returns void
Inherited from TwistyPlayerSettable.experimentalStickeringMaskOrbits
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:88

experimentalTitle

get experimentalTitle(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalTitle
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:145
set experimentalTitle(title): void
Parameters
- title: null | string
Returns void
Inherited from TwistyPlayerSettable.experimentalTitle
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:142

experimentalVideoURL

get experimentalVideoURL(): never
Returns never
Inherited from TwistyPlayerSettable.experimentalVideoURL
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:152
set experimentalVideoURL(videoURL): void
Parameters
- videoURL: null | string
Returns void
Inherited from TwistyPlayerSettable.experimentalVideoURL
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:149

fullscreenElement

get fullscreenElement(): never
Returns never
Inherited from TwistyPlayerSettable.fullscreenElement
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:251
set fullscreenElement(element): void
Parameters
- element: null | Element
Returns void
Inherited from TwistyPlayerSettable.fullscreenElement
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:248

hintFacelets

get hintFacelets(): never
Returns never
Inherited from TwistyPlayerSettable.hintFacelets
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:77
set hintFacelets(hintFaceletStyle): void
Parameters
- hintFaceletStyle: HintFaceletStyleWithAuto
Returns void
Inherited from TwistyPlayerSettable.hintFacelets
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:74

indexer

get indexer(): never
Returns never
Inherited from TwistyPlayerSettable.indexer
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:223
set indexer(indexer): void
Parameters
- indexer:
      | "auto"
      | "simple"
      | "tree"
      | "simultaneous"
Returns void
Inherited from TwistyPlayerSettable.indexer
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:220

puzzle

get puzzle(): never
Returns never
Inherited from TwistyPlayerSettable.puzzle
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:56
set puzzle(puzzleID): void
Parameters
- puzzleID:
      | "custom"
      | "2x2x2"
      | "3x3x3"
      | "4x4x4"
      | "5x5x5"
      | "6x6x6"
      | "7x7x7"
      | "40x40x40"
      | "skewb"
      | "pyraminx"
      | "megaminx"
      | "gigaminx"
      | "square1"
      | "clock"
      | "fto"
      | "master_tetraminx"
      | "kilominx"
      | "redi_cube"
      | "melindas2x2x2x2"
      | "tri_quad"
      | "loopover"
Returns void
Inherited from TwistyPlayerSettable.puzzle
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:53

tempoScale

get tempoScale(): never
Returns never
Inherited from TwistyPlayerSettable.tempoScale
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:230
set tempoScale(newTempoScale): void
Parameters
- newTempoScale: number
Returns void
Inherited from TwistyPlayerSettable.tempoScale
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:227

timestamp

get timestamp(): never
Returns never
Inherited from TwistyPlayerSettable.timestamp
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:70
set timestamp(timestamp): void
Parameters
- timestamp: TimestampRequest
Returns void
Inherited from TwistyPlayerSettable.timestamp
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:67

viewerLink

get viewerLink(): never
Returns never
Inherited from TwistyPlayerSettable.viewerLink
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:166
set viewerLink(viewerLinkPage): void
Parameters
- viewerLinkPage: ViewerLinkPageWithAuto
Returns void
Inherited from TwistyPlayerSettable.viewerLink
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:163

visualization

get visualization(): never
Returns never
Inherited from TwistyPlayerSettable.visualization
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:138
set visualization(visualizationFormat): void
Parameters
- visualizationFormat: VisualizationFormatWithAuto
Returns void
Inherited from TwistyPlayerSettable.visualization
- Defined in src/cubing/twisty/views/TwistyPlayerSettable.ts:135

`Static`observedAttributes

get observedAttributes(): string[]
Returns string[]
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:465

Methods

`Protected`addCSS

addCSS(cssSource): void
Parameters
- cssSource: CSSStyleSheet
Returns void
Inherited from TwistyPlayerSettable.addCSS
- Defined in src/cubing/twisty/views/ManagedCustomElement.ts:24

addElement

addElement<T>(element): T
Type Parameters
- T extends Node
Parameters
- element: T
Returns T
Inherited from TwistyPlayerSettable.addElement
- Defined in src/cubing/twisty/views/ManagedCustomElement.ts:35

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
  - - (this, ev): any
    - Parameters
      this: HTMLElement
      ev: HTMLElementEventMap[K]
      Returns any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from TwistyPlayerSettable.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10083
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from TwistyPlayerSettable.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10084

after

after(...nodes): void
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.

MDN Reference
Parameters
- Rest...nodes: (string | Node)[]
Returns void
Inherited from TwistyPlayerSettable.after
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5712

animate

animate(keyframes, options?): Animation
MDN Reference
Parameters
- keyframes: null | PropertyIndexedKeyframes | Keyframe[]
- Optionaloptions: number | KeyframeAnimationOptions
Returns Animation
Inherited from TwistyPlayerSettable.animate
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2459

append

append(...nodes): void
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.

MDN Reference
Parameters
- Rest...nodes: (string | Node)[]
Returns void
Inherited from TwistyPlayerSettable.append
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16551

appendChild

appendChild<T>(node): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
Returns T
Inherited from TwistyPlayerSettable.appendChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15904

attachInternals

attachInternals(): ElementInternals
MDN Reference

Returns ElementInternals
Inherited from TwistyPlayerSettable.attachInternals
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10074

attachShadow

attachShadow(init): ShadowRoot
Creates a shadow root for element and returns it.

MDN Reference
Parameters
- init: ShadowRootInit
Returns ShadowRoot
Inherited from TwistyPlayerSettable.attachShadow
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7774

attributeChangedCallback

attributeChangedCallback(attributeName, _oldValue, newValue): void
Parameters
- attributeName: string
- _oldValue: string
- newValue: string
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:477

before

before(...nodes): void
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.

MDN Reference
Parameters
- Rest...nodes: (string | Node)[]
Returns void
Inherited from TwistyPlayerSettable.before
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5720

blur

blur(): void
MDN Reference

Returns void
Inherited from TwistyPlayerSettable.blur
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11853

checkVisibility

checkVisibility(options?): boolean
MDN Reference
Parameters
- Optionaloptions: CheckVisibilityOptions
Returns boolean
Inherited from TwistyPlayerSettable.checkVisibility
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7776

click

click(): void
MDN Reference

Returns void
Inherited from TwistyPlayerSettable.click
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10076

cloneNode

cloneNode(deep?): Node
Returns a copy of node. If deep is true, the copy also includes the node's descendants.

MDN Reference
Parameters
- Optionaldeep: boolean
Returns Node
Inherited from TwistyPlayerSettable.cloneNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15910

closest

closest<K>(selector): null | HTMLElementTagNameMap[K]
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selector: K
Returns null | HTMLElementTagNameMap[K]
Inherited from TwistyPlayerSettable.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7782
closest<K>(selector): null | SVGElementTagNameMap[K]
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selector: K
Returns null | SVGElementTagNameMap[K]
Inherited from TwistyPlayerSettable.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7783
closest<K>(selector): null | MathMLElementTagNameMap[K]
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selector: K
Returns null | MathMLElementTagNameMap[K]
Inherited from TwistyPlayerSettable.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7784
closest<E>(selectors): null | E
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns null | E
Inherited from TwistyPlayerSettable.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7785

compareDocumentPosition

compareDocumentPosition(other): number
Returns a bitmask indicating the position of other relative to node.

MDN Reference
Parameters
- other: Node
Returns number
Inherited from TwistyPlayerSettable.compareDocumentPosition
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15916

computedStyleMap

computedStyleMap(): StylePropertyMapReadOnly
MDN Reference

Returns StylePropertyMapReadOnly
Inherited from TwistyPlayerSettable.computedStyleMap
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7787

connectedCallback

connectedCallback(): Promise<void>
Returns Promise<void>
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:234

contains

contains(other): boolean
Returns true if other is an inclusive descendant of node, and false otherwise.

MDN Reference
Parameters
- other: null | Node
Returns boolean
Inherited from TwistyPlayerSettable.contains
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15922

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.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from TwistyPlayerSettable.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8309

experimentalAddAlgLeaf

experimentalAddAlgLeaf(algLeaf, options?): void
Parameters
- algLeaf: AlgLeaf
- Optionaloptions: AppendOptions
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:461

experimentalAddMove

experimentalAddMove(flexibleMove, options?): void
Parameters
- flexibleMove: string | Move
- Optionaloptions: AppendOptions
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:452

experimentalCurrentCanvases

experimentalCurrentCanvases(): Promise<HTMLCanvasElement[]>
Returns Promise<HTMLCanvasElement[]>
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:365

experimentalCurrentThreeJSPuzzleObject

experimentalCurrentThreeJSPuzzleObject(puzzleRenderScheduledCallback?): Promise<Object3D<Object3DEventMap>>
Get the first available puzzle Object3D. This can be inserted into another three.js scene, essentially "adopting" it from the TwistyPlayer's scenes while still allowing the TwistyPlayer to animate it. The function returns a Promise that returns if and when the Object3D is available, and accepts a callback that is called whenever a render is scheduled for the puzzle (essentially, if something about the puzzle has changed, like its appearance or current animated state).

Note:
- This may never resolve if the player never creates the relevant 3D object under the hood (e.g. if the config is set to 2D, or is not valid for rendering a puzzle)
- The architecture of cubing.js may change significantly, so it is not guaranteed that a three.js Object3D will be available from the main thread in the future.
- This function only returns the current three.js puzzle object (once one exists). If you change e.g. the puzzle config for the player, then the object will currently become stale. This may be replaced with more convenient behaviour in the future.
Parameters
- OptionalpuzzleRenderScheduledCallback: (() => void)
  - - (): void
    - Returns void
Returns Promise<Object3D<Object3DEventMap>>
Deprecated
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:396

experimentalCurrentVantages

experimentalCurrentVantages(): Promise<Iterable<Twisty3DVantage, any, any>>
Returns Promise<Iterable<Twisty3DVantage, any, any>>
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:356

experimentalDownloadScreenshot

experimentalDownloadScreenshot(filename?): Promise<void>
Parameters
- Optionalfilename: string
Returns Promise<void>
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:505

experimentalRemoveFinalChild

experimentalRemoveFinalChild(): void
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:473

experimentalScreenshot

experimentalScreenshot(options?): Promise<string>
Parameters
- Optionaloptions: {
  height: number;
  width: number;
  }
  - height: number
  - width: number
Returns Promise<string>
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:496

experimentalSetFlashLevel

experimentalSetFlashLevel(newLevel): void
Parameters
- newLevel: "auto" | "none"
Returns void
Deprecated
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:306

flash

flash(): void
Returns void
Implementation of TwistyAnimationControllerDelegate.flash
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:310

focus

focus(options?): void
MDN Reference
Parameters
- Optionaloptions: FocusOptions
Returns void
Inherited from TwistyPlayerSettable.focus
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11855

getAnimations

getAnimations(options?): Animation[]
MDN Reference
Parameters
- Optionaloptions: GetAnimationsOptions
Returns Animation[]
Inherited from TwistyPlayerSettable.getAnimations
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2461

getAttribute

getAttribute(qualifiedName): null | string
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

MDN Reference
Parameters
- qualifiedName: string
Returns null | string
Inherited from TwistyPlayerSettable.getAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7793

getAttributeNames

getAttributeNames(): string[]
Returns the qualified names of all element's attributes. Can contain duplicates.

MDN Reference

Returns string[]
Inherited from TwistyPlayerSettable.getAttributeNames
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7805

getAttributeNode

getAttributeNode(qualifiedName): null | Attr
MDN Reference
Parameters
- qualifiedName: string
Returns null | Attr
Inherited from TwistyPlayerSettable.getAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7807

getAttributeNodeNS

getAttributeNodeNS(namespace, localName): null | Attr
MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns null | Attr
Inherited from TwistyPlayerSettable.getAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7809

getAttributeNS

getAttributeNS(namespace, localName): null | string
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns null | string
Inherited from TwistyPlayerSettable.getAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7799

getBoundingClientRect

getBoundingClientRect(): DOMRect
MDN Reference

Returns DOMRect
Inherited from TwistyPlayerSettable.getBoundingClientRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7811

getClientRects

getClientRects(): DOMRectList
MDN Reference

Returns DOMRectList
Inherited from TwistyPlayerSettable.getClientRects
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7813

getElementsByClassName

getElementsByClassName(classNames): HTMLCollectionOf<Element>
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.

MDN Reference
Parameters
- classNames: string
Returns HTMLCollectionOf<Element>
Inherited from TwistyPlayerSettable.getElementsByClassName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7819

getElementsByTagName

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>
MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from TwistyPlayerSettable.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7821
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from TwistyPlayerSettable.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7822
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>
Inherited from TwistyPlayerSettable.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7823
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from TwistyPlayerSettable.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7825
getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>
Parameters
- qualifiedName: string
Returns HTMLCollectionOf<Element>
Inherited from TwistyPlayerSettable.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7826

getElementsByTagNameNS

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>
MDN Reference
Parameters
- namespaceURI: "http://www.w3.org/1999/xhtml"
- localName: string
Returns HTMLCollectionOf<HTMLElement>
Inherited from TwistyPlayerSettable.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7828
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>
Parameters
- namespaceURI: "http://www.w3.org/2000/svg"
- localName: string
Returns HTMLCollectionOf<SVGElement>
Inherited from TwistyPlayerSettable.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7829
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>
Parameters
- namespaceURI: "http://www.w3.org/1998/Math/MathML"
- localName: string
Returns HTMLCollectionOf<MathMLElement>
Inherited from TwistyPlayerSettable.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7830
getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>
Parameters
- namespace: null | string
- localName: string
Returns HTMLCollectionOf<Element>
Inherited from TwistyPlayerSettable.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7831

getHTML

getHTML(options?): string
MDN Reference
Parameters
- Optionaloptions: GetHTMLOptions
Returns string
Inherited from TwistyPlayerSettable.getHTML
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7833

getRootNode

getRootNode(options?): Node
Returns node's root.

MDN Reference
Parameters
- Optionaloptions: GetRootNodeOptions
Returns Node
Inherited from TwistyPlayerSettable.getRootNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15928

hasAttribute

hasAttribute(qualifiedName): boolean
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

MDN Reference
Parameters
- qualifiedName: string
Returns boolean
Inherited from TwistyPlayerSettable.hasAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7839

hasAttributeNS

hasAttributeNS(namespace, localName): boolean
Returns true if element has an attribute whose namespace is namespace and local name is localName.

MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns boolean
Inherited from TwistyPlayerSettable.hasAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7845

hasAttributes

hasAttributes(): boolean
Returns true if element has attributes, and false otherwise.

MDN Reference

Returns boolean
Inherited from TwistyPlayerSettable.hasAttributes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7851

hasChildNodes

hasChildNodes(): boolean
Returns whether node has children.

MDN Reference

Returns boolean
Inherited from TwistyPlayerSettable.hasChildNodes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15934

hasPointerCapture

hasPointerCapture(pointerId): boolean
MDN Reference
Parameters
- pointerId: number
Returns boolean
Inherited from TwistyPlayerSettable.hasPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7853

hidePopover

hidePopover(): void
MDN Reference

Returns void
Inherited from TwistyPlayerSettable.hidePopover
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10078

insertAdjacentElement

insertAdjacentElement(where, element): null | Element
MDN Reference
Parameters
- where: InsertPosition
- element: Element
Returns null | Element
Inherited from TwistyPlayerSettable.insertAdjacentElement
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7855

insertAdjacentHTML

insertAdjacentHTML(position, string): void
MDN Reference
Parameters
- position: InsertPosition
- string: string
Returns void
Inherited from TwistyPlayerSettable.insertAdjacentHTML
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7857

insertAdjacentText

insertAdjacentText(where, data): void
MDN Reference
Parameters
- where: InsertPosition
- data: string
Returns void
Inherited from TwistyPlayerSettable.insertAdjacentText
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7859

insertBefore

insertBefore<T>(node, child): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
- child: null | Node
Returns T
Inherited from TwistyPlayerSettable.insertBefore
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15936

isDefaultNamespace

isDefaultNamespace(namespace): boolean
MDN Reference
Parameters
- namespace: null | string
Returns boolean
Inherited from TwistyPlayerSettable.isDefaultNamespace
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15938

isEqualNode

isEqualNode(otherNode): boolean
Returns whether node and otherNode have the same properties.

MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from TwistyPlayerSettable.isEqualNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15944

isSameNode

isSameNode(otherNode): boolean
MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from TwistyPlayerSettable.isSameNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15946

jumpToEnd

jumpToEnd(options?): void
Parameters
- Optionaloptions: {
  flash: boolean;
  }
  - flash: boolean
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:430

jumpToStart

jumpToStart(options?): void
Parameters
- Optionaloptions: {
  flash: boolean;
  }
  - flash: boolean
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:426

lookupNamespaceURI

lookupNamespaceURI(prefix): null | string
MDN Reference
Parameters
- prefix: null | string
Returns null | string
Inherited from TwistyPlayerSettable.lookupNamespaceURI
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15948

lookupPrefix

lookupPrefix(namespace): null | string
MDN Reference
Parameters
- namespace: null | string
Returns null | string
Inherited from TwistyPlayerSettable.lookupPrefix
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15950

matches

matches(selectors): boolean
Returns true if matching selectors against element's root yields element, and false otherwise.

MDN Reference
Parameters
- selectors: string
Returns boolean
Inherited from TwistyPlayerSettable.matches
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7865

normalize

normalize(): void
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

MDN Reference

Returns void
Inherited from TwistyPlayerSettable.normalize
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15956

pause

pause(): void
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:438

play

play(): void
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:434

prepend

prepend(...nodes): void
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.

MDN Reference
Parameters
- Rest...nodes: (string | Node)[]
Returns void
Inherited from TwistyPlayerSettable.prepend
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16559

prependElement

prependElement<T>(element): void
Type Parameters
- T extends Node
Parameters
- element: T
Returns void
Inherited from TwistyPlayerSettable.prependElement
- Defined in src/cubing/twisty/views/ManagedCustomElement.ts:39

querySelector

querySelector<K>(selectors): null | HTMLElementTagNameMap[K]
Returns the first element that is a descendant of node that matches selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementTagNameMap[K]
Inherited from TwistyPlayerSettable.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16565
querySelector<K>(selectors): null | SVGElementTagNameMap[K]
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns null | SVGElementTagNameMap[K]
Inherited from TwistyPlayerSettable.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16566
querySelector<K>(selectors): null | MathMLElementTagNameMap[K]
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns null | MathMLElementTagNameMap[K]
Inherited from TwistyPlayerSettable.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16567
querySelector<K>(selectors): null | HTMLElementDeprecatedTagNameMap[K]
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementDeprecatedTagNameMap[K]
Deprecated
Inherited from TwistyPlayerSettable.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16569
querySelector<E>(selectors): null | E
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns null | E
Inherited from TwistyPlayerSettable.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16570

querySelectorAll

querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>
Returns all element descendants of node that match selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementTagNameMap[K]>
Inherited from TwistyPlayerSettable.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16576
querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<SVGElementTagNameMap[K]>
Inherited from TwistyPlayerSettable.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16577
querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<MathMLElementTagNameMap[K]>
Inherited from TwistyPlayerSettable.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16578
querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from TwistyPlayerSettable.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16580
querySelectorAll<E>(selectors): NodeListOf<E>
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns NodeListOf<E>
Inherited from TwistyPlayerSettable.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16581

releasePointerCapture

releasePointerCapture(pointerId): void
MDN Reference
Parameters
- pointerId: number
Returns void
Inherited from TwistyPlayerSettable.releasePointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7867

remove

remove(): void
Removes node.

MDN Reference

Returns void
Inherited from TwistyPlayerSettable.remove
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5726

removeAttribute

removeAttribute(qualifiedName): void
Removes element's first attribute whose qualified name is qualifiedName.

MDN Reference
Parameters
- qualifiedName: string
Returns void
Inherited from TwistyPlayerSettable.removeAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7873

removeAttributeNode

removeAttributeNode(attr): Attr
MDN Reference
Parameters
- attr: Attr
Returns Attr
Inherited from TwistyPlayerSettable.removeAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7881

removeAttributeNS

removeAttributeNS(namespace, localName): void
Removes element's attribute whose namespace is namespace and local name is localName.

MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns void
Inherited from TwistyPlayerSettable.removeAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7879

removeChild

removeChild<T>(child): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- child: T
Returns T
Inherited from TwistyPlayerSettable.removeChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15958

`Protected`removeCSS

removeCSS(cssSource): void
Parameters
- cssSource: CSSStyleSheet
Returns void
Inherited from TwistyPlayerSettable.removeCSS
- Defined in src/cubing/twisty/views/ManagedCustomElement.ts:28

removeElement

removeElement<T>(element): T
Type Parameters
- T extends Node
Parameters
- element: T
Returns T
Inherited from TwistyPlayerSettable.removeElement
- Defined in src/cubing/twisty/views/ManagedCustomElement.ts:43

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
  - - (this, ev): any
    - Parameters
      this: HTMLElement
      ev: HTMLElementEventMap[K]
      Returns any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from TwistyPlayerSettable.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10085
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from TwistyPlayerSettable.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10086

replaceChild

replaceChild<T>(node, child): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: Node
- child: T
Returns T
Inherited from TwistyPlayerSettable.replaceChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15960

replaceChildren

replaceChildren(...nodes): void
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.

MDN Reference
Parameters
- Rest...nodes: (string | Node)[]
Returns void
Inherited from TwistyPlayerSettable.replaceChildren
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16589

replaceWith

replaceWith(...nodes): void
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.

MDN Reference
Parameters
- Rest...nodes: (string | Node)[]
Returns void
Inherited from TwistyPlayerSettable.replaceWith
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5734

requestFullscreen

requestFullscreen(options?): Promise<void>
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.

MDN Reference
Parameters
- Optionaloptions: FullscreenOptions
Returns Promise<void>
Inherited from TwistyPlayerSettable.requestFullscreen
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7889

requestPointerLock

requestPointerLock(options?): Promise<void>
MDN Reference
Parameters
- Optionaloptions: PointerLockOptions
Returns Promise<void>
Inherited from TwistyPlayerSettable.requestPointerLock
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7891

scroll

scroll(options?): void
MDN Reference
Parameters
- Optionaloptions: ScrollToOptions
Returns void
Inherited from TwistyPlayerSettable.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7893
scroll(x, y): void
Parameters
- x: number
- y: number
Returns void
Inherited from TwistyPlayerSettable.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7894

scrollBy

scrollBy(options?): void
MDN Reference
Parameters
- Optionaloptions: ScrollToOptions
Returns void
Inherited from TwistyPlayerSettable.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7896
scrollBy(x, y): void
Parameters
- x: number
- y: number
Returns void
Inherited from TwistyPlayerSettable.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7897

scrollIntoView

scrollIntoView(arg?): void
MDN Reference
Parameters
- Optionalarg: boolean | ScrollIntoViewOptions
Returns void
Inherited from TwistyPlayerSettable.scrollIntoView
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7899

scrollTo

scrollTo(options?): void
MDN Reference
Parameters
- Optionaloptions: ScrollToOptions
Returns void
Inherited from TwistyPlayerSettable.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7901
scrollTo(x, y): void
Parameters
- x: number
- y: number
Returns void
Inherited from TwistyPlayerSettable.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7902

setAttribute

setAttribute(qualifiedName, value): void
Sets the value of element's first attribute whose qualified name is qualifiedName to value.

MDN Reference
Parameters
- qualifiedName: string
- value: string
Returns void
Inherited from TwistyPlayerSettable.setAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7908

setAttributeNode

setAttributeNode(attr): null | Attr
MDN Reference
Parameters
- attr: Attr
Returns null | Attr
Inherited from TwistyPlayerSettable.setAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7916

setAttributeNodeNS

setAttributeNodeNS(attr): null | Attr
MDN Reference
Parameters
- attr: Attr
Returns null | Attr
Inherited from TwistyPlayerSettable.setAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7918

setAttributeNS

setAttributeNS(namespace, qualifiedName, value): void
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

MDN Reference
Parameters
- namespace: null | string
- qualifiedName: string
- value: string
Returns void
Inherited from TwistyPlayerSettable.setAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7914

setHTMLUnsafe

setHTMLUnsafe(html): void
MDN Reference
Parameters
- html: string
Returns void
Inherited from TwistyPlayerSettable.setHTMLUnsafe
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7920

setPointerCapture

setPointerCapture(pointerId): void
MDN Reference
Parameters
- pointerId: number
Returns void
Inherited from TwistyPlayerSettable.setPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7922

showPopover

showPopover(): void
MDN Reference

Returns void
Inherited from TwistyPlayerSettable.showPopover
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10080

toggleAttribute

toggleAttribute(qualifiedName, force?): boolean
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.

MDN Reference
Parameters
- qualifiedName: string
- Optionalforce: boolean
Returns boolean
Inherited from TwistyPlayerSettable.toggleAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7930

togglePlay

togglePlay(play?): void
Parameters
- Optionalplay: boolean
Returns void
- Defined in src/cubing/twisty/views/TwistyPlayer.ts:446

togglePopover

togglePopover(force?): boolean
MDN Reference
Parameters
- Optionalforce: boolean
Returns boolean
Inherited from TwistyPlayerSettable.togglePopover
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10082

webkitMatchesSelector

webkitMatchesSelector(selectors): boolean
Parameters
- selectors: string
Returns boolean
Deprecated
This is a legacy alias of matches.

MDN Reference
Inherited from TwistyPlayerSettable.webkitMatchesSelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7936

Class TwistyPlayer

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TwistyPlayer

Properties

accessKey

ReadonlyaccessKeyLabel

ariaAtomic

ariaAutoComplete

ariaBrailleLabel

ariaBrailleRoleDescription

ariaBusy

ariaChecked

ariaColCount

ariaColIndex

ariaColSpan

ariaCurrent

ariaDescription

ariaDisabled

ariaExpanded

ariaHasPopup

ariaHidden

ariaInvalid

ariaKeyShortcuts

ariaLabel

ariaLevel

ariaLive

ariaModal

ariaMultiLine

ariaMultiSelectable

ariaOrientation

ariaPlaceholder

ariaPosInSet

ariaPressed

ariaReadOnly

ariaRequired

ariaRoleDescription

ariaRowCount

ariaRowIndex

ariaRowSpan

ariaSelected

ariaSetSize

ariaSort

ariaValueMax

ariaValueMin

ariaValueNow

ariaValueText

ReadonlyassignedSlot

ReadonlyATTRIBUTE_NODE

Readonlyattributes

ReadonlyattributeStyleMap

autocapitalize

autofocus

ReadonlybaseURI

buttons

ReadonlyCDATA_SECTION_NODE

ReadonlychildElementCount

ReadonlychildNodes

Readonlychildren

ReadonlyclassList

className

ReadonlyclientHeight

ReadonlyclientLeft

ReadonlyclientTop

ReadonlyclientWidth

ReadonlyCOMMENT_NODE

contentEditable

ReadonlycontentWrapper

controller

Readonlydataset

dir

ReadonlyDOCUMENT_FRAGMENT_NODE

`Readonly`accessKeyLabel

`Readonly`assignedSlot

`Readonly`ATTRIBUTE_NODE

`Readonly`attributes

`Readonly`attributeStyleMap

`Readonly`baseURI

`Readonly`CDATA_SECTION_NODE

`Readonly`childElementCount

`Readonly`childNodes

`Readonly`children

`Readonly`classList

`Readonly`clientHeight

`Readonly`clientLeft

`Readonly`clientTop

`Readonly`clientWidth

`Readonly`COMMENT_NODE

`Readonly`contentWrapper

`Readonly`dataset

`Readonly`DOCUMENT_FRAGMENT_NODE

`Readonly`DOCUMENT_NODE

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

`Readonly`DOCUMENT_POSITION_CONTAINS

`Readonly`DOCUMENT_POSITION_DISCONNECTED

`Readonly`DOCUMENT_POSITION_FOLLOWING

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

`Readonly`DOCUMENT_POSITION_PRECEDING

`Readonly`DOCUMENT_TYPE_NODE

`Readonly`ELEMENT_NODE

`Readonly`ENTITY_NODE

`Readonly`ENTITY_REFERENCE_NODE

`Readonly`firstChild

`Readonly`firstElementChild

`Readonly`isConnected

`Readonly`isContentEditable

`Readonly`lastChild

`Readonly`lastElementChild

`Readonly`localName

`Readonly`namespaceURI

`Readonly`nextElementSibling

`Readonly`nextSibling

`Readonly`nodeName

`Readonly`nodeType

`Optional`nonce

`Readonly`NOTATION_NODE

`Readonly`offsetHeight

`Readonly`offsetLeft

`Readonly`offsetParent

`Readonly`offsetTop

`Readonly`offsetWidth