@ibm-wch-sdk/web-components
TypeScript icon, indicating that this package has built-in type declarations

6.0.524 • Public • Published

web-components

Collection of native web components to work with layouts in Watson Content Hub.

Details

Refer to the documentation.

Changes

CHANGELOG

Class documentation

Refer to the documentation.

Usage

Install the library as a dependency to your project, e.g. via:

npm install --save @ibm-wch-sdk/web-components

Bootstrap the registration of the web components as part of the bootstrap process of your application:

import { initSdkComponents } from '@ibm-wch-sdk/web-components';

initSdkComponents();

The components depend on the existence of an implementation of the @ibm-wch-sdk/api in the global namespace. You can use e.g. one of the following implementations:

  • For a standalone application, bootstrap the @ibm-wch-sdk/services implementation.
  • Use the custom components as part of an Angular application.

Build

If you plan to use custom elements natively in the browser, make sure to import the ES6 version of the library. Since the library is packaged following the APF, the ES6 code is available via the es2015 key in the package json. Note that the ES5 implementation will not work in Chrome.

Webpack

When using webpack make the following modification to the webpack.config.js to pull in the ES6 code:

module.exports = {
  resolve: {
    mainFields: ['es2015', 'browser', 'module', 'main']
  }
}

Note how es2015 gets prepended to the default lookup chain.

Layouts

This package of custom web components assist in rendering pages that can be managed by a business user using the WCH UI. The main building blocks are pages and layouts.

Pages

The page structure can be managed in WCH. Each page has a path and points to renderable content.

Use the wch-page component to do the URL resolution and to display the configured content item for a page.

Layouts

Each WCH content item can be rendered using a layout. The business user decides which layout to use for a particular piece of content, the developer implements the layouts as part of the application.

Use the wch-contentref component to render the layout for a particular content item.

Custom layouts

Custom layouts have to be implemented by your application. The layout template as mananaged in WCH matches the name of the custom element. The wch-contentref will figure out which layout is mapped to the addressed content and will instantiate the matching custom element accordingly.

Custom layouts should accept the following attributes:

  • layoutmode: name of the layout mode used to render the component. When not specified this should fallback to default.

Custom layouts should accept the following properties:

  • layoutMode: same as the layoutmode attribute, but accessible as a property. Also note the camel case name.
  • renderingContext: the RenderingContext that identifies the addressed content item. Implementations are advised to use the wch-contentref to render referenced content (or content from search).

Components

The library defines the following web components:

  • wch-contentref: used to render a content item from a reference
  • wch-page: used to do routing according to the WCH configuration

TODO

Changelog

Current

Added

  • Initial version

@ibm-wch-sdk/web-components

Index

External modules


@ibm-wch-sdk/web-components > "base/abstract.base.component"

External module: "base/abstract.base.component"

Index

Classes

Variables


Variables

<Const> ATTR_LAYOUT_MODE

● ATTR_LAYOUT_MODE: string = KEY_LAYOUT_MODE.toLowerCase()

Defined in base/abstract.base.component.ts:16


@ibm-wch-sdk/web-components > "base/abstract.rendering.component"

External module: "base/abstract.rendering.component"

Index

Classes


@ibm-wch-sdk/web-components > "content/content.component"

External module: "content/content.component"

Index

Classes

Variables


Variables

<Const> ATTR_ID

● ATTR_ID: string = KEY_ID.toLowerCase()

Defined in content/content.component.ts:26


<Const> ATTR_LAYOUT_MODE

● ATTR_LAYOUT_MODE: string = KEY_LAYOUT_MODE.toLowerCase()

Defined in content/content.component.ts:28


<Const> ATTR_LEVELS

● ATTR_LEVELS: string = KEY_LEVELS.toLowerCase()

Defined in content/content.component.ts:27


<Const> KEY_ID

● KEY_ID: "id" = "id"

Defined in content/content.component.ts:22


<Const> LOGGER

● LOGGER: "wch-content" = WCH_CONTENT

Defined in content/content.component.ts:24


@ibm-wch-sdk/web-components > "contentref/content.ref.component"

External module: "contentref/content.ref.component"

Index

Classes

Variables

Functions

Object literals


Variables

<Const> LOGGER

● LOGGER: "wch-contentref" = WCH_CONTENT_REF

Defined in contentref/content.ref.component.ts:92


<Const> _DEFAULT_LAYOUT

● _DEFAULT_LAYOUT: "wch-default-layout" = "wch-default-layout"

Defined in contentref/content.ref.component.ts:29


<Const> _PAGE_NOT_FOUND_LAYOUT

● _PAGE_NOT_FOUND_LAYOUT: "wch-404" = "wch-404"

Defined in contentref/content.ref.component.ts:31


Functions

getType

getType(aLayoutMode: string | undefined, aRenderingContext: RenderingContext, aRegistry: CustomElementRegistry): Observable<string>

Defined in contentref/content.ref.component.ts:67

Parameters:

Name Type
aLayoutMode string | undefined
aRenderingContext RenderingContext
aRegistry CustomElementRegistry

Returns: Observable<string>


resolveLayout

resolveLayout(aLayout: Layout, aRegistry: CustomElementRegistry): Observable<string>

Defined in contentref/content.ref.component.ts:42

Parameters:

Name Type
aLayout Layout
aRegistry CustomElementRegistry

Returns: Observable<string>


Object literals

<Const> LAYOUT_NOT_FOUND_LAYOUT

LAYOUT_NOT_FOUND_LAYOUT: object

Defined in contentref/content.ref.component.ts:37

template

● template: string = _DEFAULT_LAYOUT

Defined in contentref/content.ref.component.ts:39


templateType

● templateType: string = LAYOUT_TYPE_ANGULAR

Defined in contentref/content.ref.component.ts:38



<Const> PAGE_NOT_FOUND_LAYOUT

PAGE_NOT_FOUND_LAYOUT: object

Defined in contentref/content.ref.component.ts:33

template

● template: string = _PAGE_NOT_FOUND_LAYOUT

Defined in contentref/content.ref.component.ts:35


templateType

● templateType: string = LAYOUT_TYPE_ANGULAR

Defined in contentref/content.ref.component.ts:34



@ibm-wch-sdk/web-components > "contentref/index"

External module: "contentref/index"

Index


@ibm-wch-sdk/web-components > "decorators/layout.decorator"

External module: "decorators/layout.decorator"

Index

Variables

Functions


Variables

<Const> LAYOUT_SYMBOL

● LAYOUT_SYMBOL: unique symbol = Symbol()

Defined in decorators/layout.decorator.ts:5


Functions

LayoutComponent

LayoutComponent(aDirective?: LayoutComponentDirective): function

Defined in decorators/layout.decorator.ts:12

Parameters:

Name Type
Optional aDirective LayoutComponentDirective

Returns: function


_getSelectors

_getSelectors(aComponent: any): string[]

Defined in decorators/layout.decorator.ts:32

Returns the selectors for a component

Parameters:

Name Type Description
aComponent any the component

Returns: string[] the selectors, can be the empty strign


registerLayoutComponents

registerLayoutComponents(aComponents: any[]): void

Defined in decorators/layout.decorator.ts:49

Registers the given set of layout components

Parameters:

Name Type Description
aComponents any[] the components

Returns: void


@ibm-wch-sdk/web-components > "decorators/layout.directive"

External module: "decorators/layout.directive"

Index

Interfaces


@ibm-wch-sdk/web-components > "dom/document"

External module: "dom/document"

Index

Variables

Functions


Variables

<Const> createHTMLAbbrElement

● createHTMLAbbrElement: function = _createElement('abbr')

Defined in dom/document.ts:32

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLAddressElement

● createHTMLAddressElement: function = _createElement('address')

Defined in dom/document.ts:34

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLAnchorElement

● createHTMLAnchorElement: function = _createElement('a')

Defined in dom/document.ts:31

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLAppletElement

● createHTMLAppletElement: function = _createElement('applet')

Defined in dom/document.ts:35

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLAreaElement

● createHTMLAreaElement: function = _createElement('area')

Defined in dom/document.ts:36

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLArticleElement

● createHTMLArticleElement: function = _createElement('article')

Defined in dom/document.ts:37

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLAsideElement

● createHTMLAsideElement: function = _createElement('aside')

Defined in dom/document.ts:38

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLAudioElement

● createHTMLAudioElement: function = _createElement('audio')

Defined in dom/document.ts:39

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLBElement

● createHTMLBElement: function = _createElement('b')

Defined in dom/document.ts:40

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLBaseElement

● createHTMLBaseElement: function = _createElement('base')

Defined in dom/document.ts:41

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLBasefontElement

● createHTMLBasefontElement: function = _createElement('basefont')

Defined in dom/document.ts:42

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLBdoElement

● createHTMLBdoElement: function = _createElement('bdo')

Defined in dom/document.ts:44

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLBlockquoteElement

● createHTMLBlockquoteElement: function = _createElement('blockquote')

Defined in dom/document.ts:46

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLBodyElement

● createHTMLBodyElement: function = _createElement('body')

Defined in dom/document.ts:47

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLBrElement

● createHTMLBrElement: function = _createElement('br')

Defined in dom/document.ts:48

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLButtonElement

● createHTMLButtonElement: function = _createElement('button')

Defined in dom/document.ts:49

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLCanvasElement

● createHTMLCanvasElement: function = _createElement('canvas')

Defined in dom/document.ts:50

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLCaptionElement

● createHTMLCaptionElement: function = _createElement('caption')

Defined in dom/document.ts:51

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLCiteElement

● createHTMLCiteElement: function = _createElement('cite')

Defined in dom/document.ts:53

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLCodeElement

● createHTMLCodeElement: function = _createElement('code')

Defined in dom/document.ts:54

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLColElement

● createHTMLColElement: function = _createElement('col')

Defined in dom/document.ts:55

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLColgroupElement

● createHTMLColgroupElement: function = _createElement('colgroup')

Defined in dom/document.ts:56

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDataElement

● createHTMLDataElement: function = _createElement('data')

Defined in dom/document.ts:58

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDatalistElement

● createHTMLDatalistElement: function = _createElement('datalist')

Defined in dom/document.ts:59

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDdElement

● createHTMLDdElement: function = _createElement('dd')

Defined in dom/document.ts:60

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDelElement

● createHTMLDelElement: function = _createElement('del')

Defined in dom/document.ts:61

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDfnElement

● createHTMLDfnElement: function = _createElement('dfn')

Defined in dom/document.ts:63

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDirElement

● createHTMLDirElement: function = _createElement('dir')

Defined in dom/document.ts:65

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDivElement

● createHTMLDivElement: function = _createElement('div')

Defined in dom/document.ts:66

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDlElement

● createHTMLDlElement: function = _createElement('dl')

Defined in dom/document.ts:67

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLDtElement

● createHTMLDtElement: function = _createElement('dt')

Defined in dom/document.ts:68

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLEmElement

● createHTMLEmElement: function = _createElement('em')

Defined in dom/document.ts:69

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLEmbedElement

● createHTMLEmbedElement: function = _createElement('embed')

Defined in dom/document.ts:70

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFieldsetElement

● createHTMLFieldsetElement: function = _createElement('fieldset')

Defined in dom/document.ts:71

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFigcaptionElement

● createHTMLFigcaptionElement: function = _createElement('figcaption')

Defined in dom/document.ts:72

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFigureElement

● createHTMLFigureElement: function = _createElement('figure')

Defined in dom/document.ts:73

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFontElement

● createHTMLFontElement: function = _createElement('font')

Defined in dom/document.ts:74

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFooterElement

● createHTMLFooterElement: function = _createElement('footer')

Defined in dom/document.ts:75

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFormElement

● createHTMLFormElement: function = _createElement('form')

Defined in dom/document.ts:76

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFrameElement

● createHTMLFrameElement: function = _createElement('frame')

Defined in dom/document.ts:77

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLFramesetElement

● createHTMLFramesetElement: function = _createElement('frameset')

Defined in dom/document.ts:78

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLH1Element

● createHTMLH1Element: function = _createElement('h1')

Defined in dom/document.ts:79

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLH2Element

● createHTMLH2Element: function = _createElement('h2')

Defined in dom/document.ts:80

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLH3Element

● createHTMLH3Element: function = _createElement('h3')

Defined in dom/document.ts:81

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLH4Element

● createHTMLH4Element: function = _createElement('h4')

Defined in dom/document.ts:82

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLH5Element

● createHTMLH5Element: function = _createElement('h5')

Defined in dom/document.ts:83

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLH6Element

● createHTMLH6Element: function = _createElement('h6')

Defined in dom/document.ts:84

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLHeadElement

● createHTMLHeadElement: function = _createElement('head')

Defined in dom/document.ts:85

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLHeaderElement

● createHTMLHeaderElement: function = _createElement('header')

Defined in dom/document.ts:86

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLHgroupElement

● createHTMLHgroupElement: function = _createElement('hgroup')

Defined in dom/document.ts:87

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLHrElement

● createHTMLHrElement: function = _createElement('hr')

Defined in dom/document.ts:88

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLHtmlElement

● createHTMLHtmlElement: function = _createElement('html')

Defined in dom/document.ts:89

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLIElement

● createHTMLIElement: function = _createElement('i')

Defined in dom/document.ts:90

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLIframeElement

● createHTMLIframeElement: function = _createElement('iframe')

Defined in dom/document.ts:91

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLImgElement

● createHTMLImgElement: function = _createElement('img')

Defined in dom/document.ts:92

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLInputElement

● createHTMLInputElement: function = _createElement('input')

Defined in dom/document.ts:93

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLInsElement

● createHTMLInsElement: function = _createElement('ins')

Defined in dom/document.ts:94

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLKbdElement

● createHTMLKbdElement: function = _createElement('kbd')

Defined in dom/document.ts:96

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLLabelElement

● createHTMLLabelElement: function = _createElement('label')

Defined in dom/document.ts:98

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLLegendElement

● createHTMLLegendElement: function = _createElement('legend')

Defined in dom/document.ts:99

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLLiElement

● createHTMLLiElement: function = _createElement('li')

Defined in dom/document.ts:100

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLLinkElement

● createHTMLLinkElement: function = _createElement('link')

Defined in dom/document.ts:101

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLMapElement

● createHTMLMapElement: function = _createElement('map')

Defined in dom/document.ts:103

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLMarkElement

● createHTMLMarkElement: function = _createElement('mark')

Defined in dom/document.ts:104

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLMarkeeElement

● createHTMLMarkeeElement: function = _createElement('marquee')

Defined in dom/document.ts:105

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLMenuElement

● createHTMLMenuElement: function = _createElement('menu')

Defined in dom/document.ts:106

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLMetaElement

● createHTMLMetaElement: function = _createElement('meta')

Defined in dom/document.ts:108

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLMeterElement

● createHTMLMeterElement: function = _createElement('meter')

Defined in dom/document.ts:109

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLNavElement

● createHTMLNavElement: function = _createElement('nav')

Defined in dom/document.ts:110

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLNoScriptElement

● createHTMLNoScriptElement: function = _createElement('noscript')

Defined in dom/document.ts:112

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLObjectElement

● createHTMLObjectElement: function = _createElement('object')

Defined in dom/document.ts:113

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLOlElement

● createHTMLOlElement: function = _createElement('ol')

Defined in dom/document.ts:114

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLOptgroupElement

● createHTMLOptgroupElement: function = _createElement('optgroup')

Defined in dom/document.ts:115

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLOptionElement

● createHTMLOptionElement: function = _createElement('option')

Defined in dom/document.ts:116

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLOutputElement

● createHTMLOutputElement: function = _createElement('output')

Defined in dom/document.ts:117

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLPElement

● createHTMLPElement: function = _createElement('p')

Defined in dom/document.ts:118

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLParamElement

● createHTMLParamElement: function = _createElement('param')

Defined in dom/document.ts:119

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLPictureElement

● createHTMLPictureElement: function = _createElement('picture')

Defined in dom/document.ts:120

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLPreElement

● createHTMLPreElement: function = _createElement('pre')

Defined in dom/document.ts:121

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLProgressElement

● createHTMLProgressElement: function = _createElement('progress')

Defined in dom/document.ts:122

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLQElement

● createHTMLQElement: function = _createElement('q')

Defined in dom/document.ts:123

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLRtElement

● createHTMLRtElement: function = _createElement('rt')

Defined in dom/document.ts:125

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLRubyElement

● createHTMLRubyElement: function = _createElement('ruby')

Defined in dom/document.ts:126

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSElement

● createHTMLSElement: function = _createElement('s')

Defined in dom/document.ts:127

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSampElement

● createHTMLSampElement: function = _createElement('samp')

Defined in dom/document.ts:128

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLScriptElement

● createHTMLScriptElement: function = _createElement('script')

Defined in dom/document.ts:129

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSectionElement

● createHTMLSectionElement: function = _createElement('section')

Defined in dom/document.ts:130

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSelectElement

● createHTMLSelectElement: function = _createElement('select')

Defined in dom/document.ts:131

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSmallElement

● createHTMLSmallElement: function = _createElement('small')

