get attributes(): { Â Â Â Â TEMPLATE: "templateId"; Â Â Â Â VISIBLE: "visible"; Â Â Â Â STATE: "state"; }
Returns { Â Â Â Â TEMPLATE: "templateId"; Â Â Â Â VISIBLE: "visible"; Â Â Â Â STATE: "state"; }
ReadonlyTEMPLATE: "templateId"
ReadonlyVISIBLE: "visible"
ReadonlySTATE: "state"
Events
onhide
set onhide(handler): void
Triggered via .hide()
Parameters
handler: Handler
Returns void
onshow
set onshow(handler): void
Triggered via .show()
Parameters
handler: Handler
Returns void
ondown
set ondown(handler): void
Triggered via .press()
Parameters
handler: Handler
Returns void
onup
set onup(handler): void
Triggered via .release()
Parameters
handler: Handler
Returns void
Operations
hide
hide(): boolean
Returns boolean
show
show(): boolean
Returns boolean
press
press(): boolean
Returns boolean
release
release(): boolean
Returns boolean
Other
Statictag
get tag(): any
By convention component html tags are defined and stored in the component library.
Providing the library has a tag defined for the component no error will be thrown.
Returns any
configuration
configuration:{ Â Â Â Â gestures: ({ Â Â Â Â Â Â Â Â event: "mousedown"; Â Â Â Â Â Â Â Â operation: "press"; Â Â Â Â } | { Â Â Â Â Â Â Â Â event: "mouseup"; Â Â Â Â Â Â Â Â operation: "release"; Â Â Â Â } | { Â Â Â Â Â Â Â Â event: "touchstart"; Â Â Â Â Â Â Â Â operation: "press"; Â Â Â Â } | { Â Â Â Â Â Â Â Â event: "touchend"; Â Â Â Â Â Â Â Â operation: "release"; Â Â Â Â } | { Â Â Â Â Â Â Â Â event: "mouseleave"; Â Â Â Â Â Â Â Â operation: "release"; Â Â Â Â })[]; } = Configuration
Contains the bindings of UI Gestures and Configuration of the finite state machine.
Type declaration
gestures: ({ Â Â Â Â event: "mousedown"; Â Â Â Â operation: "press"; } | { Â Â Â Â event: "mouseup"; Â Â Â Â operation: "release"; } | { Â Â Â Â event: "touchstart"; Â Â Â Â operation: "press"; } | { Â Â Â Â event: "touchend"; Â Â Â Â operation: "release"; } | { Â Â Â Â event: "mouseleave"; Â Â Â Â operation: "release"; })[]
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.
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Parameters
qualifiedName: string
Returns boolean
hasAttributeNS
hasAttributeNS(namespace, localName): boolean
Returns true if element has an attribute whose namespace is namespace and local name is localName.
Parameters
namespace: string
localName: string
Returns boolean
hasAttributes
hasAttributes(): boolean
Returns true if element has attributes, and false otherwise.
Returns boolean
hasPointerCapture
hasPointerCapture(pointerId): boolean
Parameters
pointerId: number
Returns boolean
insertAdjacentElement
insertAdjacentElement(where, element): Element
Parameters
where: InsertPosition
element: Element
Returns Element
insertAdjacentHTML
insertAdjacentHTML(position, text): void
Parameters
position: InsertPosition
text: string
Returns void
insertAdjacentText
insertAdjacentText(where, data): void
Parameters
where: InsertPosition
data: string
Returns void
matches
matches(selectors): boolean
Returns true if matching selectors against element's root yields element, and false otherwise.
Parameters
selectors: string
Returns boolean
releasePointerCapture
releasePointerCapture(pointerId): void
Parameters
pointerId: number
Returns void
removeAttribute
removeAttribute(qualifiedName): void
Removes element's first attribute whose qualified name is qualifiedName.
Parameters
qualifiedName: string
Returns void
removeAttributeNS
removeAttributeNS(namespace, localName): void
Removes element's attribute whose namespace is namespace and local name is localName.
Parameters
namespace: string
localName: string
Returns void
removeAttributeNode
removeAttributeNode(attr): Attr
Parameters
attr: Attr
Returns Attr
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.
Parameters
Optionaloptions: FullscreenOptions
Returns Promise<void>
requestPointerLock
requestPointerLock(): void
Returns void
scroll
scroll(options?): void
Parameters
Optionaloptions: ScrollToOptions
Returns void
scroll(x, y): void
Parameters
x: number
y: number
Returns void
scrollBy
scrollBy(options?): void
Parameters
Optionaloptions: ScrollToOptions
Returns void
scrollBy(x, y): void
Parameters
x: number
y: number
Returns void
scrollIntoView
scrollIntoView(arg?): void
Parameters
Optionalarg: boolean | ScrollIntoViewOptions
Returns void
scrollTo
scrollTo(options?): void
Parameters
Optionaloptions: ScrollToOptions
Returns void
scrollTo(x, y): void
Parameters
x: number
y: number
Returns void
setAttribute
setAttribute(qualifiedName, value): void
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.
Parameters
namespace: string
qualifiedName: string
value: string
Returns void
setAttributeNode
setAttributeNode(attr): Attr
Parameters
attr: Attr
Returns Attr
setAttributeNodeNS
setAttributeNodeNS(attr): Attr
Parameters
attr: Attr
Returns Attr
setPointerCapture
setPointerCapture(pointerId): void
Parameters
pointerId: number
Returns void
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.
Parameters
qualifiedName: string
Optionalforce: boolean
Returns boolean
webkitMatchesSelector
webkitMatchesSelector(selectors): boolean
Deprecated
This is a legacy alias of matches.
Parameters
selectors: string
Returns boolean
ReadonlybaseURI
baseURI:string
Returns node's node document's document base URL.
ReadonlychildNodes
childNodes:NodeListOf<ChildNode>
Returns the children.
ReadonlyfirstChild
firstChild:ChildNode
Returns the first child.
ReadonlyisConnected
isConnected:boolean
Returns true if node is connected and false otherwise.
ReadonlylastChild
lastChild:ChildNode
Returns the last child.
ReadonlynextSibling
nextSibling:ChildNode
Returns the next sibling.
ReadonlynodeName
nodeName:string
Returns a string appropriate for the type of node.
ReadonlynodeType
nodeType:number
Returns the type of node.
nodeValue
nodeValue:string
ReadonlyparentElement
parentElement:HTMLElement
Returns the parent element.
ReadonlyparentNode
parentNode:ParentNode
Returns the parent.
ReadonlypreviousSibling
previousSibling:ChildNode
Returns the previous sibling.
textContent
textContent:string
appendChild
appendChild<T>(node): T
Type Parameters
T extends Node<T>
Parameters
node: T
Returns T
cloneNode
cloneNode(deep?): Node
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Parameters
Optionaldeep: boolean
Returns Node
compareDocumentPosition
compareDocumentPosition(other): number
Returns a bitmask indicating the position of other relative to node.
Parameters
other: Node
Returns number
contains
contains(other): boolean
Returns true if other is an inclusive descendant of node, and false otherwise.
Parameters
other: Node
Returns boolean
getRootNode
getRootNode(options?): Node
Returns node's root.
Parameters
Optionaloptions: GetRootNodeOptions
Returns Node
hasChildNodes
hasChildNodes(): boolean
Returns whether node has children.
Returns boolean
insertBefore
insertBefore<T>(node, child): T
Type Parameters
T extends Node<T>
Parameters
node: T
child: Node
Returns T
isDefaultNamespace
isDefaultNamespace(namespace): boolean
Parameters
namespace: string
Returns boolean
isEqualNode
isEqualNode(otherNode): boolean
Returns whether node and otherNode have the same properties.
Parameters
otherNode: Node
Returns boolean
isSameNode
isSameNode(otherNode): boolean
Parameters
otherNode: Node
Returns boolean
lookupNamespaceURI
lookupNamespaceURI(prefix): string
Parameters
prefix: string
Returns string
lookupPrefix
lookupPrefix(namespace): string
Parameters
namespace: string
Returns string
normalize
normalize(): void
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Returns void
removeChild
removeChild<T>(child): T
Type Parameters
T extends Node<T>
Parameters
child: T
Returns T
replaceChild
replaceChild<T>(node, child): T
Type Parameters
T extends Node<T>
Parameters
node: Node
child: T
Returns T
ReadonlyELEMENT_NODE
ELEMENT_NODE:1
node is an element.
ReadonlyATTRIBUTE_NODE
ATTRIBUTE_NODE:2
ReadonlyTEXT_NODE
TEXT_NODE:3
node is a Text node.
ReadonlyCDATA_SECTION_NODE
CDATA_SECTION_NODE:4
node is a CDATASection node.
ReadonlyENTITY_REFERENCE_NODE
ENTITY_REFERENCE_NODE:5
ReadonlyENTITY_NODE
ENTITY_NODE:6
ReadonlyPROCESSING_INSTRUCTION_NODE
PROCESSING_INSTRUCTION_NODE:7
node is a ProcessingInstruction node.
ReadonlyCOMMENT_NODE
COMMENT_NODE:8
node is a Comment node.
ReadonlyDOCUMENT_NODE
DOCUMENT_NODE:9
node is a document.
ReadonlyDOCUMENT_TYPE_NODE
DOCUMENT_TYPE_NODE:10
node is a doctype.
ReadonlyDOCUMENT_FRAGMENT_NODE
DOCUMENT_FRAGMENT_NODE:11
node is a DocumentFragment node.
ReadonlyNOTATION_NODE
NOTATION_NODE:12
ReadonlyDOCUMENT_POSITION_DISCONNECTED
DOCUMENT_POSITION_DISCONNECTED:1
Set when node and other are not in the same tree.
ReadonlyDOCUMENT_POSITION_PRECEDING
DOCUMENT_POSITION_PRECEDING:2
Set when other is preceding node.
ReadonlyDOCUMENT_POSITION_FOLLOWING
DOCUMENT_POSITION_FOLLOWING:4
Set when other is following node.
ReadonlyDOCUMENT_POSITION_CONTAINS
DOCUMENT_POSITION_CONTAINS:8
Set when other is an ancestor of node.
ReadonlyDOCUMENT_POSITION_CONTAINED_BY
DOCUMENT_POSITION_CONTAINED_BY:16
Set when other is a descendant of node.
ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC:32
dispatchEvent
dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
event: Event
Returns boolean
ariaAtomic
ariaAtomic:string
ariaAutoComplete
ariaAutoComplete:string
ariaBusy
ariaBusy:string
ariaChecked
ariaChecked:string
ariaColCount
ariaColCount:string
ariaColIndex
ariaColIndex:string
ariaColSpan
ariaColSpan:string
ariaCurrent
ariaCurrent:string
ariaDisabled
ariaDisabled:string
ariaExpanded
ariaExpanded:string
ariaHasPopup
ariaHasPopup:string
ariaHidden
ariaHidden:string
ariaInvalid
ariaInvalid:string
ariaKeyShortcuts
ariaKeyShortcuts:string
ariaLabel
ariaLabel:string
ariaLevel
ariaLevel:string
ariaLive
ariaLive:string
ariaModal
ariaModal:string
ariaMultiLine
ariaMultiLine:string
ariaMultiSelectable
ariaMultiSelectable:string
ariaOrientation
ariaOrientation:string
ariaPlaceholder
ariaPlaceholder:string
ariaPosInSet
ariaPosInSet:string
ariaPressed
ariaPressed:string
ariaReadOnly
ariaReadOnly:string
ariaRequired
ariaRequired:string
ariaRoleDescription
ariaRoleDescription:string
ariaRowCount
ariaRowCount:string
ariaRowIndex
ariaRowIndex:string
ariaRowSpan
ariaRowSpan:string
ariaSelected
ariaSelected:string
ariaSetSize
ariaSetSize:string
ariaSort
ariaSort:string
ariaValueMax
ariaValueMax:string
ariaValueMin
ariaValueMin:string
ariaValueNow
ariaValueNow:string
ariaValueText
ariaValueText:string
role
role:string
animate
animate(keyframes, options?): Animation
Parameters
keyframes: PropertyIndexedKeyframes | Keyframe[]
Optionaloptions: number | KeyframeAnimationOptions
Returns Animation
getAnimations
getAnimations(options?): Animation[]
Parameters
Optionaloptions: GetAnimationsOptions
Returns Animation[]
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.
Parameters
Rest...nodes: (string | Node)[]
Returns void
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.
Parameters
Rest...nodes: (string | Node)[]
Returns void
remove
remove(): void
Removes node.
Returns void
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.
Parameters
Rest...nodes: (string | Node)[]
Returns void
innerHTML
innerHTML:string
ReadonlynextElementSibling
nextElementSibling:Element
Returns the first following sibling that is an element, and null otherwise.
ReadonlypreviousElementSibling
previousElementSibling:Element
Returns the first preceding sibling that is an element, and null otherwise.
ReadonlychildElementCount
childElementCount:number
Readonlychildren
children:HTMLCollection
Returns the child elements.
ReadonlyfirstElementChild
firstElementChild:Element
Returns the first child that is an element, and null otherwise.
ReadonlylastElementChild
lastElementChild:Element
Returns the last child that is an element, and null otherwise.
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.
Parameters
Rest...nodes: (string | Node)[]
Returns void
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.
Triggered via
.hide()