Defined in dom/document.ts:132

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSourceElement

● createHTMLSourceElement: function = _createElement('source')

Defined in dom/document.ts:133

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSpanElement

● createHTMLSpanElement: function = _createElement('span')

Defined in dom/document.ts:134

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLStrongElement

● createHTMLStrongElement: function = _createElement('strong')

Defined in dom/document.ts:136

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLStyleElement

● createHTMLStyleElement: function = _createElement('style')

Defined in dom/document.ts:137

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSubElement

● createHTMLSubElement: function = _createElement('sub')

Defined in dom/document.ts:138

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLSupElement

● createHTMLSupElement: function = _createElement('sup')

Defined in dom/document.ts:140

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTableElement

● createHTMLTableElement: function = _createElement('table')

Defined in dom/document.ts:141

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTbodyElement

● createHTMLTbodyElement: function = _createElement('tbody')

Defined in dom/document.ts:142

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTdElement

● createHTMLTdElement: function = _createElement('td')

Defined in dom/document.ts:143

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTemplateElement

● createHTMLTemplateElement: function = _createElement('template')

Defined in dom/document.ts:144

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTextareaElement

● createHTMLTextareaElement: function = _createElement('textarea')

Defined in dom/document.ts:145

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTfootElement

● createHTMLTfootElement: function = _createElement('tfoot')

Defined in dom/document.ts:146

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLThElement

● createHTMLThElement: function = _createElement('th')

Defined in dom/document.ts:147

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTheadElement

● createHTMLTheadElement: function = _createElement('thead')

Defined in dom/document.ts:148

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTimeElement

● createHTMLTimeElement: function = _createElement('time')

Defined in dom/document.ts:149

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTitleElement

● createHTMLTitleElement: function = _createElement('title')

Defined in dom/document.ts:150

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTrElement

● createHTMLTrElement: function = _createElement('tr')

Defined in dom/document.ts:151

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLTrackElement

● createHTMLTrackElement: function = _createElement('track')

Defined in dom/document.ts:152

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLUElement

● createHTMLUElement: function = _createElement('u')

Defined in dom/document.ts:154

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLUlElement

● createHTMLUlElement: function = _createElement('ul')

Defined in dom/document.ts:155

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLVarElement

● createHTMLVarElement: function = _createElement('var')

Defined in dom/document.ts:156

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLVideoElement

● createHTMLVideoElement: function = _createElement('video')

Defined in dom/document.ts:157

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> createHTMLWbrElement

● createHTMLWbrElement: function = _createElement('wbr')

Defined in dom/document.ts:158

Type declaration

▸(aDoc?: Document): HTMLElementTagNameMap[T]

Parameters:

Name Type
Optional aDoc Document

Returns: HTMLElementTagNameMap[T]


<Const> docCreateElement

● docCreateElement: function & function = bindKey('createElement')

Defined in dom/document.ts:5


Functions

_createElement

_createElement<T>(aName: T): function

Defined in dom/document.ts:20

Function that creates an element and that returns the correct type

Type parameters:

T : keyof HTMLElementTagNameMap

Parameters:

Name Type Description
aName T the (lowercase) name of the tag

Returns: function the creator


<Const> createWchContentRefElement

createWchContentRefElement(aDoc?: Document): ContentRefComponent

Defined in dom/document.ts:27

Parameters:

Name Type
Optional aDoc Document

Returns: ContentRefComponent


@ibm-wch-sdk/web-components > "dom/index"

External module: "dom/index"

Index


@ibm-wch-sdk/web-components > "dom/node"

External module: "dom/node"

Index

Variables


Variables

<Const> nodeAppendChild

● nodeAppendChild: function = bindKey('appendChild')

Defined in dom/node.ts:3

Type declaration

▸<T>(aScope: Node, newChild: T): T

Type parameters:

T : Node

Parameters:

Name Type
aScope Node
newChild T

Returns: T


<Const> nodeCloneNode

● nodeCloneNode: function = bindKey( 'cloneNode' )

Defined in dom/node.ts:19

Type declaration

▸(aScope: Node, deep?: boolean): Node

Parameters:

Name Type
aScope Node
Optional deep boolean

Returns: Node


<Const> nodeInsertBefore

● nodeInsertBefore: function = bindKey('insertBefore')

Defined in dom/node.ts:15

Type declaration

▸<T>(aScope: Node, newChild: T, refChild: Node | null): T

Type parameters:

T : Node

Parameters:

Name Type
aScope Node
newChild T
refChild Node | null

Returns: T


<Const> nodeRemoveChild

● nodeRemoveChild: function = bindKey('removeChild')

Defined in dom/node.ts:11

Type declaration

▸<T>(aScope: Node, oldChild: T): T

Type parameters:

T : Node

Parameters:

Name Type
aScope Node
oldChild T

Returns: T


<Const> nodeReplaceChild

● nodeReplaceChild: function = bindKey('replaceChild')

Defined in dom/node.ts:7

Type declaration

▸<T>(aScope: Node, newChild: Node, oldChild: T): T

Type parameters:

T : Node

Parameters:

Name Type
aScope Node
newChild Node
oldChild T

Returns: T


@ibm-wch-sdk/web-components > "dom/predicates"

External module: "dom/predicates"

Index

Variables

Functions


Variables

<Const> isHTMLAbbrElement

● isHTMLAbbrElement: function = _isTagName('abbr')

Defined in dom/predicates.ts:23

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLAddressElement

● isHTMLAddressElement: function = _isTagName('address')

Defined in dom/predicates.ts:25

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLAnchorElement

● isHTMLAnchorElement: function = _isTagName('a')

Defined in dom/predicates.ts:22

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLAppletElement

● isHTMLAppletElement: function = _isTagName('applet')

Defined in dom/predicates.ts:26

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLAreaElement

● isHTMLAreaElement: function = _isTagName('area')

Defined in dom/predicates.ts:27

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLArticleElement

● isHTMLArticleElement: function = _isTagName('article')

Defined in dom/predicates.ts:28

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLAsideElement

● isHTMLAsideElement: function = _isTagName('aside')

Defined in dom/predicates.ts:29

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLAudioElement

● isHTMLAudioElement: function = _isTagName('audio')

Defined in dom/predicates.ts:30

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLBElement

● isHTMLBElement: function = _isTagName('b')

Defined in dom/predicates.ts:31

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLBaseElement

● isHTMLBaseElement: function = _isTagName('base')

Defined in dom/predicates.ts:32

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLBasefontElement

● isHTMLBasefontElement: function = _isTagName('basefont')

Defined in dom/predicates.ts:33

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLBdoElement

● isHTMLBdoElement: function = _isTagName('bdo')

Defined in dom/predicates.ts:35

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLBlockquoteElement

● isHTMLBlockquoteElement: function = _isTagName('blockquote')

Defined in dom/predicates.ts:37

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLBodyElement

● isHTMLBodyElement: function = _isTagName('body')

Defined in dom/predicates.ts:38

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLBrElement

● isHTMLBrElement: function = _isTagName('br')

Defined in dom/predicates.ts:39

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLButtonElement

● isHTMLButtonElement: function = _isTagName('button')

Defined in dom/predicates.ts:40

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLCanvasElement

● isHTMLCanvasElement: function = _isTagName('canvas')

Defined in dom/predicates.ts:41

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLCaptionElement

● isHTMLCaptionElement: function = _isTagName('caption')

Defined in dom/predicates.ts:42

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLCiteElement

● isHTMLCiteElement: function = _isTagName('cite')

Defined in dom/predicates.ts:44

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLCodeElement

● isHTMLCodeElement: function = _isTagName('code')

Defined in dom/predicates.ts:45

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLColElement

● isHTMLColElement: function = _isTagName('col')

Defined in dom/predicates.ts:46

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLColgroupElement

● isHTMLColgroupElement: function = _isTagName('colgroup')

Defined in dom/predicates.ts:47

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDatalistElement

● isHTMLDatalistElement: function = _isTagName('datalist')

Defined in dom/predicates.ts:49

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDdElement

● isHTMLDdElement: function = _isTagName('dd')

Defined in dom/predicates.ts:50

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDelElement

● isHTMLDelElement: function = _isTagName('del')

Defined in dom/predicates.ts:51

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDfnElement

● isHTMLDfnElement: function = _isTagName('dfn')

Defined in dom/predicates.ts:53

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDirElement

● isHTMLDirElement: function = _isTagName('dir')

Defined in dom/predicates.ts:55

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDivElement

● isHTMLDivElement: function = _isTagName('div')

Defined in dom/predicates.ts:56

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDlElement

● isHTMLDlElement: function = _isTagName('dl')

Defined in dom/predicates.ts:57

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLDtElement

● isHTMLDtElement: function = _isTagName('dt')

Defined in dom/predicates.ts:58

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLEmElement

● isHTMLEmElement: function = _isTagName('em')

Defined in dom/predicates.ts:59

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLEmbedElement

● isHTMLEmbedElement: function = _isTagName('embed')

Defined in dom/predicates.ts:60

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLFieldsetElement

● isHTMLFieldsetElement: function = _isTagName('fieldset')

Defined in dom/predicates.ts:61

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLFigcaptionElement

● isHTMLFigcaptionElement: function = _isTagName('figcaption')

Defined in dom/predicates.ts:62

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLFigureElement

● isHTMLFigureElement: function = _isTagName('figure')

Defined in dom/predicates.ts:63

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLFontElement

● isHTMLFontElement: function = _isTagName('font')

Defined in dom/predicates.ts:64

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLFooterElement

● isHTMLFooterElement: function = _isTagName('footer')

Defined in dom/predicates.ts:65

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLFormElement

● isHTMLFormElement: function = _isTagName('form')

Defined in dom/predicates.ts:66

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLH1Element

● isHTMLH1Element: function = _isTagName('h1')

Defined in dom/predicates.ts:67

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLH2Element

● isHTMLH2Element: function = _isTagName('h2')

Defined in dom/predicates.ts:68

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLH3Element

● isHTMLH3Element: function = _isTagName('h3')

Defined in dom/predicates.ts:69

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLH4Element

● isHTMLH4Element: function = _isTagName('h4')

Defined in dom/predicates.ts:70

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLH5Element

● isHTMLH5Element: function = _isTagName('h5')

Defined in dom/predicates.ts:71

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLH6Element

● isHTMLH6Element: function = _isTagName('h6')

Defined in dom/predicates.ts:72

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLHeadElement

● isHTMLHeadElement: function = _isTagName('head')

Defined in dom/predicates.ts:73

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLHeaderElement

● isHTMLHeaderElement: function = _isTagName('header')

Defined in dom/predicates.ts:74

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLHgroupElement

● isHTMLHgroupElement: function = _isTagName('hgroup')

Defined in dom/predicates.ts:75

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLHrElement

● isHTMLHrElement: function = _isTagName('hr')

Defined in dom/predicates.ts:76

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLHtmlElement

● isHTMLHtmlElement: function = _isTagName('html')

Defined in dom/predicates.ts:77

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLIElement

● isHTMLIElement: function = _isTagName('i')

Defined in dom/predicates.ts:78

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLIframeElement

● isHTMLIframeElement: function = _isTagName('iframe')

Defined in dom/predicates.ts:79

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLImgElement

● isHTMLImgElement: function = _isTagName('img')

Defined in dom/predicates.ts:80

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLInputElement

● isHTMLInputElement: function = _isTagName('input')

Defined in dom/predicates.ts:81

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLInsElement

● isHTMLInsElement: function = _isTagName('ins')

Defined in dom/predicates.ts:82

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLKbdElement

● isHTMLKbdElement: function = _isTagName('kbd')

Defined in dom/predicates.ts:84

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLLabelElement

● isHTMLLabelElement: function = _isTagName('label')

Defined in dom/predicates.ts:86

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLLegendElement

● isHTMLLegendElement: function = _isTagName('legend')

Defined in dom/predicates.ts:87

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLLiElement

● isHTMLLiElement: function = _isTagName('li')

Defined in dom/predicates.ts:88

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLLinkElement

● isHTMLLinkElement: function = _isTagName('link')

Defined in dom/predicates.ts:89

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLMapElement

● isHTMLMapElement: function = _isTagName('map')

Defined in dom/predicates.ts:91

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLMarkElement

● isHTMLMarkElement: function = _isTagName('mark')

Defined in dom/predicates.ts:92

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLMenuElement

● isHTMLMenuElement: function = _isTagName('menu')

Defined in dom/predicates.ts:93

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLMetaElement

● isHTMLMetaElement: function = _isTagName('meta')

Defined in dom/predicates.ts:95

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLMeterElement

● isHTMLMeterElement: function = _isTagName('meter')

Defined in dom/predicates.ts:96

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLNavElement

● isHTMLNavElement: function = _isTagName('nav')

Defined in dom/predicates.ts:97

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLNoScriptElement

● isHTMLNoScriptElement: function = _isTagName('noscript')

Defined in dom/predicates.ts:99

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLObjectElement

● isHTMLObjectElement: function = _isTagName('object')

Defined in dom/predicates.ts:100

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLOlElement

● isHTMLOlElement: function = _isTagName('ol')

Defined in dom/predicates.ts:101

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLOptgroupElement

● isHTMLOptgroupElement: function = _isTagName('optgroup')

Defined in dom/predicates.ts:102

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLOptionElement

● isHTMLOptionElement: function = _isTagName('option')

Defined in dom/predicates.ts:103

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLOutputElement

● isHTMLOutputElement: function = _isTagName('output')

Defined in dom/predicates.ts:104

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLPElement

● isHTMLPElement: function = _isTagName('p')

Defined in dom/predicates.ts:105

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLParamElement

● isHTMLParamElement: function = _isTagName('param')

Defined in dom/predicates.ts:106

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLPreElement

● isHTMLPreElement: function = _isTagName('pre')

Defined in dom/predicates.ts:107

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLProgressElement

● isHTMLProgressElement: function = _isTagName('progress')

Defined in dom/predicates.ts:108

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLQElement

● isHTMLQElement: function = _isTagName('q')

Defined in dom/predicates.ts:109

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLRtElement

● isHTMLRtElement: function = _isTagName('rt')

Defined in dom/predicates.ts:111

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLRubyElement

● isHTMLRubyElement: function = _isTagName('ruby')

Defined in dom/predicates.ts:112

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSElement

● isHTMLSElement: function = _isTagName('s')

Defined in dom/predicates.ts:113

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSampElement

● isHTMLSampElement: function = _isTagName('samp')

Defined in dom/predicates.ts:114

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLScriptElement

● isHTMLScriptElement: function = _isTagName('script')

Defined in dom/predicates.ts:115

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSectionElement

● isHTMLSectionElement: function = _isTagName('section')

Defined in dom/predicates.ts:116

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSelectElement

● isHTMLSelectElement: function = _isTagName('select')

Defined in dom/predicates.ts:117

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSmallElement

● isHTMLSmallElement: function = _isTagName('small')

Defined in dom/predicates.ts:118

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSourceElement

● isHTMLSourceElement: function = _isTagName('source')

Defined in dom/predicates.ts:119

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSpanElement

● isHTMLSpanElement: function = _isTagName('span')

Defined in dom/predicates.ts:120

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLStrongElement

● isHTMLStrongElement: function = _isTagName('strong')

Defined in dom/predicates.ts:122

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLStyleElement

● isHTMLStyleElement: function = _isTagName('style')

Defined in dom/predicates.ts:123

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSubElement

● isHTMLSubElement: function = _isTagName('sub')

Defined in dom/predicates.ts:124

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLSupElement

● isHTMLSupElement: function = _isTagName('sup')

Defined in dom/predicates.ts:126

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTableElement

● isHTMLTableElement: function = _isTagName('table')

Defined in dom/predicates.ts:127

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTbodyElement

● isHTMLTbodyElement: function = _isTagName('tbody')

Defined in dom/predicates.ts:128

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTdElement

● isHTMLTdElement: function = _isTagName('td')

Defined in dom/predicates.ts:129

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTextareaElement

● isHTMLTextareaElement: function = _isTagName('textarea')

Defined in dom/predicates.ts:130

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTfootElement

● isHTMLTfootElement: function = _isTagName('tfoot')

Defined in dom/predicates.ts:131

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLThElement

● isHTMLThElement: function = _isTagName('th')

Defined in dom/predicates.ts:132

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTheadElement

● isHTMLTheadElement: function = _isTagName('thead')

Defined in dom/predicates.ts:133

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTimeElement

● isHTMLTimeElement: function = _isTagName('time')

Defined in dom/predicates.ts:134

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTitleElement

● isHTMLTitleElement: function = _isTagName('title')

Defined in dom/predicates.ts:135

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTrElement

● isHTMLTrElement: function = _isTagName('tr')

Defined in dom/predicates.ts:136

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLTrackElement

● isHTMLTrackElement: function = _isTagName('track')

Defined in dom/predicates.ts:137

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLUElement

● isHTMLUElement: function = _isTagName('u')

Defined in dom/predicates.ts:139

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLUlElement

● isHTMLUlElement: function = _isTagName('ul')

Defined in dom/predicates.ts:140

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLVarElement

● isHTMLVarElement: function = _isTagName('var')

Defined in dom/predicates.ts:141

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLVideoElement

● isHTMLVideoElement: function = _isTagName('video')

Defined in dom/predicates.ts:142

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


<Const> isHTMLWbrElement

● isHTMLWbrElement: function = _isTagName('wbr')

Defined in dom/predicates.ts:143

Type declaration

▸(aValue: any): boolean

Parameters:

Name Type
aValue any

Returns: boolean


Functions

_isTagName

_isTagName<T>(aName: T): IsPredicate<HTMLElementTagNameMap[T]>

Defined in dom/predicates.ts:15

Function that tests for the correct name and uses typescript magic to convert the tag name into the corresponding typescript type

Type parameters:

T : keyof HTMLElementTagNameMap

Parameters:

Name Type Description
aName T the (lowercase) name of the tag

Returns: IsPredicate<HTMLElementTagNameMap[T]> the predicate that checks for the element type


_testTagName

_testTagName(aName: string, aValue: any): boolean

Defined in dom/predicates.ts:4

Function that executes the actual test

Parameters:

Name Type
aName string
aValue any

Returns: boolean


@ibm-wch-sdk/web-components > "index"

External module: "index"

Index


@ibm-wch-sdk/web-components > "init/components"

External module: "init/components"

Index

Variables


Variables

<Const> WCH_CONTENT

● WCH_CONTENT: "wch-content" = "wch-content"

Defined in init/components.ts:2


<Const> WCH_CONTENT_REF

● WCH_CONTENT_REF: "wch-contentref" = "wch-contentref"

Defined in init/components.ts:1


<Const> WCH_PAGE

● WCH_PAGE: "wch-page" = "wch-page"

Defined in init/components.ts:3


@ibm-wch-sdk/web-components > "init/index"

External module: "init/index"

Index


@ibm-wch-sdk/web-components > "init/init"

External module: "init/init"

Index

Functions


Functions

initSdkComponents

initSdkComponents(): void

Defined in init/init.ts:7

Returns: void


@ibm-wch-sdk/web-components > "layout-not-found/layout.not.found.component"

External module: "layout-not-found/layout.not.found.component"

Index

Classes


@ibm-wch-sdk/web-components > "page/page.component"

External module: "page/page.component"

Index

Classes

Variables

Functions


Variables

<Const> LOGGER

● LOGGER: "wch-page" = WCH_PAGE

Defined in page/page.component.ts:11


Functions

_getTitle

_getTitle(aSitePage: SitePage, aRenderingContext: RenderingContext): string

Defined in page/page.component.ts:21

Parameters:

Name Type
aSitePage SitePage
aRenderingContext RenderingContext

Returns: string


@ibm-wch-sdk/web-components > "utils/component.utils"

External module: "utils/component.utils"

Index

Variables

Functions


Variables

<Const> trackByContentId

● trackByContentId: UnaryFunction<RenderingContext, string> = pluckProperty<RenderingContext, 'id'>('id')

Defined in utils/component.utils.ts:18

Extracts the ID of the rendering context for tracking purposes


Functions

assertComponent

assertComponent(aName: string, aParent: Node): Generator<HTMLElement>

Defined in utils/component.utils.ts:20

Parameters:

Name Type
aName string
aParent Node

Returns: Generator<HTMLElement>


assertContentRef

assertContentRef(aParent: Node): Generator<HTMLElement>

Defined in utils/component.utils.ts:29

Parameters:

Name Type
aParent Node

Returns: Generator<HTMLElement>


opContentRef

opContentRef(aLayoutMode: Observable<string>, aRenderingContext: Observable<RenderingContext>, aParent: Node): OperatorFunction<any, HTMLElement>

Defined in utils/component.utils.ts:33

Parameters:

Name Type
aLayoutMode Observable<string>
aRenderingContext Observable<RenderingContext>
aParent Node

Returns: OperatorFunction<any, HTMLElement>


@ibm-wch-sdk/web-components > "utils/index"

External module: "utils/index"

Index


@ibm-wch-sdk/web-components > "utils/logging.utils"

External module: "utils/logging.utils"

Index

Functions


Functions

rxLog

rxLog<T>(aLogger: Observable<Logger>): function

Defined in utils/logging.utils.ts:7

Type parameters:

T

Parameters:

Name Type
aLogger Observable<Logger>

Returns: function


rxLogService

rxLogService<T>(aLogger: string, aLoggerService: Observable<LoggerService>): function

Defined in utils/logging.utils.ts:24

Type parameters:

T

Parameters:

Name Type
aLogger string
aLoggerService Observable<LoggerService>

Returns: function


@ibm-wch-sdk/web-components > "utils/logic"

External module: "utils/logic"

Index

Type aliases

Functions


Type aliases

ElementCreate

Ƭ ElementCreate: Generator<R>

Defined in utils/logic.ts:20


ElementKey

Ƭ ElementKey: UnaryFunction<T, K>

Defined in utils/logic.ts:22


ElementUpdate

Ƭ ElementUpdate: function

Defined in utils/logic.ts:15

Type declaration

▸(aCtx: T, aElement: R, aIndex?: number): R

Parameters:

Name Type
aCtx T
aElement R
Optional aIndex number

Returns: R


WcForEachState

Ƭ WcForEachState: [Map<K, R>, Map<K, R>, R[]]

Defined in utils/logic.ts:52


WcIfState

Ƭ WcIfState: [R, boolean, T]

Defined in utils/logic.ts:137


Functions

accForEach

accForEach<T,R,K>(aParentNode: Node, aRefAfter: Node | null, aUpdate: ElementUpdate<T, R>, aCreate: ElementCreate<R>, aKey: ElementKey<T, K>, aState: WcForEachState<R, K>, aValues: T[]): WcForEachState<R, K>

Defined in utils/logic.ts:55

Type parameters:

T

R : HTMLElement

K

Parameters:

Name Type
aParentNode Node
aRefAfter Node | null
aUpdate ElementUpdate<T, R>
aCreate ElementCreate<R>
aKey ElementKey<T, K>
aState WcForEachState<R, K>
aValues T[]

Returns: WcForEachState<R, K>


createElementCreate

createElementCreate<R>(aCreate: ElementCreate<R> | string, aDocument?: Document): ElementCreate<R>

Defined in utils/logic.ts:37

Type parameters:

R : HTMLElement

Parameters:

Name Type
aCreate ElementCreate<R> | string
Optional aDocument Document

Returns: ElementCreate<R>


elementCreate

elementCreate<R>(aName: string, aDocument?: Document): ElementCreate<R>

Defined in utils/logic.ts:27

Default implementation of the create element function

Type parameters:

R : HTMLElement

Parameters:

Name Type
aName string
Optional aDocument Document

Returns: ElementCreate<R>


removeNode

removeNode(aNode: Node): void

Defined in utils/logic.ts:44

Parameters:

Name Type
aNode Node

Returns: void


wcForEach

wcForEach<T,R,K>(aParentNode: Node, aRefAfter: Node | null, aUpdate: ElementUpdate<T, R>, aCreate: ElementCreate<R> | string, aKey: ElementKey<T, K>, aDocument?: Document): OperatorFunction<T[], R[]>

Defined in utils/logic.ts:107

Implementation of a for loop

Type parameters:

T

R : HTMLElement

K

Parameters:

Name Type Description
aParentNode Node parent node
aRefAfter Node | null reference node as the last child
aUpdate ElementUpdate<T, R> update function
aCreate ElementCreate<R> | string element creator or simply the name of the html element
aKey ElementKey<T, K> key function, can be the identity function
Optional aDocument Document the document

Returns: OperatorFunction<T[], R[]>


wcIf

wcIf<T,R>(aPredicate: Predicate<T>, aParentNode: Node, aRefChild: Node | null, aUpdate: ElementUpdate<T, R>, aCreate: ElementCreate<R> | string, aDocument?: Document): OperatorFunction<T, R>

Defined in utils/logic.ts:151

Implementation of an if statement that shows or hides a corresponding UI item

Type parameters:

T

R : HTMLElement

Parameters:

Name Type Description
aPredicate Predicate<T> predicate to test
aParentNode Node parent node
aRefChild Node | null next child, can be null
aUpdate ElementUpdate<T, R> update callback
aCreate ElementCreate<R> | string element creator or simply the name of the html element
Optional aDocument Document the document object

Returns: OperatorFunction<T, R> operator that manages the element


@ibm-wch-sdk/web-components

Index

External modules


@ibm-wch-sdk/web-components > "base/abstract.base.component" > AbstractBaseComponent

Class: AbstractBaseComponent

Hierarchy

HTMLElement

↳ AbstractBaseComponent

AbstractRenderingComponent

ContentComponent

PageComponent

Index

Constructors

Properties

Accessors

Methods


Constructors

constructor

new AbstractBaseComponent(): AbstractBaseComponent

Defined in base/abstract.base.component.ts:32

Returns: AbstractBaseComponent


Properties

ATTRIBUTE_NODE

● ATTRIBUTE_NODE: number

Inherited from Node.ATTRIBUTE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10362


CDATA_SECTION_NODE

● CDATA_SECTION_NODE: number

Inherited from Node.CDATA_SECTION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10363


COMMENT_NODE

● COMMENT_NODE: number

Inherited from Node.COMMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10364


DOCUMENT_FRAGMENT_NODE

● DOCUMENT_FRAGMENT_NODE: number

Inherited from Node.DOCUMENT_FRAGMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10365


DOCUMENT_NODE

● DOCUMENT_NODE: number

Inherited from Node.DOCUMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10366


DOCUMENT_POSITION_CONTAINED_BY

● DOCUMENT_POSITION_CONTAINED_BY: number

Inherited from Node.DOCUMENT_POSITION_CONTAINED_BY

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10367


DOCUMENT_POSITION_CONTAINS

● DOCUMENT_POSITION_CONTAINS: number

Inherited from Node.DOCUMENT_POSITION_CONTAINS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10368


DOCUMENT_POSITION_DISCONNECTED

● DOCUMENT_POSITION_DISCONNECTED: number

Inherited from Node.DOCUMENT_POSITION_DISCONNECTED

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10369


DOCUMENT_POSITION_FOLLOWING

● DOCUMENT_POSITION_FOLLOWING: number

Inherited from Node.DOCUMENT_POSITION_FOLLOWING

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10370


DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

● DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Inherited from Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10371


DOCUMENT_POSITION_PRECEDING

● DOCUMENT_POSITION_PRECEDING: number

Inherited from Node.DOCUMENT_POSITION_PRECEDING

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10372


DOCUMENT_TYPE_NODE

● DOCUMENT_TYPE_NODE: number

Inherited from Node.DOCUMENT_TYPE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10373


ELEMENT_NODE

● ELEMENT_NODE: number

Inherited from Node.ELEMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10374


ENTITY_NODE

● ENTITY_NODE: number

Inherited from Node.ENTITY_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10375


ENTITY_REFERENCE_NODE

● ENTITY_REFERENCE_NODE: number

Inherited from Node.ENTITY_REFERENCE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10376


NOTATION_NODE

● NOTATION_NODE: number

Inherited from Node.NOTATION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10377


PROCESSING_INSTRUCTION_NODE

● PROCESSING_INSTRUCTION_NODE: number

Inherited from Node.PROCESSING_INSTRUCTION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10378


TEXT_NODE

● TEXT_NODE: number

Inherited from Node.TEXT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10379


<Private> _destroy

● _destroy: Consumer<this>

Defined in base/abstract.base.component.ts:20


<Private> _init

● _init: Consumer<this>

Defined in base/abstract.base.component.ts:19


<Private> _layoutMode

● _layoutMode: Consumer<string>

Defined in base/abstract.base.component.ts:21


<Protected> _onDestroy

● _onDestroy: Observable<this>

Defined in base/abstract.base.component.ts:24


<Protected> _onInit

● _onInit: Observable<this>

Defined in base/abstract.base.component.ts:23


<Protected> _onLayoutMode

● _onLayoutMode: Observable<string>

Defined in base/abstract.base.component.ts:30


<Protected> _onLoggerService

● _onLoggerService: Observable<LoggerService>

Defined in base/abstract.base.component.ts:28


<Protected> _onSdk

● _onSdk: Observable<WchSdk>

Defined in base/abstract.base.component.ts:26


accessKey

● accessKey: string

Inherited from HTMLElement.accessKey

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6066


accessKeyLabel

● accessKeyLabel: string

Inherited from HTMLElement.accessKeyLabel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6067


assignedSlot

● assignedSlot: HTMLSlotElement | null

Inherited from Element.assignedSlot

Overrides Slotable.assignedSlot

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4659


attributes

● attributes: NamedNodeMap

Inherited from Element.attributes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4660


autocapitalize

● autocapitalize: string

Inherited from HTMLElement.autocapitalize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6068


baseURI

● baseURI: string

Inherited from Node.baseURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10264

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


childElementCount

● childElementCount: number

Inherited from ParentNode.childElementCount

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10709


childNodes

● childNodes: NodeListOf<ChildNode>

Inherited from Node.childNodes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10268

Returns the children.


children

● children: HTMLCollection

Inherited from ParentNode.children

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10713

Returns the child elements.


classList

● classList: DOMTokenList

Inherited from Element.classList

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4665

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


className

● className: string

Inherited from Element.className

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4670

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


clientHeight

● clientHeight: number

Inherited from Element.clientHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4671


clientLeft

● clientLeft: number

Inherited from Element.clientLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4672


clientTop

● clientTop: number

Inherited from Element.clientTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4673


clientWidth

● clientWidth: number

Inherited from Element.clientWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4674


contentEditable

● contentEditable: string

Inherited from ElementContentEditable.contentEditable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4824


dataset

● dataset: DOMStringMap

Inherited from HTMLOrSVGElement.dataset

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7555


dir

● dir: string

Inherited from HTMLElement.dir

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6069


draggable

● draggable: boolean

Inherited from HTMLElement.draggable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6070


firstChild

● firstChild: ChildNode | null

Inherited from Node.firstChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10272

Returns the first child.


firstElementChild

● firstElementChild: Element | null

Inherited from ParentNode.firstElementChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10717

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


hidden

● hidden: boolean

Inherited from HTMLElement.hidden

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6071


id

● id: string

Inherited from Element.id

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4679

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


innerHTML

● innerHTML: string

Inherited from Element.innerHTML

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4680


innerText

● innerText: string

Inherited from HTMLElement.innerText

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6072


inputMode

● inputMode: string

Inherited from ElementContentEditable.inputMode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4825


isConnected

● isConnected: boolean

Inherited from Node.isConnected

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10276

Returns true if node is connected and false otherwise.


isContentEditable

● isContentEditable: boolean

Inherited from ElementContentEditable.isContentEditable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4826


lang

● lang: string

Inherited from HTMLElement.lang

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6073


lastChild

● lastChild: ChildNode | null

Inherited from Node.lastChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10280

Returns the last child.


lastElementChild

● lastElementChild: Element | null

Inherited from ParentNode.lastElementChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10721

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


localName

● localName: string

Inherited from Element.localName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4684

Returns the local name.


namespaceURI

● namespaceURI: string | null

Inherited from Element.namespaceURI

Overrides Node.namespaceURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4688

Returns the namespace.


nextElementSibling

● nextElementSibling: Element | null

Inherited from NonDocumentTypeChildNode.nextElementSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10493

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


nextSibling

● nextSibling: Node | null

Inherited from Node.nextSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10285

Returns the next sibling.


nodeName

● nodeName: string

Inherited from Node.nodeName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10308

Returns a string appropriate for the type of node, as follows: Element Its HTML-uppercased qualified name. Attr Its qualified name. Text "#text". CDATASection "#cdata-section". ProcessingInstruction Its target. Comment "#comment". Document "#document". DocumentType Its name. DocumentFragment "#document-fragment".


nodeType

● nodeType: number

Inherited from Node.nodeType

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10309


nodeValue

● nodeValue: string | null

Inherited from Node.nodeValue

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10310


nonce

● nonce: string

Inherited from HTMLOrSVGElement.nonce

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7556


offsetHeight

● offsetHeight: number

Inherited from HTMLElement.offsetHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6074


offsetLeft

● offsetLeft: number

Inherited from HTMLElement.offsetLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6075


offsetParent

● offsetParent: Element | null

Inherited from HTMLElement.offsetParent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6076


offsetTop

● offsetTop: number

Inherited from HTMLElement.offsetTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6077


offsetWidth

● offsetWidth: number

Inherited from HTMLElement.offsetWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6078


onabort

● onabort: function | null

Inherited from GlobalEventHandlers.onabort

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5269

Fires when the user aborts the download.

param: The event.


onanimationcancel

● onanimationcancel: function | null

Inherited from GlobalEventHandlers.onanimationcancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5270


onanimationend

● onanimationend: function | null

Inherited from GlobalEventHandlers.onanimationend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5271


onanimationiteration

● onanimationiteration: function | null

Inherited from GlobalEventHandlers.onanimationiteration

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5272


onanimationstart

● onanimationstart: function | null

Inherited from GlobalEventHandlers.onanimationstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5273


onauxclick

● onauxclick: function | null

Inherited from GlobalEventHandlers.onauxclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5274


onblur

● onblur: function | null

Inherited from GlobalEventHandlers.onblur

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5279

Fires when the object loses the input focus.

param: The focus event.


oncancel

● oncancel: function | null

Inherited from GlobalEventHandlers.oncancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5280


oncanplay

● oncanplay: function | null

Inherited from GlobalEventHandlers.oncanplay

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5285

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

param: The event.


oncanplaythrough

● oncanplaythrough: function | null

Inherited from GlobalEventHandlers.oncanplaythrough

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5286


onchange

● onchange: function | null

Inherited from GlobalEventHandlers.onchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5291

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

param: The event.


onclick

● onclick: function | null

Inherited from GlobalEventHandlers.onclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5296

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

param: The mouse event.


onclose

● onclose: function | null

Inherited from GlobalEventHandlers.onclose

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5297


oncontextmenu

● oncontextmenu: function | null

Inherited from GlobalEventHandlers.oncontextmenu

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5302

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

param: The mouse event.


oncopy

● oncopy: function | null

Inherited from DocumentAndElementEventHandlers.oncopy

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4468


oncuechange

● oncuechange: function | null

Inherited from GlobalEventHandlers.oncuechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5303


oncut

● oncut: function | null

Inherited from DocumentAndElementEventHandlers.oncut

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4469


ondblclick

● ondblclick: function | null

Inherited from GlobalEventHandlers.ondblclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5308

Fires when the user double-clicks the object.

param: The mouse event.


ondrag

● ondrag: function | null

Inherited from GlobalEventHandlers.ondrag

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5313

Fires on the source object continuously during a drag operation.

param: The event.


ondragend

● ondragend: function | null

Inherited from GlobalEventHandlers.ondragend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5318

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

param: The event.


ondragenter

● ondragenter: function | null

Inherited from GlobalEventHandlers.ondragenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5323

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

param: The drag event.


ondragexit

● ondragexit: function | null

Inherited from GlobalEventHandlers.ondragexit

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5324


ondragleave

● ondragleave: function | null

Inherited from GlobalEventHandlers.ondragleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5329

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

param: The drag event.


ondragover

● ondragover: function | null

Inherited from GlobalEventHandlers.ondragover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5334

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

param: The event.


ondragstart

● ondragstart: function | null

Inherited from GlobalEventHandlers.ondragstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5339

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

param: The event.


ondrop

● ondrop: function | null

Inherited from GlobalEventHandlers.ondrop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5340


ondurationchange

● ondurationchange: function | null

Inherited from GlobalEventHandlers.ondurationchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5345

Occurs when the duration attribute is updated.

param: The event.


onemptied

● onemptied: function | null

Inherited from GlobalEventHandlers.onemptied

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5350

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

param: The event.


onended

● onended: function | null

Inherited from GlobalEventHandlers.onended

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5355

Occurs when the end of playback is reached.

param: The event


onerror

● onerror: ErrorEventHandler

Inherited from GlobalEventHandlers.onerror

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5360

Fires when an error occurs during object loading.

param: The event.


onfocus

● onfocus: function | null

Inherited from GlobalEventHandlers.onfocus

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5365

Fires when the object receives focus.

param: The event.


onfullscreenchange

● onfullscreenchange: function | null

Inherited from Element.onfullscreenchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4689


onfullscreenerror

● onfullscreenerror: function | null

Inherited from Element.onfullscreenerror

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4690


ongotpointercapture

● ongotpointercapture: function | null

Inherited from GlobalEventHandlers.ongotpointercapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5366


oninput

● oninput: function | null

Inherited from GlobalEventHandlers.oninput

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5367


oninvalid

● oninvalid: function | null

Inherited from GlobalEventHandlers.oninvalid

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5368


onkeydown

● onkeydown: function | null

Inherited from GlobalEventHandlers.onkeydown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5373

Fires when the user presses a key.

param: The keyboard event


onkeypress

● onkeypress: function | null

Inherited from GlobalEventHandlers.onkeypress

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5378

Fires when the user presses an alphanumeric key.

param: The event.


onkeyup

● onkeyup: function | null

Inherited from GlobalEventHandlers.onkeyup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5383

Fires when the user releases a key.

param: The keyboard event


onload

● onload: function | null

Inherited from GlobalEventHandlers.onload

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5388

Fires immediately after the browser loads the object.

param: The event.


onloadeddata

● onloadeddata: function | null

Inherited from GlobalEventHandlers.onloadeddata

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5393

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

param: The event.


onloadedmetadata

● onloadedmetadata: function | null

Inherited from GlobalEventHandlers.onloadedmetadata

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5398

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

param: The event.


onloadend

● onloadend: function | null

Inherited from GlobalEventHandlers.onloadend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5399


onloadstart

● onloadstart: function | null

Inherited from GlobalEventHandlers.onloadstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5404

Occurs when Internet Explorer begins looking for media data.

param: The event.


onlostpointercapture

● onlostpointercapture: function | null

Inherited from GlobalEventHandlers.onlostpointercapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5405


onmousedown

● onmousedown: function | null

Inherited from GlobalEventHandlers.onmousedown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5410

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

param: The mouse event.


onmouseenter

● onmouseenter: function | null

Inherited from GlobalEventHandlers.onmouseenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5411


onmouseleave

● onmouseleave: function | null

Inherited from GlobalEventHandlers.onmouseleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5412


onmousemove

● onmousemove: function | null

Inherited from GlobalEventHandlers.onmousemove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5417

Fires when the user moves the mouse over the object.

param: The mouse event.


onmouseout

● onmouseout: function | null

Inherited from GlobalEventHandlers.onmouseout

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5422

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

param: The mouse event.


onmouseover

● onmouseover: function | null

Inherited from GlobalEventHandlers.onmouseover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5427

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

param: The mouse event.


onmouseup

● onmouseup: function | null

Inherited from GlobalEventHandlers.onmouseup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5432

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

param: The mouse event.


onpaste

● onpaste: function | null

Inherited from DocumentAndElementEventHandlers.onpaste

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4470


onpause

● onpause: function | null

Inherited from GlobalEventHandlers.onpause

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5437

Occurs when playback is paused.

param: The event.


onplay

● onplay: function | null

Inherited from GlobalEventHandlers.onplay

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5442

Occurs when the play method is requested.

param: The event.


onplaying

● onplaying: function | null

Inherited from GlobalEventHandlers.onplaying

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5447

Occurs when the audio or video has started playing.

param: The event.


onpointercancel

● onpointercancel: function | null

Inherited from GlobalEventHandlers.onpointercancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5448


onpointerdown

● onpointerdown: function | null

Inherited from GlobalEventHandlers.onpointerdown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5449


onpointerenter

● onpointerenter: function | null

Inherited from GlobalEventHandlers.onpointerenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5450


onpointerleave

● onpointerleave: function | null

Inherited from GlobalEventHandlers.onpointerleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5451


onpointermove

● onpointermove: function | null

Inherited from GlobalEventHandlers.onpointermove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5452


onpointerout

● onpointerout: function | null

Inherited from GlobalEventHandlers.onpointerout

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5453


onpointerover

● onpointerover: function | null

Inherited from GlobalEventHandlers.onpointerover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5454


onpointerup

● onpointerup: function | null

Inherited from GlobalEventHandlers.onpointerup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5455


onprogress

● onprogress: function | null

Inherited from GlobalEventHandlers.onprogress

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5460

Occurs to indicate progress while downloading media data.

param: The event.


onratechange

● onratechange: function | null

Inherited from GlobalEventHandlers.onratechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5465

Occurs when the playback rate is increased or decreased.

param: The event.


onreset

● onreset: function | null

Inherited from GlobalEventHandlers.onreset

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5470

Fires when the user resets a form.

param: The event.


onresize

● onresize: function | null

Inherited from GlobalEventHandlers.onresize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5471


onscroll

● onscroll: function | null

Inherited from GlobalEventHandlers.onscroll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5476

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

param: The event.


onsecuritypolicyviolation

● onsecuritypolicyviolation: function | null

Inherited from GlobalEventHandlers.onsecuritypolicyviolation

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5477


onseeked

● onseeked: function | null

Inherited from GlobalEventHandlers.onseeked

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5482

Occurs when the seek operation ends.

param: The event.


onseeking

● onseeking: function | null

Inherited from GlobalEventHandlers.onseeking

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5487

Occurs when the current playback position is moved.

param: The event.


onselect

● onselect: function | null

Inherited from GlobalEventHandlers.onselect

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5492

Fires when the current selection changes.

param: The event.


onstalled

● onstalled: function | null

Inherited from GlobalEventHandlers.onstalled

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5497

Occurs when the download has stopped.

param: The event.


onsubmit

● onsubmit: function | null

Inherited from GlobalEventHandlers.onsubmit

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5498


onsuspend

● onsuspend: function | null

Inherited from GlobalEventHandlers.onsuspend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5503

Occurs if the load operation has been intentionally halted.

param: The event.


ontimeupdate

● ontimeupdate: function | null

Inherited from GlobalEventHandlers.ontimeupdate

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5508

Occurs to indicate the current playback position.

param: The event.


ontoggle

● ontoggle: function | null

Inherited from GlobalEventHandlers.ontoggle

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5509


ontouchcancel

● ontouchcancel: function | null

Inherited from GlobalEventHandlers.ontouchcancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5510


ontouchend

● ontouchend: function | null

Inherited from GlobalEventHandlers.ontouchend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5511


ontouchmove

● ontouchmove: function | null

Inherited from GlobalEventHandlers.ontouchmove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5512


ontouchstart

● ontouchstart: function | null

Inherited from GlobalEventHandlers.ontouchstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5513


ontransitioncancel

● ontransitioncancel: function | null

Inherited from GlobalEventHandlers.ontransitioncancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5514


ontransitionend

● ontransitionend: function | null

Inherited from GlobalEventHandlers.ontransitionend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5515


ontransitionrun

● ontransitionrun: function | null

Inherited from GlobalEventHandlers.ontransitionrun

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5516


ontransitionstart

● ontransitionstart: function | null

Inherited from GlobalEventHandlers.ontransitionstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5517


onvolumechange

● onvolumechange: function | null

Inherited from GlobalEventHandlers.onvolumechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5522

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

param: The event.


onwaiting

● onwaiting: function | null

Inherited from GlobalEventHandlers.onwaiting

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5527

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

param: The event.


onwheel

● onwheel: function | null

Inherited from GlobalEventHandlers.onwheel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5528


outerHTML

● outerHTML: string

Inherited from Element.outerHTML

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4691


ownerDocument

● ownerDocument: Document | null

Inherited from Node.ownerDocument

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10315

Returns the node document. Returns null for documents.


parentElement

● parentElement: HTMLElement | null

Inherited from Node.parentElement

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10319

Returns the parent element.


parentNode

● parentNode: Node & ParentNode | null

Inherited from Node.parentNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10323

Returns the parent.


prefix

● prefix: string | null

Inherited from Element.prefix

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4695

Returns the namespace prefix.


previousElementSibling

● previousElementSibling: Element | null

Inherited from NonDocumentTypeChildNode.previousElementSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10498

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


previousSibling

● previousSibling: Node | null

Inherited from Node.previousSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10327

Returns the previous sibling.


scrollHeight

● scrollHeight: number

Inherited from Element.scrollHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4696


scrollLeft

● scrollLeft: number

Inherited from Element.scrollLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4697


scrollTop

● scrollTop: number

Inherited from Element.scrollTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4698


scrollWidth

● scrollWidth: number

Inherited from Element.scrollWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4699


shadowRoot

● shadowRoot: ShadowRoot | null

Inherited from Element.shadowRoot

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4703

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


slot

● slot: string

Inherited from Element.slot

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4708

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


spellcheck

● spellcheck: boolean

Inherited from HTMLElement.spellcheck

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6079


style

● style: CSSStyleDeclaration

Inherited from ElementCSSInlineStyle.style

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4820


tabIndex

● tabIndex: number

Inherited from HTMLOrSVGElement.tabIndex

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7557


tagName

● tagName: string

Inherited from Element.tagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4712

Returns the HTML-uppercased qualified name.


textContent

● textContent: string | null

Inherited from Node.textContent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10328


title

● title: string

Inherited from HTMLElement.title

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6080


translate

● translate: boolean

Inherited from HTMLElement.translate

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6081


<Static> HTMLElement

● HTMLElement: object

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6089

Type declaration

constructor : function ⊕ new __type(): HTMLElement

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6090

Returns: HTMLElement

prototype: HTMLElement


<Static> observedAttributes

● observedAttributes: string[] = [ATTR_LAYOUT_MODE]

Defined in base/abstract.base.component.ts:32


Accessors

layoutMode

get layoutMode(): string

set layoutMode(aLayoutMode: string): void

Defined in base/abstract.base.component.ts:84

Returns: string

Defined in base/abstract.base.component.ts:80

Parameters:

Name Type
aLayoutMode string

Returns: void


Methods

addEventListener

addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void

addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Inherited from HTMLElement.addEventListener

Overrides Element.addEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6083

Type parameters:

K : keyof HTMLElementEventMap

Parameters:

Name Type
type K
listener function
Optional options boolean | AddEventListenerOptions

Returns: void

Inherited from HTMLElement.addEventListener

Overrides Element.addEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6084

Parameters:

Name Type
type string
listener EventListenerOrEventListenerObject
Optional options boolean | AddEventListenerOptions

Returns: void


after

after(...nodes: (string | Node)[]): void

Inherited from ChildNode.after

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3079

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


animate

animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation

Inherited from Animatable.animate

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1695

Parameters:

Name Type
keyframes Keyframe[] | PropertyIndexedKeyframes | null
Optional options number | KeyframeAnimationOptions

Returns: Animation


append

append(...nodes: (string | Node)[]): void

Inherited from ParentNode.append

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10728

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


appendChild

appendChild<T>(newChild: T): T

Inherited from Node.appendChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10329

Type parameters:

T : Node

Parameters:

Name Type
newChild T

Returns: T


attachShadow

attachShadow(shadowRootInitDict: ShadowRootInit): ShadowRoot

Inherited from Element.attachShadow

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4716

Creates a shadow root for element and returns it.

Parameters:

Name Type
shadowRootInitDict ShadowRootInit

Returns: ShadowRoot


attributeChangedCallback

attributeChangedCallback(name: string, oldValue: string, newValue: string): void

Defined in base/abstract.base.component.ts:98

Parameters:

Name Type
name string
oldValue string
newValue string

Returns: void


before

before(...nodes: (string | Node)[]): void

Inherited from ChildNode.before

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3085

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


blur

blur(): void

Inherited from HTMLOrSVGElement.blur

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7558

Returns: void


click

click(): void

Inherited from HTMLElement.click

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6082

Returns: void


cloneNode

cloneNode(deep?: boolean): Node

Inherited from Node.cloneNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10333

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

Parameters:

Name Type
Optional deep boolean

Returns: Node


closest

closest<K>(selector: K): HTMLElementTagNameMap[K] | null

closest<K>(selector: K): SVGElementTagNameMap[K] | null

closest(selector: string): Element | null

Inherited from Element.closest

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4720

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

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
selector K

Returns: HTMLElementTagNameMap[K] | null

Inherited from Element.closest

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4721

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
selector K

Returns: SVGElementTagNameMap[K] | null

Inherited from Element.closest

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4722

Parameters:

Name Type
selector string

Returns: Element | null


compareDocumentPosition

compareDocumentPosition(other: Node): number

Inherited from Node.compareDocumentPosition

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10334

Parameters:

Name Type
other Node

Returns: number


connectedCallback

connectedCallback(): void

Defined in base/abstract.base.component.ts:88

Returns: void


contains

contains(other: Node | null): boolean

Inherited from Node.contains

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10338

Returns true if other is an inclusive descendant of node, and false otherwise.

Parameters:

Name Type
other Node | null

Returns: boolean


disconnectedCallback

disconnectedCallback(): void

Defined in base/abstract.base.component.ts:93

Returns: void


dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4956

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:

Name Type
event Event

Returns: boolean


focus

focus(options?: FocusOptions): void

Inherited from HTMLOrSVGElement.focus

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7559

Parameters:

Name Type
Optional options FocusOptions

Returns: void


getAnimations

getAnimations(): Animation[]

Inherited from Animatable.getAnimations

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1696

Returns: Animation[]


getAttribute

getAttribute(qualifiedName: string): string | null

Inherited from Element.getAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4726

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

Parameters:

Name Type
qualifiedName string

Returns: string | null


getAttributeNS

getAttributeNS(namespace: string | null, localName: string): string | null

Inherited from Element.getAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4731

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

Parameters:

Name Type
namespace string | null
localName string

Returns: string | null


getAttributeNames

getAttributeNames(): string[]

Inherited from Element.getAttributeNames

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4736

Returns the qualified names of all element's attributes. Can contain duplicates.

Returns: string[]


getAttributeNode

getAttributeNode(name: string): Attr | null

Inherited from Element.getAttributeNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4737

Parameters:

Name Type
name string

Returns: Attr | null


getAttributeNodeNS

getAttributeNodeNS(namespaceURI: string, localName: string): Attr | null

Inherited from Element.getAttributeNodeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4738

Parameters:

Name Type
namespaceURI string
localName string

Returns: Attr | null


getBoundingClientRect

getBoundingClientRect(): ClientRect | DOMRect

Inherited from Element.getBoundingClientRect

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4739

Returns: ClientRect | DOMRect


getClientRects

getClientRects(): ClientRectList | DOMRectList

Inherited from Element.getClientRects

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4740

Returns: ClientRectList | DOMRectList


getElementsByClassName

getElementsByClassName(classNames: string): HTMLCollectionOf<Element>

Inherited from Element.getElementsByClassName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4741

Parameters:

Name Type
classNames string

Returns: HTMLCollectionOf<Element>


getElementsByTagName

getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>

getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>

getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>

Inherited from Element.getElementsByTagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4742

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
qualifiedName K

Returns: HTMLCollectionOf<HTMLElementTagNameMap[K]>

Inherited from Element.getElementsByTagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4743

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
qualifiedName K

Returns: HTMLCollectionOf<SVGElementTagNameMap[K]>

Inherited from Element.getElementsByTagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4744

Parameters:

Name Type
qualifiedName string

Returns: HTMLCollectionOf<Element>


getElementsByTagNameNS

getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>

getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>

getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>

Inherited from Element.getElementsByTagNameNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4745

Parameters:

Name Type
namespaceURI "http://www.w3.org/1999/xhtml"
localName string

Returns: HTMLCollectionOf<HTMLElement>

Inherited from Element.getElementsByTagNameNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4746

Parameters:

Name Type
namespaceURI "http://www.w3.org/2000/svg"
localName string

Returns: HTMLCollectionOf<SVGElement>

Inherited from Element.getElementsByTagNameNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4747

Parameters:

Name Type
namespaceURI string
localName string

Returns: HTMLCollectionOf<Element>


getRootNode

getRootNode(options?: GetRootNodeOptions): Node

Inherited from Node.getRootNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10342

Returns node's shadow-including root.

Parameters:

Name Type
Optional options GetRootNodeOptions

Returns: Node


hasAttribute

hasAttribute(qualifiedName: string): boolean

Inherited from Element.hasAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4751

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

Parameters:

Name Type
qualifiedName string

Returns: boolean


hasAttributeNS

hasAttributeNS(namespace: string | null, localName: string): boolean

Inherited from Element.hasAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4755

Returns true if element has an attribute whose namespace is namespace and local name is localName.

Parameters:

Name Type
namespace string | null
localName string

Returns: boolean


hasAttributes

hasAttributes(): boolean

Inherited from Element.hasAttributes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4759

Returns true if element has attributes, and false otherwise.

Returns: boolean


hasChildNodes

hasChildNodes(): boolean

Inherited from Node.hasChildNodes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10346

Returns whether node has children.

Returns: boolean


hasPointerCapture

hasPointerCapture(pointerId: number): boolean

Inherited from Element.hasPointerCapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4760

Parameters:

Name Type
pointerId number

Returns: boolean


insertAdjacentElement

insertAdjacentElement(position: InsertPosition, insertedElement: Element): Element | null

Inherited from Element.insertAdjacentElement

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4761

Parameters:

Name Type
position InsertPosition
insertedElement Element

Returns: Element | null


insertAdjacentHTML

insertAdjacentHTML(where: InsertPosition, html: string): void

Inherited from Element.insertAdjacentHTML

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4762

Parameters:

Name Type
where InsertPosition
html string

Returns: void


insertAdjacentText

insertAdjacentText(where: InsertPosition, text: string): void

Inherited from Element.insertAdjacentText

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4763

Parameters:

Name Type
where InsertPosition
text string

Returns: void


insertBefore

insertBefore<T>(newChild: T, refChild: Node | null): T

Inherited from Node.insertBefore

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10347

Type parameters:

T : Node

Parameters:

Name Type
newChild T
refChild Node | null

Returns: T


isDefaultNamespace

isDefaultNamespace(namespace: string | null): boolean

Inherited from Node.isDefaultNamespace

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10348

Parameters:

Name Type
namespace string | null

Returns: boolean


isEqualNode

isEqualNode(otherNode: Node | null): boolean

Inherited from Node.isEqualNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10352

Returns whether node and otherNode have the same properties.

Parameters:

Name Type
otherNode Node | null

Returns: boolean


isSameNode

isSameNode(otherNode: Node | null): boolean

Inherited from Node.isSameNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10353

Parameters:

Name Type
otherNode Node | null

Returns: boolean


lookupNamespaceURI

lookupNamespaceURI(prefix: string | null): string | null

Inherited from Node.lookupNamespaceURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10354

Parameters:

Name Type
prefix string | null

Returns: string | null


lookupPrefix

lookupPrefix(namespace: string | null): string | null

Inherited from Node.lookupPrefix

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10355

Parameters:

Name Type
namespace string | null

Returns: string | null


matches

matches(selectors: string): boolean

Inherited from Element.matches

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4767

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

Parameters:

Name Type
selectors string

Returns: boolean


msGetRegionContent

msGetRegionContent(): any

Inherited from Element.msGetRegionContent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4768

Returns: any


normalize

normalize(): void

Inherited from Node.normalize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10359

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

Returns: void


prepend

prepend(...nodes: (string | Node)[]): void

Inherited from ParentNode.prepend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10735

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.

Parameters:

Name Type
Rest nodes (string | Node)[]

Returns: void


querySelector

querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null

querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null

querySelector<E>(selectors: string): E | null

Inherited from ParentNode.querySelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10740

Returns the first element that is a descendant of node that matches selectors.

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
selectors K

Returns: HTMLElementTagNameMap[K] | null

Inherited from ParentNode.querySelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10741

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
selectors K

Returns: SVGElementTagNameMap[K] | null

Inherited from ParentNode.querySelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10742

Type parameters:

E : Element

Parameters:

Name Type
selectors string

Returns: E | null


querySelectorAll

querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>

querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>

querySelectorAll<E>(selectors: string): NodeListOf<E>

Inherited from ParentNode.querySelectorAll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10747

Returns all element descendants of node that match selectors.

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
selectors K

Returns: NodeListOf<HTMLElementTagNameMap[K]>

Inherited from ParentNode.querySelectorAll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10748

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
selectors K

Returns: NodeListOf<SVGElementTagNameMap[K]>

Inherited from ParentNode.querySelectorAll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10749

Type parameters:

E : Element

Parameters:

Name Type
selectors string

Returns: NodeListOf<E>


releasePointerCapture

releasePointerCapture(pointerId: number): void

Inherited from Element.releasePointerCapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4769

Parameters:

Name Type
pointerId number

Returns: void


remove

remove(): void

Inherited from ChildNode.remove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3089

Removes node.

Returns: void


removeAttribute

removeAttribute(qualifiedName: string): void

Inherited from Element.removeAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4773

Removes element's first attribute whose qualified name is qualifiedName.

Parameters:

Name Type
qualifiedName string

Returns: void


removeAttributeNS

removeAttributeNS(namespace: string | null, localName: string): void

Inherited from Element.removeAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4777

Removes element's attribute whose namespace is namespace and local name is localName.

Parameters:

Name Type
namespace string | null
localName string

Returns: void


removeAttributeNode

removeAttributeNode(attr: Attr): Attr

Inherited from Element.removeAttributeNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4778

Parameters:

Name Type
attr Attr

Returns: Attr


removeChild

removeChild<T>(oldChild: T): T

Inherited from Node.removeChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10360

Type parameters:

T : Node

Parameters:

Name Type
oldChild T

Returns: T


removeEventListener

removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void

removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Inherited from HTMLElement.removeEventListener

Overrides Element.removeEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6085

Type parameters:

K : keyof HTMLElementEventMap

Parameters:

Name Type
type K
listener function
Optional options boolean | EventListenerOptions

Returns: void

Inherited from HTMLElement.removeEventListener

Overrides Element.removeEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6086

Parameters:

Name Type
type string
listener EventListenerOrEventListenerObject
Optional options boolean | EventListenerOptions

Returns: void


replaceChild

replaceChild<T>(newChild: Node, oldChild: T): T

Inherited from Node.replaceChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10361

Type parameters:

T : Node

Parameters:

Name Type
newChild Node
oldChild T

Returns: T


replaceWith

replaceWith(...nodes: (string | Node)[]): void

Inherited from ChildNode.replaceWith

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3095

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


requestFullscreen

requestFullscreen(): Promise<void>

Inherited from Element.requestFullscreen

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4782

Displays element fullscreen and resolves promise when done.

Returns: Promise<void>


scroll

scroll(options?: ScrollToOptions): void

scroll(x: number, y: number): void

Inherited from Element.scroll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4783

Parameters:

Name Type
Optional options ScrollToOptions

Returns: void

Inherited from Element.scroll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4784

Parameters:

Name Type
x number
y number

Returns: void


scrollBy

scrollBy(options?: ScrollToOptions): void

scrollBy(x: number, y: number): void

Inherited from Element.scrollBy

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4785

Parameters:

Name Type
Optional options ScrollToOptions

Returns: void

Inherited from Element.scrollBy

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4786

Parameters:

Name Type
x number
y number

Returns: void


scrollIntoView

scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void

Inherited from Element.scrollIntoView

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4787

Parameters:

Name Type
Optional arg boolean | ScrollIntoViewOptions

Returns: void


scrollTo

scrollTo(options?: ScrollToOptions): void

scrollTo(x: number, y: number): void

Inherited from Element.scrollTo

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4788

Parameters:

Name Type
Optional options ScrollToOptions

Returns: void

Inherited from Element.scrollTo

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4789

Parameters:

Name Type
x number
y number

Returns: void


setAttribute

setAttribute(qualifiedName: string, value: string): void

Inherited from Element.setAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4793

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

Parameters:

Name Type
qualifiedName string
value string

Returns: void


setAttributeNS

setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void

Inherited from Element.setAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4797

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

Parameters:

Name Type
namespace string | null
qualifiedName string
value string

Returns: void


setAttributeNode

setAttributeNode(attr: Attr): Attr | null

Inherited from Element.setAttributeNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4798

Parameters:

Name Type
attr Attr

Returns: Attr | null


setAttributeNodeNS

setAttributeNodeNS(attr: Attr): Attr | null

Inherited from Element.setAttributeNodeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4799

Parameters:

Name Type
attr Attr

Returns: Attr | null


setPointerCapture

setPointerCapture(pointerId: number): void

Inherited from Element.setPointerCapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4800

Parameters:

Name Type
pointerId number

Returns: void


toggleAttribute

toggleAttribute(qualifiedName: string, force?: boolean): boolean

Inherited from Element.toggleAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4806

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:

Name Type
qualifiedName string
Optional force boolean

Returns: boolean


webkitMatchesSelector

webkitMatchesSelector(selectors: string): boolean

Inherited from Element.webkitMatchesSelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4807

Parameters:

Name Type
selectors string

Returns: boolean


@ibm-wch-sdk/web-components > "base/abstract.rendering.component" > AbstractRenderingComponent

Class: AbstractRenderingComponent

Hierarchy

AbstractBaseComponent

↳ AbstractRenderingComponent

ContentRefComponent

LayoutNotFoundComponent

Implements

  • RenderingContextProvider

Index

Constructors

Properties

Accessors

Methods


Constructors

constructor

new AbstractRenderingComponent(): AbstractRenderingComponent

Overrides AbstractBaseComponent.constructor

Defined in base/abstract.rendering.component.ts:18

Returns: AbstractRenderingComponent


Properties

ATTRIBUTE_NODE

● ATTRIBUTE_NODE: number

Inherited from Node.ATTRIBUTE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10362


CDATA_SECTION_NODE

● CDATA_SECTION_NODE: number

Inherited from Node.CDATA_SECTION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10363


COMMENT_NODE

● COMMENT_NODE: number

Inherited from Node.COMMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10364


DOCUMENT_FRAGMENT_NODE

● DOCUMENT_FRAGMENT_NODE: number

Inherited from Node.DOCUMENT_FRAGMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10365


DOCUMENT_NODE

● DOCUMENT_NODE: number

Inherited from Node.DOCUMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10366


DOCUMENT_POSITION_CONTAINED_BY

● DOCUMENT_POSITION_CONTAINED_BY: number

Inherited from Node.DOCUMENT_POSITION_CONTAINED_BY

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10367


DOCUMENT_POSITION_CONTAINS

● DOCUMENT_POSITION_CONTAINS: number

Inherited from Node.DOCUMENT_POSITION_CONTAINS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10368


DOCUMENT_POSITION_DISCONNECTED

● DOCUMENT_POSITION_DISCONNECTED: number

Inherited from Node.DOCUMENT_POSITION_DISCONNECTED

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10369


DOCUMENT_POSITION_FOLLOWING

● DOCUMENT_POSITION_FOLLOWING: number

Inherited from Node.DOCUMENT_POSITION_FOLLOWING

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10370


DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

● DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Inherited from Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10371


DOCUMENT_POSITION_PRECEDING

● DOCUMENT_POSITION_PRECEDING: number

Inherited from Node.DOCUMENT_POSITION_PRECEDING

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10372


DOCUMENT_TYPE_NODE

● DOCUMENT_TYPE_NODE: number

Inherited from Node.DOCUMENT_TYPE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10373


ELEMENT_NODE

● ELEMENT_NODE: number

Inherited from Node.ELEMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10374


ENTITY_NODE

● ENTITY_NODE: number

Inherited from Node.ENTITY_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10375


ENTITY_REFERENCE_NODE

● ENTITY_REFERENCE_NODE: number

Inherited from Node.ENTITY_REFERENCE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10376


NOTATION_NODE

● NOTATION_NODE: number

Inherited from Node.NOTATION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10377


PROCESSING_INSTRUCTION_NODE

● PROCESSING_INSTRUCTION_NODE: number

Inherited from Node.PROCESSING_INSTRUCTION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10378


TEXT_NODE

● TEXT_NODE: number

Inherited from Node.TEXT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10379


__computed

● __computed: RenderingContext

Defined in base/abstract.rendering.component.ts:18


<Protected> _onDestroy

● _onDestroy: Observable<this>

Inherited from AbstractBaseComponent._onDestroy

Defined in base/abstract.base.component.ts:24


<Protected> _onInit

● _onInit: Observable<this>

Inherited from AbstractBaseComponent._onInit

Defined in base/abstract.base.component.ts:23


<Protected> _onLayoutMode

● _onLayoutMode: Observable<string>

Inherited from AbstractBaseComponent._onLayoutMode

Defined in base/abstract.base.component.ts:30


<Protected> _onLoggerService

● _onLoggerService: Observable<LoggerService>

Inherited from AbstractBaseComponent._onLoggerService

Defined in base/abstract.base.component.ts:28


<Protected> _onSdk

● _onSdk: Observable<WchSdk>

Inherited from AbstractBaseComponent._onSdk

Defined in base/abstract.base.component.ts:26


accessKey

● accessKey: string

Inherited from HTMLElement.accessKey

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6066


accessKeyLabel

● accessKeyLabel: string

Inherited from HTMLElement.accessKeyLabel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6067


assignedSlot

● assignedSlot: HTMLSlotElement | null

Inherited from Element.assignedSlot

Overrides Slotable.assignedSlot

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4659


attributes

● attributes: NamedNodeMap

Inherited from Element.attributes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4660


autocapitalize

● autocapitalize: string

Inherited from HTMLElement.autocapitalize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6068


baseURI

● baseURI: string

Inherited from Node.baseURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10264

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


childElementCount

● childElementCount: number

Inherited from ParentNode.childElementCount

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10709


childNodes

● childNodes: NodeListOf<ChildNode>

Inherited from Node.childNodes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10268

Returns the children.


children

● children: HTMLCollection

Inherited from ParentNode.children

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10713

Returns the child elements.


classList

● classList: DOMTokenList

Inherited from Element.classList

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4665

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


className

● className: string

Inherited from Element.className

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4670

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


clientHeight

● clientHeight: number

Inherited from Element.clientHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4671


clientLeft

● clientLeft: number

Inherited from Element.clientLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4672


clientTop

● clientTop: number

Inherited from Element.clientTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4673


clientWidth

● clientWidth: number

Inherited from Element.clientWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4674


contentEditable

● contentEditable: string

Inherited from ElementContentEditable.contentEditable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4824


dataset

● dataset: DOMStringMap

Inherited from HTMLOrSVGElement.dataset

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7555


dir

● dir: string

Inherited from HTMLElement.dir

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6069


draggable

● draggable: boolean

Inherited from HTMLElement.draggable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6070


firstChild

● firstChild: ChildNode | null

Inherited from Node.firstChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10272

Returns the first child.


firstElementChild

● firstElementChild: Element | null

Inherited from ParentNode.firstElementChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10717

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


hidden

● hidden: boolean

Inherited from HTMLElement.hidden

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6071


id

● id: string

Inherited from Element.id

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4679

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


innerHTML

● innerHTML: string

Inherited from Element.innerHTML

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4680


innerText

● innerText: string

Inherited from HTMLElement.innerText

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6072


inputMode

● inputMode: string

Inherited from ElementContentEditable.inputMode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4825


isConnected

● isConnected: boolean

Inherited from Node.isConnected

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10276

Returns true if node is connected and false otherwise.


isContentEditable

● isContentEditable: boolean

Inherited from ElementContentEditable.isContentEditable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4826


lang

● lang: string

Inherited from HTMLElement.lang

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6073


lastChild

● lastChild: ChildNode | null

Inherited from Node.lastChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10280

Returns the last child.


lastElementChild

● lastElementChild: Element | null

Inherited from ParentNode.lastElementChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10721

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


localName

● localName: string

Inherited from Element.localName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4684

Returns the local name.


namespaceURI

● namespaceURI: string | null

Inherited from Element.namespaceURI

Overrides Node.namespaceURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4688

Returns the namespace.


nextElementSibling

● nextElementSibling: Element | null

Inherited from NonDocumentTypeChildNode.nextElementSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10493

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


nextSibling

● nextSibling: Node | null

Inherited from Node.nextSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10285

Returns the next sibling.


nodeName

● nodeName: string

Inherited from Node.nodeName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10308

Returns a string appropriate for the type of node, as follows: Element Its HTML-uppercased qualified name. Attr Its qualified name. Text "#text". CDATASection "#cdata-section". ProcessingInstruction Its target. Comment "#comment". Document "#document". DocumentType Its name. DocumentFragment "#document-fragment".


nodeType

● nodeType: number

Inherited from Node.nodeType

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10309


nodeValue

● nodeValue: string | null

Inherited from Node.nodeValue

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10310


nonce

● nonce: string

Inherited from HTMLOrSVGElement.nonce

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7556


offsetHeight

● offsetHeight: number

Inherited from HTMLElement.offsetHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6074


offsetLeft

● offsetLeft: number

Inherited from HTMLElement.offsetLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6075


offsetParent

● offsetParent: Element | null

Inherited from HTMLElement.offsetParent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6076


offsetTop

● offsetTop: number

Inherited from HTMLElement.offsetTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6077


offsetWidth

● offsetWidth: number

Inherited from HTMLElement.offsetWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6078


onLayoutMode

● onLayoutMode: Observable<string>

Defined in base/abstract.rendering.component.ts:15


onRenderingContext

● onRenderingContext: Observable<RenderingContext>

Defined in base/abstract.rendering.component.ts:14


onabort

● onabort: function | null

Inherited from GlobalEventHandlers.onabort

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5269

Fires when the user aborts the download.

param: The event.


onanimationcancel

● onanimationcancel: function | null

Inherited from GlobalEventHandlers.onanimationcancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5270


onanimationend

● onanimationend: function | null

Inherited from GlobalEventHandlers.onanimationend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5271


onanimationiteration

● onanimationiteration: function | null

Inherited from GlobalEventHandlers.onanimationiteration

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5272


onanimationstart

● onanimationstart: function | null

Inherited from GlobalEventHandlers.onanimationstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5273


onauxclick

● onauxclick: function | null

Inherited from GlobalEventHandlers.onauxclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5274


onblur

● onblur: function | null

Inherited from GlobalEventHandlers.onblur

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5279

Fires when the object loses the input focus.

param: The focus event.


oncancel

● oncancel: function | null

Inherited from GlobalEventHandlers.oncancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5280


oncanplay

● oncanplay: function | null

Inherited from GlobalEventHandlers.oncanplay

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5285

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

param: The event.


oncanplaythrough

● oncanplaythrough: function | null

Inherited from GlobalEventHandlers.oncanplaythrough

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5286


onchange

● onchange: function | null

Inherited from GlobalEventHandlers.onchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5291

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

param: The event.


onclick

● onclick: function | null

Inherited from GlobalEventHandlers.onclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5296

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

param: The mouse event.


onclose

● onclose: function | null

Inherited from GlobalEventHandlers.onclose

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5297


oncontextmenu

● oncontextmenu: function | null

Inherited from GlobalEventHandlers.oncontextmenu

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5302

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

param: The mouse event.


oncopy

● oncopy: function | null

Inherited from DocumentAndElementEventHandlers.oncopy

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4468


oncuechange

● oncuechange: function | null

Inherited from GlobalEventHandlers.oncuechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5303


oncut

● oncut: function | null

Inherited from DocumentAndElementEventHandlers.oncut

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4469


ondblclick

● ondblclick: function | null

Inherited from GlobalEventHandlers.ondblclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5308

Fires when the user double-clicks the object.

param: The mouse event.


ondrag

● ondrag: function | null

Inherited from GlobalEventHandlers.ondrag

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5313

Fires on the source object continuously during a drag operation.

param: The event.


ondragend

● ondragend: function | null

Inherited from GlobalEventHandlers.ondragend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5318

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

param: The event.


ondragenter

● ondragenter: function | null

Inherited from GlobalEventHandlers.ondragenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5323

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

param: The drag event.


ondragexit

● ondragexit: function | null

Inherited from GlobalEventHandlers.ondragexit

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5324


ondragleave

● ondragleave: function | null

Inherited from GlobalEventHandlers.ondragleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5329

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

param: The drag event.


ondragover

● ondragover: function | null

Inherited from GlobalEventHandlers.ondragover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5334

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

param: The event.


ondragstart

● ondragstart: function | null

Inherited from GlobalEventHandlers.ondragstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5339

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

param: The event.


ondrop

● ondrop: function | null

Inherited from GlobalEventHandlers.ondrop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5340


ondurationchange

● ondurationchange: function | null

Inherited from GlobalEventHandlers.ondurationchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5345

Occurs when the duration attribute is updated.

param: The event.


onemptied

● onemptied: function | null

Inherited from GlobalEventHandlers.onemptied

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5350

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

param: The event.


onended

● onended: function | null

Inherited from GlobalEventHandlers.onended

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5355

Occurs when the end of playback is reached.

param: The event


onerror

● onerror: ErrorEventHandler

Inherited from GlobalEventHandlers.onerror

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5360

Fires when an error occurs during object loading.

param: The event.


onfocus

● onfocus: function | null

Inherited from GlobalEventHandlers.onfocus

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5365

Fires when the object receives focus.

param: The event.


onfullscreenchange

● onfullscreenchange: function | null

Inherited from Element.onfullscreenchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4689


onfullscreenerror

● onfullscreenerror: function | null

Inherited from Element.onfullscreenerror

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4690


ongotpointercapture

● ongotpointercapture: function | null

Inherited from GlobalEventHandlers.ongotpointercapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5366


oninput

● oninput: function | null

Inherited from GlobalEventHandlers.oninput

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5367


oninvalid

● oninvalid: function | null

Inherited from GlobalEventHandlers.oninvalid

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5368


onkeydown

● onkeydown: function | null

Inherited from GlobalEventHandlers.onkeydown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5373

Fires when the user presses a key.

param: The keyboard event


onkeypress

● onkeypress: function | null

Inherited from GlobalEventHandlers.onkeypress

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5378

Fires when the user presses an alphanumeric key.

param: The event.


onkeyup

● onkeyup: function | null

Inherited from GlobalEventHandlers.onkeyup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5383

Fires when the user releases a key.

param: The keyboard event


onload

● onload: function | null

Inherited from GlobalEventHandlers.onload

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5388

Fires immediately after the browser loads the object.

param: The event.


onloadeddata

● onloadeddata: function | null

Inherited from GlobalEventHandlers.onloadeddata

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5393

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

param: The event.


onloadedmetadata

● onloadedmetadata: function | null

Inherited from GlobalEventHandlers.onloadedmetadata

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5398

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

param: The event.


onloadend

● onloadend: function | null

Inherited from GlobalEventHandlers.onloadend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5399


onloadstart

● onloadstart: function | null

Inherited from GlobalEventHandlers.onloadstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5404

Occurs when Internet Explorer begins looking for media data.

param: The event.


onlostpointercapture

● onlostpointercapture: function | null

Inherited from GlobalEventHandlers.onlostpointercapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5405


onmousedown

● onmousedown: function | null

Inherited from GlobalEventHandlers.onmousedown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5410

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

param: The mouse event.


onmouseenter

● onmouseenter: function | null

Inherited from GlobalEventHandlers.onmouseenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5411


onmouseleave

● onmouseleave: function | null

Inherited from GlobalEventHandlers.onmouseleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5412


onmousemove

● onmousemove: function | null

Inherited from GlobalEventHandlers.onmousemove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5417

Fires when the user moves the mouse over the object.

param: The mouse event.


onmouseout

● onmouseout: function | null

Inherited from GlobalEventHandlers.onmouseout

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5422

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

param: The mouse event.


onmouseover

● onmouseover: function | null

Inherited from GlobalEventHandlers.onmouseover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5427

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

param: The mouse event.


onmouseup

● onmouseup: function | null

Inherited from GlobalEventHandlers.onmouseup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5432

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

param: The mouse event.


onpaste

● onpaste: function | null

Inherited from DocumentAndElementEventHandlers.onpaste

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4470


onpause

● onpause: function | null

Inherited from GlobalEventHandlers.onpause

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5437

Occurs when playback is paused.

param: The event.


onplay

● onplay: function | null

Inherited from GlobalEventHandlers.onplay

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5442

Occurs when the play method is requested.

param: The event.


onplaying

● onplaying: function | null

Inherited from GlobalEventHandlers.onplaying

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5447

Occurs when the audio or video has started playing.

param: The event.


onpointercancel

● onpointercancel: function | null

Inherited from GlobalEventHandlers.onpointercancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5448


onpointerdown

● onpointerdown: function | null

Inherited from GlobalEventHandlers.onpointerdown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5449


onpointerenter

● onpointerenter: function | null

Inherited from GlobalEventHandlers.onpointerenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5450


onpointerleave

● onpointerleave: function | null

Inherited from GlobalEventHandlers.onpointerleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5451


onpointermove

● onpointermove: function | null

Inherited from GlobalEventHandlers.onpointermove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5452


onpointerout

● onpointerout: function | null

Inherited from GlobalEventHandlers.onpointerout

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5453


onpointerover

● onpointerover: function | null

Inherited from GlobalEventHandlers.onpointerover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5454


onpointerup

● onpointerup: function | null

Inherited from GlobalEventHandlers.onpointerup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5455


onprogress

● onprogress: function | null

Inherited from GlobalEventHandlers.onprogress

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5460

Occurs to indicate progress while downloading media data.

param: The event.


onratechange

● onratechange: function | null

Inherited from GlobalEventHandlers.onratechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5465

Occurs when the playback rate is increased or decreased.

param: The event.


onreset

● onreset: function | null

Inherited from GlobalEventHandlers.onreset

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5470

Fires when the user resets a form.

param: The event.


onresize

● onresize: function | null

Inherited from GlobalEventHandlers.onresize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5471


onscroll

● onscroll: function | null

Inherited from GlobalEventHandlers.onscroll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5476

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

param: The event.


onsecuritypolicyviolation

● onsecuritypolicyviolation: function | null

Inherited from GlobalEventHandlers.onsecuritypolicyviolation

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5477


onseeked

● onseeked: function | null

Inherited from GlobalEventHandlers.onseeked

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5482

Occurs when the seek operation ends.

param: The event.


onseeking

● onseeking: function | null

Inherited from GlobalEventHandlers.onseeking

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5487

Occurs when the current playback position is moved.

param: The event.


onselect

● onselect: function | null

Inherited from GlobalEventHandlers.onselect

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5492

Fires when the current selection changes.

param: The event.


onstalled

● onstalled: function | null

Inherited from GlobalEventHandlers.onstalled

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5497

Occurs when the download has stopped.

param: The event.


onsubmit

● onsubmit: function | null

Inherited from GlobalEventHandlers.onsubmit

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5498


onsuspend

● onsuspend: function | null

Inherited from GlobalEventHandlers.onsuspend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5503

Occurs if the load operation has been intentionally halted.

param: The event.


ontimeupdate

● ontimeupdate: function | null

Inherited from GlobalEventHandlers.ontimeupdate

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5508

Occurs to indicate the current playback position.

param: The event.


ontoggle

● ontoggle: function | null

Inherited from GlobalEventHandlers.ontoggle

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5509


ontouchcancel

● ontouchcancel: function | null

Inherited from GlobalEventHandlers.ontouchcancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5510


ontouchend

● ontouchend: function | null

Inherited from GlobalEventHandlers.ontouchend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5511


ontouchmove

● ontouchmove: function | null

Inherited from GlobalEventHandlers.ontouchmove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5512


ontouchstart

● ontouchstart: function | null

Inherited from GlobalEventHandlers.ontouchstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5513


ontransitioncancel

● ontransitioncancel: function | null

Inherited from GlobalEventHandlers.ontransitioncancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5514


ontransitionend

● ontransitionend: function | null

Inherited from GlobalEventHandlers.ontransitionend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5515


ontransitionrun

● ontransitionrun: function | null

Inherited from GlobalEventHandlers.ontransitionrun

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5516


ontransitionstart

● ontransitionstart: function | null

Inherited from GlobalEventHandlers.ontransitionstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5517


onvolumechange

● onvolumechange: function | null

Inherited from GlobalEventHandlers.onvolumechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5522

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

param: The event.


onwaiting

● onwaiting: function | null

Inherited from GlobalEventHandlers.onwaiting

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5527

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

param: The event.


onwheel

● onwheel: function | null

Inherited from GlobalEventHandlers.onwheel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5528


outerHTML

● outerHTML: string

Inherited from Element.outerHTML

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4691


ownerDocument

● ownerDocument: Document | null

Inherited from Node.ownerDocument

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10315

Returns the node document. Returns null for documents.


parentElement

● parentElement: HTMLElement | null

Inherited from Node.parentElement

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10319

Returns the parent element.


parentNode

● parentNode: Node & ParentNode | null

Inherited from Node.parentNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10323

Returns the parent.


prefix

● prefix: string | null

Inherited from Element.prefix

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4695

Returns the namespace prefix.


previousElementSibling

● previousElementSibling: Element | null

Inherited from NonDocumentTypeChildNode.previousElementSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10498

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


previousSibling

● previousSibling: Node | null

Inherited from Node.previousSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10327

Returns the previous sibling.


scrollHeight

● scrollHeight: number

Inherited from Element.scrollHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4696


scrollLeft

● scrollLeft: number

Inherited from Element.scrollLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4697


scrollTop

● scrollTop: number

Inherited from Element.scrollTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4698


scrollWidth

● scrollWidth: number

Inherited from Element.scrollWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4699


shadowRoot

● shadowRoot: ShadowRoot | null

Inherited from Element.shadowRoot

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4703

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


slot

● slot: string

Inherited from Element.slot

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4708

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


spellcheck

● spellcheck: boolean

Inherited from HTMLElement.spellcheck

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6079


style

● style: CSSStyleDeclaration

Inherited from ElementCSSInlineStyle.style

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4820


tabIndex

● tabIndex: number

Inherited from HTMLOrSVGElement.tabIndex

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7557


tagName

● tagName: string

Inherited from Element.tagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4712

Returns the HTML-uppercased qualified name.


textContent

● textContent: string | null

Inherited from Node.textContent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10328


title

● title: string

Inherited from HTMLElement.title

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6080


translate

● translate: boolean

Inherited from HTMLElement.translate

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6081


<Static> observedAttributes

● observedAttributes: string[] = [ATTR_LAYOUT_MODE]

Inherited from AbstractBaseComponent.observedAttributes

Defined in base/abstract.base.component.ts:32


Accessors

layoutMode

get layoutMode(): string

set layoutMode(aLayoutMode: string): void

Inherited from AbstractBaseComponent.layoutMode

Defined in base/abstract.base.component.ts:84

Returns: string

Inherited from AbstractBaseComponent.layoutMode

Defined in base/abstract.base.component.ts:80

Parameters:

Name Type
aLayoutMode string

Returns: void


Methods

addEventListener

addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void

addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Inherited from HTMLElement.addEventListener

Overrides Element.addEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6083

Type parameters:

K : keyof HTMLElementEventMap

Parameters:

Name Type
type K
listener function
Optional options boolean | AddEventListenerOptions

Returns: void

Inherited from HTMLElement.addEventListener

Overrides Element.addEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6084

Parameters:

Name Type
type string
listener EventListenerOrEventListenerObject
Optional options boolean | AddEventListenerOptions

Returns: void


after

after(...nodes: (string | Node)[]): void

Inherited from ChildNode.after

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3079

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


animate

animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation

Inherited from Animatable.animate

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1695

Parameters:

Name Type
keyframes Keyframe[] | PropertyIndexedKeyframes | null
Optional options number | KeyframeAnimationOptions

Returns: Animation


append

append(...nodes: (string | Node)[]): void

Inherited from ParentNode.append

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10728

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


appendChild

appendChild<T>(newChild: T): T

Inherited from Node.appendChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10329

Type parameters:

T : Node

Parameters:

Name Type
newChild T

Returns: T


attachShadow

attachShadow(shadowRootInitDict: ShadowRootInit): ShadowRoot

Inherited from Element.attachShadow

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4716

Creates a shadow root for element and returns it.

Parameters:

Name Type
shadowRootInitDict ShadowRootInit

Returns: ShadowRoot


attributeChangedCallback

attributeChangedCallback(name: string, oldValue: string, newValue: string): void

Inherited from AbstractBaseComponent.attributeChangedCallback

Defined in base/abstract.base.component.ts:98

Parameters:

Name Type
name string
oldValue string
newValue string

Returns: void


before

before(...nodes: (string | Node)[]): void

Inherited from ChildNode.before

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3085

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


blur

blur(): void

Inherited from HTMLOrSVGElement.blur

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7558

Returns: void


click

click(): void

Inherited from HTMLElement.click

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6082

Returns: void


cloneNode

cloneNode(deep?: boolean): Node

Inherited from Node.cloneNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10333

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

Parameters:

Name Type
Optional deep boolean

Returns: Node


closest

closest<K>(selector: K): HTMLElementTagNameMap[K] | null

closest<K>(selector: K): SVGElementTagNameMap[K] | null

closest(selector: string): Element | null

Inherited from Element.closest

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4720

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

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
selector K

Returns: HTMLElementTagNameMap[K] | null

Inherited from Element.closest

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4721

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
selector K

Returns: SVGElementTagNameMap[K] | null

Inherited from Element.closest

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4722

Parameters:

Name Type
selector string

Returns: Element | null


compareDocumentPosition

compareDocumentPosition(other: Node): number

Inherited from Node.compareDocumentPosition

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10334

Parameters:

Name Type
other Node

Returns: number


connectedCallback

connectedCallback(): void

Inherited from AbstractBaseComponent.connectedCallback

Defined in base/abstract.base.component.ts:88

Returns: void


contains

contains(other: Node | null): boolean

Inherited from Node.contains

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10338

Returns true if other is an inclusive descendant of node, and false otherwise.

Parameters:

Name Type
other Node | null

Returns: boolean


disconnectedCallback

disconnectedCallback(): void

Inherited from AbstractBaseComponent.disconnectedCallback

Defined in base/abstract.base.component.ts:93

Returns: void


dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4956

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:

Name Type
event Event

Returns: boolean


focus

focus(options?: FocusOptions): void

Inherited from HTMLOrSVGElement.focus

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7559

Parameters:

Name Type
Optional options FocusOptions

Returns: void


getAnimations

getAnimations(): Animation[]

Inherited from Animatable.getAnimations

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1696

Returns: Animation[]


getAttribute

getAttribute(qualifiedName: string): string | null

Inherited from Element.getAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4726

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

Parameters:

Name Type
qualifiedName string

Returns: string | null


getAttributeNS

getAttributeNS(namespace: string | null, localName: string): string | null

Inherited from Element.getAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4731

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

Parameters:

Name Type
namespace string | null
localName string

Returns: string | null


getAttributeNames

getAttributeNames(): string[]

Inherited from Element.getAttributeNames

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4736

Returns the qualified names of all element's attributes. Can contain duplicates.

Returns: string[]


getAttributeNode

getAttributeNode(name: string): Attr | null

Inherited from Element.getAttributeNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4737

Parameters:

Name Type
name string

Returns: Attr | null


getAttributeNodeNS

getAttributeNodeNS(namespaceURI: string, localName: string): Attr | null

Inherited from Element.getAttributeNodeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4738

Parameters:

Name Type
namespaceURI string
localName string

Returns: Attr | null


getBoundingClientRect

getBoundingClientRect(): ClientRect | DOMRect

Inherited from Element.getBoundingClientRect

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4739

Returns: ClientRect | DOMRect


getClientRects

getClientRects(): ClientRectList | DOMRectList

Inherited from Element.getClientRects

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4740

Returns: ClientRectList | DOMRectList


getElementsByClassName

getElementsByClassName(classNames: string): HTMLCollectionOf<Element>

Inherited from Element.getElementsByClassName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4741

Parameters:

Name Type
classNames string

Returns: HTMLCollectionOf<Element>


getElementsByTagName

getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>

getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>

getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>

Inherited from Element.getElementsByTagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4742

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
qualifiedName K

Returns: HTMLCollectionOf<HTMLElementTagNameMap[K]>

Inherited from Element.getElementsByTagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4743

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
qualifiedName K

Returns: HTMLCollectionOf<SVGElementTagNameMap[K]>

Inherited from Element.getElementsByTagName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4744

Parameters:

Name Type
qualifiedName string

Returns: HTMLCollectionOf<Element>


getElementsByTagNameNS

getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>

getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>

getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>

Inherited from Element.getElementsByTagNameNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4745

Parameters:

Name Type
namespaceURI "http://www.w3.org/1999/xhtml"
localName string

Returns: HTMLCollectionOf<HTMLElement>

Inherited from Element.getElementsByTagNameNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4746

Parameters:

Name Type
namespaceURI "http://www.w3.org/2000/svg"
localName string

Returns: HTMLCollectionOf<SVGElement>

Inherited from Element.getElementsByTagNameNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4747

Parameters:

Name Type
namespaceURI string
localName string

Returns: HTMLCollectionOf<Element>


getRootNode

getRootNode(options?: GetRootNodeOptions): Node

Inherited from Node.getRootNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10342

Returns node's shadow-including root.

Parameters:

Name Type
Optional options GetRootNodeOptions

Returns: Node


hasAttribute

hasAttribute(qualifiedName: string): boolean

Inherited from Element.hasAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4751

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

Parameters:

Name Type
qualifiedName string

Returns: boolean


hasAttributeNS

hasAttributeNS(namespace: string | null, localName: string): boolean

Inherited from Element.hasAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4755

Returns true if element has an attribute whose namespace is namespace and local name is localName.

Parameters:

Name Type
namespace string | null
localName string

Returns: boolean


hasAttributes

hasAttributes(): boolean

Inherited from Element.hasAttributes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4759

Returns true if element has attributes, and false otherwise.

Returns: boolean


hasChildNodes

hasChildNodes(): boolean

Inherited from Node.hasChildNodes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10346

Returns whether node has children.

Returns: boolean


hasPointerCapture

hasPointerCapture(pointerId: number): boolean

Inherited from Element.hasPointerCapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4760

Parameters:

Name Type
pointerId number

Returns: boolean


insertAdjacentElement

insertAdjacentElement(position: InsertPosition, insertedElement: Element): Element | null

Inherited from Element.insertAdjacentElement

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4761

Parameters:

Name Type
position InsertPosition
insertedElement Element

Returns: Element | null


insertAdjacentHTML

insertAdjacentHTML(where: InsertPosition, html: string): void

Inherited from Element.insertAdjacentHTML

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4762

Parameters:

Name Type
where InsertPosition
html string

Returns: void


insertAdjacentText

insertAdjacentText(where: InsertPosition, text: string): void

Inherited from Element.insertAdjacentText

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4763

Parameters:

Name Type
where InsertPosition
text string

Returns: void


insertBefore

insertBefore<T>(newChild: T, refChild: Node | null): T

Inherited from Node.insertBefore

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10347

Type parameters:

T : Node

Parameters:

Name Type
newChild T
refChild Node | null

Returns: T


isDefaultNamespace

isDefaultNamespace(namespace: string | null): boolean

Inherited from Node.isDefaultNamespace

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10348

Parameters:

Name Type
namespace string | null

Returns: boolean


isEqualNode

isEqualNode(otherNode: Node | null): boolean

Inherited from Node.isEqualNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10352

Returns whether node and otherNode have the same properties.

Parameters:

Name Type
otherNode Node | null

Returns: boolean


isSameNode

isSameNode(otherNode: Node | null): boolean

Inherited from Node.isSameNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10353

Parameters:

Name Type
otherNode Node | null

Returns: boolean


lookupNamespaceURI

lookupNamespaceURI(prefix: string | null): string | null

Inherited from Node.lookupNamespaceURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10354

Parameters:

Name Type
prefix string | null

Returns: string | null


lookupPrefix

lookupPrefix(namespace: string | null): string | null

Inherited from Node.lookupPrefix

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10355

Parameters:

Name Type
namespace string | null

Returns: string | null


matches

matches(selectors: string): boolean

Inherited from Element.matches

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4767

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

Parameters:

Name Type
selectors string

Returns: boolean


msGetRegionContent

msGetRegionContent(): any

Inherited from Element.msGetRegionContent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4768

Returns: any


normalize

normalize(): void

Inherited from Node.normalize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10359

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

Returns: void


prepend

prepend(...nodes: (string | Node)[]): void

Inherited from ParentNode.prepend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10735

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.

Parameters:

Name Type
Rest nodes (string | Node)[]

Returns: void


querySelector

querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null

querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null

querySelector<E>(selectors: string): E | null

Inherited from ParentNode.querySelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10740

Returns the first element that is a descendant of node that matches selectors.

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
selectors K

Returns: HTMLElementTagNameMap[K] | null

Inherited from ParentNode.querySelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10741

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
selectors K

Returns: SVGElementTagNameMap[K] | null

Inherited from ParentNode.querySelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10742

Type parameters:

E : Element

Parameters:

Name Type
selectors string

Returns: E | null


querySelectorAll

querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>

querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>

querySelectorAll<E>(selectors: string): NodeListOf<E>

Inherited from ParentNode.querySelectorAll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10747

Returns all element descendants of node that match selectors.

Type parameters:

K : keyof HTMLElementTagNameMap

Parameters:

Name Type
selectors K

Returns: NodeListOf<HTMLElementTagNameMap[K]>

Inherited from ParentNode.querySelectorAll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10748

Type parameters:

K : keyof SVGElementTagNameMap

Parameters:

Name Type
selectors K

Returns: NodeListOf<SVGElementTagNameMap[K]>

Inherited from ParentNode.querySelectorAll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10749

Type parameters:

E : Element

Parameters:

Name Type
selectors string

Returns: NodeListOf<E>


releasePointerCapture

releasePointerCapture(pointerId: number): void

Inherited from Element.releasePointerCapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4769

Parameters:

Name Type
pointerId number

Returns: void


remove

remove(): void

Inherited from ChildNode.remove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3089

Removes node.

Returns: void


removeAttribute

removeAttribute(qualifiedName: string): void

Inherited from Element.removeAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4773

Removes element's first attribute whose qualified name is qualifiedName.

Parameters:

Name Type
qualifiedName string

Returns: void


removeAttributeNS

removeAttributeNS(namespace: string | null, localName: string): void

Inherited from Element.removeAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4777

Removes element's attribute whose namespace is namespace and local name is localName.

Parameters:

Name Type
namespace string | null
localName string

Returns: void


removeAttributeNode

removeAttributeNode(attr: Attr): Attr

Inherited from Element.removeAttributeNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4778

Parameters:

Name Type
attr Attr

Returns: Attr


removeChild

removeChild<T>(oldChild: T): T

Inherited from Node.removeChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10360

Type parameters:

T : Node

Parameters:

Name Type
oldChild T

Returns: T


removeEventListener

removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void

removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Inherited from HTMLElement.removeEventListener

Overrides Element.removeEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6085

Type parameters:

K : keyof HTMLElementEventMap

Parameters:

Name Type
type K
listener function
Optional options boolean | EventListenerOptions

Returns: void

Inherited from HTMLElement.removeEventListener

Overrides Element.removeEventListener

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6086

Parameters:

Name Type
type string
listener EventListenerOrEventListenerObject
Optional options boolean | EventListenerOptions

Returns: void


replaceChild

replaceChild<T>(newChild: Node, oldChild: T): T

Inherited from Node.replaceChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10361

Type parameters:

T : Node

Parameters:

Name Type
newChild Node
oldChild T

Returns: T


replaceWith

replaceWith(...nodes: (string | Node)[]): void

Inherited from ChildNode.replaceWith

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:3095

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:

Name Type
Rest nodes (string | Node)[]

Returns: void


requestFullscreen

requestFullscreen(): Promise<void>

Inherited from Element.requestFullscreen

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4782

Displays element fullscreen and resolves promise when done.

Returns: Promise<void>


scroll

scroll(options?: ScrollToOptions): void

scroll(x: number, y: number): void

Inherited from Element.scroll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4783

Parameters:

Name Type
Optional options ScrollToOptions

Returns: void

Inherited from Element.scroll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4784

Parameters:

Name Type
x number
y number

Returns: void


scrollBy

scrollBy(options?: ScrollToOptions): void

scrollBy(x: number, y: number): void

Inherited from Element.scrollBy

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4785

Parameters:

Name Type
Optional options ScrollToOptions

Returns: void

Inherited from Element.scrollBy

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4786

Parameters:

Name Type
x number
y number

Returns: void


scrollIntoView

scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void

Inherited from Element.scrollIntoView

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4787

Parameters:

Name Type
Optional arg boolean | ScrollIntoViewOptions

Returns: void


scrollTo

scrollTo(options?: ScrollToOptions): void

scrollTo(x: number, y: number): void

Inherited from Element.scrollTo

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4788

Parameters:

Name Type
Optional options ScrollToOptions

Returns: void

Inherited from Element.scrollTo

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4789

Parameters:

Name Type
x number
y number

Returns: void


setAttribute

setAttribute(qualifiedName: string, value: string): void

Inherited from Element.setAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4793

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

Parameters:

Name Type
qualifiedName string
value string

Returns: void


setAttributeNS

setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void

Inherited from Element.setAttributeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4797

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

Parameters:

Name Type
namespace string | null
qualifiedName string
value string

Returns: void


setAttributeNode

setAttributeNode(attr: Attr): Attr | null

Inherited from Element.setAttributeNode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4798

Parameters:

Name Type
attr Attr

Returns: Attr | null


setAttributeNodeNS

setAttributeNodeNS(attr: Attr): Attr | null

Inherited from Element.setAttributeNodeNS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4799

Parameters:

Name Type
attr Attr

Returns: Attr | null


setPointerCapture

setPointerCapture(pointerId: number): void

Inherited from Element.setPointerCapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4800

Parameters:

Name Type
pointerId number

Returns: void


toggleAttribute

toggleAttribute(qualifiedName: string, force?: boolean): boolean

Inherited from Element.toggleAttribute

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4806

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:

Name Type
qualifiedName string
Optional force boolean

Returns: boolean


webkitMatchesSelector

webkitMatchesSelector(selectors: string): boolean

Inherited from Element.webkitMatchesSelector

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4807

Parameters:

Name Type
selectors string

Returns: boolean


@ibm-wch-sdk/web-components > "content/content.component" > ContentComponent

Class: ContentComponent

Hierarchy

AbstractBaseComponent

↳ ContentComponent

Implements

  • RenderingContextProvider

Index

Constructors

Properties

Accessors

Methods


Constructors

constructor

new ContentComponent(): ContentComponent

Overrides AbstractBaseComponent.constructor

Defined in content/content.component.ts:44

Returns: ContentComponent


Properties

ATTRIBUTE_NODE

● ATTRIBUTE_NODE: number

Inherited from Node.ATTRIBUTE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10362


CDATA_SECTION_NODE

● CDATA_SECTION_NODE: number

Inherited from Node.CDATA_SECTION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10363


COMMENT_NODE

● COMMENT_NODE: number

Inherited from Node.COMMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10364


DOCUMENT_FRAGMENT_NODE

● DOCUMENT_FRAGMENT_NODE: number

Inherited from Node.DOCUMENT_FRAGMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10365


DOCUMENT_NODE

● DOCUMENT_NODE: number

Inherited from Node.DOCUMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10366


DOCUMENT_POSITION_CONTAINED_BY

● DOCUMENT_POSITION_CONTAINED_BY: number

Inherited from Node.DOCUMENT_POSITION_CONTAINED_BY

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10367


DOCUMENT_POSITION_CONTAINS

● DOCUMENT_POSITION_CONTAINS: number

Inherited from Node.DOCUMENT_POSITION_CONTAINS

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10368


DOCUMENT_POSITION_DISCONNECTED

● DOCUMENT_POSITION_DISCONNECTED: number

Inherited from Node.DOCUMENT_POSITION_DISCONNECTED

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10369


DOCUMENT_POSITION_FOLLOWING

● DOCUMENT_POSITION_FOLLOWING: number

Inherited from Node.DOCUMENT_POSITION_FOLLOWING

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10370


DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

● DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Inherited from Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10371


DOCUMENT_POSITION_PRECEDING

● DOCUMENT_POSITION_PRECEDING: number

Inherited from Node.DOCUMENT_POSITION_PRECEDING

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10372


DOCUMENT_TYPE_NODE

● DOCUMENT_TYPE_NODE: number

Inherited from Node.DOCUMENT_TYPE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10373


ELEMENT_NODE

● ELEMENT_NODE: number

Inherited from Node.ELEMENT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10374


ENTITY_NODE

● ENTITY_NODE: number

Inherited from Node.ENTITY_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10375


ENTITY_REFERENCE_NODE

● ENTITY_REFERENCE_NODE: number

Inherited from Node.ENTITY_REFERENCE_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10376


NOTATION_NODE

● NOTATION_NODE: number

Inherited from Node.NOTATION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10377


PROCESSING_INSTRUCTION_NODE

● PROCESSING_INSTRUCTION_NODE: number

Inherited from Node.PROCESSING_INSTRUCTION_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10378


TEXT_NODE

● TEXT_NODE: number

Inherited from Node.TEXT_NODE

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10379


<Private> _id

● _id: Consumer<any>

Defined in content/content.component.ts:37


<Private> _levels

● _levels: Consumer<any>

Defined in content/content.component.ts:38


<Protected> _onDestroy

● _onDestroy: Observable<this>

Inherited from AbstractBaseComponent._onDestroy

Defined in base/abstract.base.component.ts:24


<Protected> _onInit

● _onInit: Observable<this>

Inherited from AbstractBaseComponent._onInit

Defined in base/abstract.base.component.ts:23


<Protected> _onLayoutMode

● _onLayoutMode: Observable<string>

Inherited from AbstractBaseComponent._onLayoutMode

Defined in base/abstract.base.component.ts:30


<Protected> _onLoggerService

● _onLoggerService: Observable<LoggerService>

Inherited from AbstractBaseComponent._onLoggerService

Defined in base/abstract.base.component.ts:28


<Protected> _onSdk

● _onSdk: Observable<WchSdk>

Inherited from AbstractBaseComponent._onSdk

Defined in base/abstract.base.component.ts:26


accessKey

● accessKey: string

Inherited from HTMLElement.accessKey

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6066


accessKeyLabel

● accessKeyLabel: string

Inherited from HTMLElement.accessKeyLabel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6067


assignedSlot

● assignedSlot: HTMLSlotElement | null

Inherited from Element.assignedSlot

Overrides Slotable.assignedSlot

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4659


attributes

● attributes: NamedNodeMap

Inherited from Element.attributes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4660


autocapitalize

● autocapitalize: string

Inherited from HTMLElement.autocapitalize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6068


baseURI

● baseURI: string

Inherited from Node.baseURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10264

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


childElementCount

● childElementCount: number

Inherited from ParentNode.childElementCount

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10709


childNodes

● childNodes: NodeListOf<ChildNode>

Inherited from Node.childNodes

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10268

Returns the children.


children

● children: HTMLCollection

Inherited from ParentNode.children

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10713

Returns the child elements.


classList

● classList: DOMTokenList

Inherited from Element.classList

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4665

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


className

● className: string

Inherited from Element.className

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4670

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


clientHeight

● clientHeight: number

Inherited from Element.clientHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4671


clientLeft

● clientLeft: number

Inherited from Element.clientLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4672


clientTop

● clientTop: number

Inherited from Element.clientTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4673


clientWidth

● clientWidth: number

Inherited from Element.clientWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4674


contentEditable

● contentEditable: string

Inherited from ElementContentEditable.contentEditable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4824


dataset

● dataset: DOMStringMap

Inherited from HTMLOrSVGElement.dataset

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7555


dir

● dir: string

Inherited from HTMLElement.dir

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6069


draggable

● draggable: boolean

Inherited from HTMLElement.draggable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6070


firstChild

● firstChild: ChildNode | null

Inherited from Node.firstChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10272

Returns the first child.


firstElementChild

● firstElementChild: Element | null

Inherited from ParentNode.firstElementChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10717

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


hidden

● hidden: boolean

Inherited from HTMLElement.hidden

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6071


innerHTML

● innerHTML: string

Inherited from Element.innerHTML

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4680


innerText

● innerText: string

Inherited from HTMLElement.innerText

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6072


inputMode

● inputMode: string

Inherited from ElementContentEditable.inputMode

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4825


isConnected

● isConnected: boolean

Inherited from Node.isConnected

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10276

Returns true if node is connected and false otherwise.


isContentEditable

● isContentEditable: boolean

Inherited from ElementContentEditable.isContentEditable

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4826


lang

● lang: string

Inherited from HTMLElement.lang

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6073


lastChild

● lastChild: ChildNode | null

Inherited from Node.lastChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10280

Returns the last child.


lastElementChild

● lastElementChild: Element | null

Inherited from ParentNode.lastElementChild

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10721

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


localName

● localName: string

Inherited from Element.localName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4684

Returns the local name.


namespaceURI

● namespaceURI: string | null

Inherited from Element.namespaceURI

Overrides Node.namespaceURI

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4688

Returns the namespace.


nextElementSibling

● nextElementSibling: Element | null

Inherited from NonDocumentTypeChildNode.nextElementSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10493

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


nextSibling

● nextSibling: Node | null

Inherited from Node.nextSibling

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10285

Returns the next sibling.


nodeName

● nodeName: string

Inherited from Node.nodeName

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10308

Returns a string appropriate for the type of node, as follows: Element Its HTML-uppercased qualified name. Attr Its qualified name. Text "#text". CDATASection "#cdata-section". ProcessingInstruction Its target. Comment "#comment". Document "#document". DocumentType Its name. DocumentFragment "#document-fragment".


nodeType

● nodeType: number

Inherited from Node.nodeType

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10309


nodeValue

● nodeValue: string | null

Inherited from Node.nodeValue

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10310


nonce

● nonce: string

Inherited from HTMLOrSVGElement.nonce

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7556


offsetHeight

● offsetHeight: number

Inherited from HTMLElement.offsetHeight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6074


offsetLeft

● offsetLeft: number

Inherited from HTMLElement.offsetLeft

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6075


offsetParent

● offsetParent: Element | null

Inherited from HTMLElement.offsetParent

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6076


offsetTop

● offsetTop: number

Inherited from HTMLElement.offsetTop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6077


offsetWidth

● offsetWidth: number

Inherited from HTMLElement.offsetWidth

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6078


onId

● onId: Observable<string>

Defined in content/content.component.ts:34


onLayoutMode

● onLayoutMode: Observable<string>

Defined in content/content.component.ts:32


onLevels

● onLevels: Observable<number>

Defined in content/content.component.ts:35


onRenderingContext

● onRenderingContext: Observable<RenderingContext>

Defined in content/content.component.ts:31


onabort

● onabort: function | null

Inherited from GlobalEventHandlers.onabort

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5269

Fires when the user aborts the download.

param: The event.


onanimationcancel

● onanimationcancel: function | null

Inherited from GlobalEventHandlers.onanimationcancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5270


onanimationend

● onanimationend: function | null

Inherited from GlobalEventHandlers.onanimationend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5271


onanimationiteration

● onanimationiteration: function | null

Inherited from GlobalEventHandlers.onanimationiteration

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5272


onanimationstart

● onanimationstart: function | null

Inherited from GlobalEventHandlers.onanimationstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5273


onauxclick

● onauxclick: function | null

Inherited from GlobalEventHandlers.onauxclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5274


onblur

● onblur: function | null

Inherited from GlobalEventHandlers.onblur

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5279

Fires when the object loses the input focus.

param: The focus event.


oncancel

● oncancel: function | null

Inherited from GlobalEventHandlers.oncancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5280


oncanplay

● oncanplay: function | null

Inherited from GlobalEventHandlers.oncanplay

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5285

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

param: The event.


oncanplaythrough

● oncanplaythrough: function | null

Inherited from GlobalEventHandlers.oncanplaythrough

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5286


onchange

● onchange: function | null

Inherited from GlobalEventHandlers.onchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5291

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

param: The event.


onclick

● onclick: function | null

Inherited from GlobalEventHandlers.onclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5296

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

param: The mouse event.


onclose

● onclose: function | null

Inherited from GlobalEventHandlers.onclose

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5297


oncontextmenu

● oncontextmenu: function | null

Inherited from GlobalEventHandlers.oncontextmenu

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5302

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

param: The mouse event.


oncopy

● oncopy: function | null

Inherited from DocumentAndElementEventHandlers.oncopy

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4468


oncuechange

● oncuechange: function | null

Inherited from GlobalEventHandlers.oncuechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5303


oncut

● oncut: function | null

Inherited from DocumentAndElementEventHandlers.oncut

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4469


ondblclick

● ondblclick: function | null

Inherited from GlobalEventHandlers.ondblclick

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5308

Fires when the user double-clicks the object.

param: The mouse event.


ondrag

● ondrag: function | null

Inherited from GlobalEventHandlers.ondrag

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5313

Fires on the source object continuously during a drag operation.

param: The event.


ondragend

● ondragend: function | null

Inherited from GlobalEventHandlers.ondragend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5318

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

param: The event.


ondragenter

● ondragenter: function | null

Inherited from GlobalEventHandlers.ondragenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5323

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

param: The drag event.


ondragexit

● ondragexit: function | null

Inherited from GlobalEventHandlers.ondragexit

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5324


ondragleave

● ondragleave: function | null

Inherited from GlobalEventHandlers.ondragleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5329

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

param: The drag event.


ondragover

● ondragover: function | null

Inherited from GlobalEventHandlers.ondragover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5334

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

param: The event.


ondragstart

● ondragstart: function | null

Inherited from GlobalEventHandlers.ondragstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5339

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

param: The event.


ondrop

● ondrop: function | null

Inherited from GlobalEventHandlers.ondrop

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5340


ondurationchange

● ondurationchange: function | null

Inherited from GlobalEventHandlers.ondurationchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5345

Occurs when the duration attribute is updated.

param: The event.


onemptied

● onemptied: function | null

Inherited from GlobalEventHandlers.onemptied

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5350

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

param: The event.


onended

● onended: function | null

Inherited from GlobalEventHandlers.onended

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5355

Occurs when the end of playback is reached.

param: The event


onerror

● onerror: ErrorEventHandler

Inherited from GlobalEventHandlers.onerror

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5360

Fires when an error occurs during object loading.

param: The event.


onfocus

● onfocus: function | null

Inherited from GlobalEventHandlers.onfocus

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5365

Fires when the object receives focus.

param: The event.


onfullscreenchange

● onfullscreenchange: function | null

Inherited from Element.onfullscreenchange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4689


onfullscreenerror

● onfullscreenerror: function | null

Inherited from Element.onfullscreenerror

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4690


ongotpointercapture

● ongotpointercapture: function | null

Inherited from GlobalEventHandlers.ongotpointercapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5366


oninput

● oninput: function | null

Inherited from GlobalEventHandlers.oninput

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5367


oninvalid

● oninvalid: function | null

Inherited from GlobalEventHandlers.oninvalid

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5368


onkeydown

● onkeydown: function | null

Inherited from GlobalEventHandlers.onkeydown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5373

Fires when the user presses a key.

param: The keyboard event


onkeypress

● onkeypress: function | null

Inherited from GlobalEventHandlers.onkeypress

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5378

Fires when the user presses an alphanumeric key.

param: The event.


onkeyup

● onkeyup: function | null

Inherited from GlobalEventHandlers.onkeyup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5383

Fires when the user releases a key.

param: The keyboard event


onload

● onload: function | null

Inherited from GlobalEventHandlers.onload

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5388

Fires immediately after the browser loads the object.

param: The event.


onloadeddata

● onloadeddata: function | null

Inherited from GlobalEventHandlers.onloadeddata

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5393

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

param: The event.


onloadedmetadata

● onloadedmetadata: function | null

Inherited from GlobalEventHandlers.onloadedmetadata

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5398

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

param: The event.


onloadend

● onloadend: function | null

Inherited from GlobalEventHandlers.onloadend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5399


onloadstart

● onloadstart: function | null

Inherited from GlobalEventHandlers.onloadstart

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5404

Occurs when Internet Explorer begins looking for media data.

param: The event.


onlostpointercapture

● onlostpointercapture: function | null

Inherited from GlobalEventHandlers.onlostpointercapture

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5405


onmousedown

● onmousedown: function | null

Inherited from GlobalEventHandlers.onmousedown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5410

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

param: The mouse event.


onmouseenter

● onmouseenter: function | null

Inherited from GlobalEventHandlers.onmouseenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5411


onmouseleave

● onmouseleave: function | null

Inherited from GlobalEventHandlers.onmouseleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5412


onmousemove

● onmousemove: function | null

Inherited from GlobalEventHandlers.onmousemove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5417

Fires when the user moves the mouse over the object.

param: The mouse event.


onmouseout

● onmouseout: function | null

Inherited from GlobalEventHandlers.onmouseout

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5422

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

param: The mouse event.


onmouseover

● onmouseover: function | null

Inherited from GlobalEventHandlers.onmouseover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5427

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

param: The mouse event.


onmouseup

● onmouseup: function | null

Inherited from GlobalEventHandlers.onmouseup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5432

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

param: The mouse event.


onpaste

● onpaste: function | null

Inherited from DocumentAndElementEventHandlers.onpaste

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4470


onpause

● onpause: function | null

Inherited from GlobalEventHandlers.onpause

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5437

Occurs when playback is paused.

param: The event.


onplay

● onplay: function | null

Inherited from GlobalEventHandlers.onplay

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5442

Occurs when the play method is requested.

param: The event.


onplaying

● onplaying: function | null

Inherited from GlobalEventHandlers.onplaying

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5447

Occurs when the audio or video has started playing.

param: The event.


onpointercancel

● onpointercancel: function | null

Inherited from GlobalEventHandlers.onpointercancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5448


onpointerdown

● onpointerdown: function | null

Inherited from GlobalEventHandlers.onpointerdown

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5449


onpointerenter

● onpointerenter: function | null

Inherited from GlobalEventHandlers.onpointerenter

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5450


onpointerleave

● onpointerleave: function | null

Inherited from GlobalEventHandlers.onpointerleave

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5451


onpointermove

● onpointermove: function | null

Inherited from GlobalEventHandlers.onpointermove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5452


onpointerout

● onpointerout: function | null

Inherited from GlobalEventHandlers.onpointerout

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5453


onpointerover

● onpointerover: function | null

Inherited from GlobalEventHandlers.onpointerover

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5454


onpointerup

● onpointerup: function | null

Inherited from GlobalEventHandlers.onpointerup

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5455


onprogress

● onprogress: function | null

Inherited from GlobalEventHandlers.onprogress

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5460

Occurs to indicate progress while downloading media data.

param: The event.


onratechange

● onratechange: function | null

Inherited from GlobalEventHandlers.onratechange

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5465

Occurs when the playback rate is increased or decreased.

param: The event.


onreset

● onreset: function | null

Inherited from GlobalEventHandlers.onreset

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5470

Fires when the user resets a form.

param: The event.


onresize

● onresize: function | null

Inherited from GlobalEventHandlers.onresize

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5471


onscroll

● onscroll: function | null

Inherited from GlobalEventHandlers.onscroll

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5476

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

param: The event.


onsecuritypolicyviolation

● onsecuritypolicyviolation: function | null

Inherited from GlobalEventHandlers.onsecuritypolicyviolation

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5477


onseeked

● onseeked: function | null

Inherited from GlobalEventHandlers.onseeked

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5482

Occurs when the seek operation ends.

param: The event.


onseeking

● onseeking: function | null

Inherited from GlobalEventHandlers.onseeking

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5487

Occurs when the current playback position is moved.

param: The event.


onselect

● onselect: function | null

Inherited from GlobalEventHandlers.onselect

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5492

Fires when the current selection changes.

param: The event.


onstalled

● onstalled: function | null

Inherited from GlobalEventHandlers.onstalled

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5497

Occurs when the download has stopped.

param: The event.


onsubmit

● onsubmit: function | null

Inherited from GlobalEventHandlers.onsubmit

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5498


onsuspend

● onsuspend: function | null

Inherited from GlobalEventHandlers.onsuspend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5503

Occurs if the load operation has been intentionally halted.

param: The event.


ontimeupdate

● ontimeupdate: function | null

Inherited from GlobalEventHandlers.ontimeupdate

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5508

Occurs to indicate the current playback position.

param: The event.


ontoggle

● ontoggle: function | null

Inherited from GlobalEventHandlers.ontoggle

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5509


ontouchcancel

● ontouchcancel: function | null

Inherited from GlobalEventHandlers.ontouchcancel

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5510


ontouchend

● ontouchend: function | null

Inherited from GlobalEventHandlers.ontouchend

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5511


ontouchmove

● ontouchmove: function | null

Inherited from GlobalEventHandlers.ontouchmove

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5512


ontouchstart

● ontouchstart: function | null

*Inherited from GlobalEventHandlers.ontouch

/@ibm-wch-sdk/web-components/

    Package Sidebar

    Install

    npm i @ibm-wch-sdk/web-components

    Weekly Downloads

    2

    Version

    6.0.524

    License

    MIT

    Unpacked Size

    1.66 MB

    Total Files

    87

    Last publish

    Collaborators

    • marcin-pasiewicz
    • nikodem.graczewski.acoustic
    • willizard
    • pawel.galias-ac