ibm-wch-sdk-api
Exposes framework independent APIs for ibm-wch-sdk-ng and similar SDKs.
Details
Refer to the documentation.
Changes
Class documentation
Refer to the documentation.
Usage
Install the module via
npm install --save ibm-wch-sdk-themeAPI
Changelog
Current
Added
- New config option "siteId" to configure a site identifier
6.0.69
Changed
- Support for Angular 6
Added
- New quick access fields
groupandgroupson theRenderingContext - Typing support for
groupelements - Declaration of the event types and payloads for cross iframe events to switch between public and protected mode.
5.0.217
Added
- Initial version
@ibm-wch-sdk/layout-editor
Index
External modules
@ibm-wch-sdk/layout-editor > "dnd.namespace"
External module: "dnd.namespace"
Index
Interfaces
Type aliases
Variables
Type aliases
Parameters
Ƭ Parameters: Record<string, string>
Defined in dnd.namespace.ts:4
Variables
<Const> KEY_EFFECT_ALLOWED
● KEY_EFFECT_ALLOWED: "com.ibm.portal.dnd.effect.allowed" = "com.ibm.portal.dnd.effect.allowed"
Defined in dnd.namespace.ts:2
<Const> KEY_PAYLOAD
● KEY_PAYLOAD: "com.ibm.portal.dnd.payload" = "com.ibm.portal.dnd.payload"
Defined in dnd.namespace.ts:1
@ibm-wch-sdk/layout-editor > "dnd.source"
External module: "dnd.source"
Index
Type aliases
Variables
- _DATA_PARAM_PREFIX
- _DATA_PREFIX
- _JSON
- _TRANSFER_TYPE
- _document
- _keyEffectAllowed
- _keyPayload
- _localStorage
- _onDrag
Functions
- _addAddressable
- _addAddressablesFromDefinitionList
- _addAddressablesFromElement
- _addAddressablesFromString
- _addEventListener
- _addEventListeners
- _clearLocalStorage
- _createAddressable
- _encodePayload
- _getDataFromNode
- _getDataTransfer
- _getDragSource
- _getElement
- _getElementById
- _getTextContent
- _getType
- _isAnchor
- _isArray
- _isDefinitionList
- _isDiv
- _isNodeList
- _isObject
- _isString
- _noop
- _objectToAddressable
- _objectToJson
- _onDragEnd
- _onDragStart
- _onRemoveEffectAllowed
- _onRemovePayload
- _onSetEffectAllowed
- _onSetPayload
- _preventDefault
- _removeEffectAllowed
- _removePayload
- _setEffectAllowed
- _setPayload
- _setToLocalStorage
- _stringToAddressable
- _toString
- _toStringArray
- _trim
Type aliases
AddressableInput
Ƭ AddressableInput: string | Addressable | HTMLAnchorElement | HTMLDListElement | HTMLDivElement | NodeList | HTMLCollection | Array<string | Addressable | HTMLAnchorElement | HTMLDListElement | HTMLDivElement | HTMLCollection | NodeList>
Defined in dnd.source.ts:12
DndEvent
Ƭ DndEvent: DragEvent & DragEventInit
Defined in dnd.source.ts:30
Variables
<Const> _DATA_PARAM_PREFIX
● _DATA_PARAM_PREFIX: string = _DATA_PREFIX + 'param-'
Defined in dnd.source.ts:62
Prefix for parameter attributes
<Const> _DATA_PREFIX
● _DATA_PREFIX: "data-" = "data-"
Defined in dnd.source.ts:54
Prefix for data attributes
<Const> _JSON
● _JSON: JSON = JSON
Defined in dnd.source.ts:38
<Const> _TRANSFER_TYPE
● _TRANSFER_TYPE: "text" = "text"
Defined in dnd.source.ts:46
Data transfer type
<Const> _document
● _document: Document = document
Defined in dnd.source.ts:799
<Const> _keyEffectAllowed
● _keyEffectAllowed: "com.ibm.portal.dnd.effect.allowed" = KEY_EFFECT_ALLOWED
Defined in dnd.source.ts:792
<Const> _keyPayload
● _keyPayload: "com.ibm.portal.dnd.payload" = KEY_PAYLOAD
Defined in dnd.source.ts:785
<Const> _localStorage
● _localStorage: Storage = localStorage
Defined in dnd.source.ts:806
<Const> _onDrag
● _onDrag: _noop = _noop
Defined in dnd.source.ts:823
The drag callback
Functions
_addAddressable
▸ _addAddressable(aDst: Addressable[], aObject: AddressableInput, aDocument: Document): Addressable[]
Defined in dnd.source.ts:534
Converts the object to an addressable object and adds it to the target array
Parameters:
| Name | Type |
|---|---|
| aDst | Addressable[] |
| aObject | AddressableInput |
| aDocument | Document |
Returns: Addressable[]
_addAddressablesFromDefinitionList
▸ _addAddressablesFromDefinitionList(aDst: Addressable[], aObject: HTMLDListElement): void
Defined in dnd.source.ts:462
Converts a definition list to an addressable object. The URI is stored as the data-uri attribute of the DL item, the parameters are represented as the DT/DD children.
Parameters:
| Name | Type |
|---|---|
| aDst | Addressable[] |
| aObject | HTMLDListElement |
Returns: void
_addAddressablesFromElement
▸ _addAddressablesFromElement(aDst: Addressable[], aObject: Element): void
Defined in dnd.source.ts:406
Converts an HTML element to an addressable object
Parameters:
| Name | Type |
|---|---|
| aDst | Addressable[] |
| aObject | Element |
Returns: void
_addAddressablesFromString
▸ _addAddressablesFromString(aDst: Addressable[], aUris: string, aParams: Parameters): void
Defined in dnd.source.ts:375
Adds a set of addressabled
Parameters:
| Name | Type |
|---|---|
| aDst | Addressable[] |
| aUris | string |
| aParams | Parameters |
Returns: void
_addEventListener
▸ _addEventListener<K>(aElement: HTMLElement, aName: K, aCallback: function): void
Defined in dnd.source.ts:768
Registers an event callback with the element
Type parameters:
K : keyof HTMLElementEventMap
Parameters:
| Name | Type |
|---|---|
| aElement | HTMLElement |
| aName | K |
| aCallback | function |
Returns: void
_addEventListeners
▸ _addEventListeners(aElementRef: HTMLElement | string): void
Defined in dnd.source.ts:901
Registers the drag source events with the element
Parameters:
| Name | Type |
|---|---|
| aElementRef |
HTMLElement | string
|
Returns: void
_clearLocalStorage
▸ _clearLocalStorage(aLocalStorageKey: string, aLocalStorage: Storage): void
Defined in dnd.source.ts:662
Performs payload cleanup for the HTML local storage
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
Returns: void
_createAddressable
▸ _createAddressable(aUri: string, aParams: Parameters): Addressable
Defined in dnd.source.ts:322
Constructs an addressable object
Parameters:
| Name | Type |
|---|---|
| aUri | string |
| aParams | Parameters |
Returns: Addressable
_encodePayload
▸ _encodePayload(aAddressables: AddressableInput, aDocument: Document): string
Defined in dnd.source.ts:613
Constructs a string based payload based on the argument list
Parameters:
| Name | Type |
|---|---|
| aAddressables | AddressableInput |
| aDocument | Document |
Returns: string
_getDataFromNode
▸ _getDataFromNode(aName: string, aNode: Element): string
Defined in dnd.source.ts:95
Accesses a data- attribute from a root node
Parameters:
| Name | Type |
|---|---|
| aName | string |
| aNode | Element |
Returns: string
_getDataTransfer
▸ _getDataTransfer(aEvent: DndEvent): DataTransfer
Defined in dnd.source.ts:631
Returns the data transfer object from the event
Parameters:
| Name | Type |
|---|---|
| aEvent | DndEvent |
Returns: DataTransfer
_getDragSource
▸ _getDragSource(): object
Defined in dnd.source.ts:917
Returns the event handlers for a drag source
Returns: object
_getElement
▸ _getElement(aElementRef: HTMLElement | string, aDocument: Document): HTMLElement
Defined in dnd.source.ts:278
Locates an element
Parameters:
| Name | Type |
|---|---|
| aElementRef |
HTMLElement | string
|
| aDocument | Document |
Returns: HTMLElement
_getElementById
▸ _getElementById(aId: string, aDocument: Document): HTMLElement
Defined in dnd.source.ts:81
Returns an element by ID
Parameters:
| Name | Type |
|---|---|
| aId | string |
| aDocument | Document |
Returns: HTMLElement
_getTextContent
▸ _getTextContent(aElement: Element): string
Defined in dnd.source.ts:308
Accesses the textual content of an element
Parameters:
| Name | Type |
|---|---|
| aElement | Element |
Returns: string
_getType
▸ _getType(aObject: any): string
Defined in dnd.source.ts:147
Returns a type string for the object
Parameters:
| Name | Type |
|---|---|
| aObject | any |
Returns: string
_isAnchor
▸ _isAnchor(aType: string): boolean
Defined in dnd.source.ts:213
Checks if the type is an anchor
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isArray
▸ _isArray(aType: string): boolean
Defined in dnd.source.ts:173
Checks if the type is an array type
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isDefinitionList
▸ _isDefinitionList(aType: string): boolean
Defined in dnd.source.ts:239
Checks if the type is a definition list
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isDiv
▸ _isDiv(aType: string): boolean
Defined in dnd.source.ts:226
Checks if the type is a div element
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isNodeList
▸ _isNodeList(aType: string): boolean
Defined in dnd.source.ts:199
Checks if the type is a list of HTML elements
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isObject
▸ _isObject(aType: string): boolean
Defined in dnd.source.ts:186
Checks if the type is an object type
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isString
▸ _isString(aType: string): boolean
Defined in dnd.source.ts:160
Checks if the type is a string type
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_noop
▸ _noop(): void
Defined in dnd.source.ts:69
Helper that just does nothing
Returns: void
_objectToAddressable
▸ _objectToAddressable(aObject: any): Addressable
Defined in dnd.source.ts:350
Converts an object to an addressable object
Parameters:
| Name | Type |
|---|---|
| aObject | any |
Returns: Addressable
_objectToJson
▸ _objectToJson(aObject: any): string
Defined in dnd.source.ts:108
Converts an object to a JSON string
Parameters:
| Name | Type |
|---|---|
| aObject | any |
Returns: string
_onDragEnd
▸ _onDragEnd(aEvent: DndEvent): void
Defined in dnd.source.ts:888
The dragend callback
Parameters:
| Name | Type |
|---|---|
| aEvent | DndEvent |
Returns: void
_onDragStart
▸ _onDragStart(aEvent: DragEvent): void
Defined in dnd.source.ts:813
The dragstart callback
Parameters:
| Name | Type |
|---|---|
| aEvent | DragEvent |
Returns: void
_onRemoveEffectAllowed
▸ _onRemoveEffectAllowed(aEvent: DndEvent): void
Defined in dnd.source.ts:876
Removes the effect allowed property
Parameters:
| Name | Type |
|---|---|
| aEvent | DndEvent |
Returns: void
_onRemovePayload
▸ _onRemovePayload(aEvent: DndEvent): void
Defined in dnd.source.ts:864
Removes the payload
Parameters:
| Name | Type |
|---|---|
| aEvent | DndEvent |
Returns: void
_onSetEffectAllowed
▸ _onSetEffectAllowed(aEvent: DndEvent, aEffect?: string): void
Defined in dnd.source.ts:852
Sets the effect allowed property
Parameters:
| Name | Type |
|---|---|
| aEvent | DndEvent |
Optional aEffect |
string |
Returns: void
_onSetPayload
▸ _onSetPayload(aEvent: DndEvent, ...aAddressables: AddressableInput[]): void
Defined in dnd.source.ts:831
Sets the payload
Parameters:
| Name | Type |
|---|---|
| aEvent | DndEvent |
Rest aAddressables |
AddressableInput[] |
Returns: void
_preventDefault
▸ _preventDefault(aEvent: Event): void
Defined in dnd.source.ts:295
Prevents the default behaviour on the event
Parameters:
| Name | Type |
|---|---|
| aEvent | Event |
Returns: void
_removeEffectAllowed
▸ _removeEffectAllowed(aLocalStorageKey: string, aLocalStorage: Storage, aEvent: DndEvent): void
Defined in dnd.source.ts:750
Cleanup of the effect allowed property, the inverse operation to _setEffectAllowed
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
| aEvent | DndEvent |
Returns: void
_removePayload
▸ _removePayload(aLocalStorageKey: string, aLocalStorage: Storage, aEvent: DndEvent): void
Defined in dnd.source.ts:732
Cleanup of the event payload, the inverse operation to _setPayload
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
| aEvent | DndEvent |
Returns: void
_setEffectAllowed
▸ _setEffectAllowed(aLocalStorageKey: string, aLocalStorage: Storage, aEvent: DndEvent, aEffect?: string): void
Defined in dnd.source.ts:705
Sets the effectAllowed attribute based on what is provided by the data transfer object
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
| aEvent | DndEvent |
Optional aEffect |
string |
Returns: void
_setPayload
▸ _setPayload(aLocalStorageKey: string, aLocalStorage: Storage, aEvent: DndEvent, aAddressables: AddressableInput, aDocument: Document): void
Defined in dnd.source.ts:677
Initializes the HTML5 payload with the given addressables
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
| aEvent | DndEvent |
| aAddressables | AddressableInput |
| aDocument | Document |
Returns: void
_setToLocalStorage
▸ _setToLocalStorage(aPayload: string, aLocalStorageKey: string, aLocalStorage: Storage): void
Defined in dnd.source.ts:645
Stores the DND payload in HTML local storage
Parameters:
| Name | Type |
|---|---|
| aPayload | string |
| aLocalStorageKey | string |
| aLocalStorage | Storage |
Returns: void
_stringToAddressable
▸ _stringToAddressable(aUri: string): Addressable
Defined in dnd.source.ts:337
Converts a string URI string into an addressable object
Parameters:
| Name | Type |
|---|---|
| aUri | string |
Returns: Addressable
_toString
▸ _toString(aObject: any): string
Defined in dnd.source.ts:121
Converts the object to a string
Parameters:
| Name | Type |
|---|---|
| aObject | any |
Returns: string
_toStringArray
▸ _toStringArray(aObject: any): string[]
Defined in dnd.source.ts:252
Converts the object to a string array
Parameters:
| Name | Type |
|---|---|
| aObject | any |
Returns: string[]
_trim
▸ _trim(aString: string): string
Defined in dnd.source.ts:134
Trims whitespaces from the string
Parameters:
| Name | Type |
|---|---|
| aString | string |
Returns: string
@ibm-wch-sdk/layout-editor > "dnd.target"
External module: "dnd.target"
Index
Interfaces
Type aliases
Variables
- _DND_ALL
- _DND_COPY
- _DND_COPY_INDEX
- _DND_COPY_LINK
- _DND_COPY_MOVE
- _DND_LINK
- _DND_LINK_INDEX
- _DND_LINK_MOVE
- _DND_MOVE
- _DND_MOVE_INDEX
- _DND_NONE
- _DND_UNINITIALIZED
- _EFFECTS_ALLOWED
- _EFFECTS_ALLOWED_MAP
- _INPUT_FIELD_DROP_EFFECT
- _INPUT_FIELD_EFFECT_ALLOWED
- _INPUT_FIELD_SOURCE
- _JSON
- _JSON_REGEXP
- _LAST_MODIFIED
- _MIME_TYPE_TEXT
- _Object
- _SCHEME_FILE
- _TRANSFER_TYPE_FILES
- _TRANSFER_TYPE_TEXT
- _document
- _effectAllowed
- _encodeURIComponent
- _keyEffectAllowed
- _keyPayload
- _localStorage
Functions
- _addAddressable
- _addAddressables
- _addDropEffect
- _addEffectAllowed
- _addEventListener
- _addInputField
- _andEffectsAllowed
- _andInteger
- _clearLocalStorage
- _contains
- _copyPayloadTypes
- _createAddressable
- _decodeEffectsAllowed
- _decodeFiles
- _decodePayload
- _getCombinedDropEffect
- _getCombinedEffectsAllowed
- _getDataTransfer
- _getDropEffect
- _getDropEffectFromEffectsAllowed
- _getDropEffectFromEffectsAllowedWithFallback
- _getDropTarget
- _getEffectAllowed
- _getEffectsAllowed
- _getEffectsAllowedIndex
- _getElement
- _getElementById
- _getFromLocalStorage
- _getPayload
- _getPayloadTypes
- _getRESTValidator
- _getType
- _getUrlGenerator
- _getUrlGeneratorFromElement
- _getUrlGeneratorFromUrl
- _hasTransferTypeFiles
- _hasTransferTypeString
- _isAnchor
- _isArray
- _isFunction
- _isJson
- _isString
- _isURL
- _isUninitializedEffectsAllowed
- _isValidPayload
- _jsonToObject
- _noop
- _onAddPayload
- _onGetEffectAllowed
- _onGetPayload
- _onGetRESTValidator
- _prepareValidationURL
- _preventDefault
- _put
- _sendValidationRequest
- _setAttribute
- _setDropEffect
- _setEffectAllowed
- _testEffectAllowed
- _toString
Type aliases
UrlGenerator
Ƭ UrlGenerator: function
Defined in dnd.target.ts:8
Type declaration
▸(addr: Addressable, evt: DragEvent): string
Parameters:
| Name | Type |
|---|---|
| addr | Addressable |
| evt | DragEvent |
Returns: string
ValidationCallback
Ƭ ValidationCallback: function
Defined in dnd.target.ts:9
Type declaration
▸(addr: Addressable, effect: string): any
Parameters:
| Name | Type |
|---|---|
| addr | Addressable |
| effect | string |
Returns: any
Variables
<Const> _DND_ALL
● _DND_ALL: "all" = "all"
Defined in dnd.target.ts:71
DND all operation
<Const> _DND_COPY
● _DND_COPY: "copy" = "copy"
Defined in dnd.target.ts:35
DND copy operation
<Const> _DND_COPY_INDEX
● _DND_COPY_INDEX: 1 = 1
Defined in dnd.target.ts:131
bitmask for the copy effect
<Const> _DND_COPY_LINK
● _DND_COPY_LINK: "copyLink" = "copyLink"
Defined in dnd.target.ts:61
DND copy/link operation
<Const> _DND_COPY_MOVE
● _DND_COPY_MOVE: "copyMove" = "copyMove"
Defined in dnd.target.ts:56
DND copy/move operation
<Const> _DND_LINK
● _DND_LINK: "link" = "link"
Defined in dnd.target.ts:51
DND link operation
<Const> _DND_LINK_INDEX
● _DND_LINK_INDEX: 2 = 2
Defined in dnd.target.ts:141
bitmask for the link effect
<Const> _DND_LINK_MOVE
● _DND_LINK_MOVE: "linkMove" = "linkMove"
Defined in dnd.target.ts:66
DND link/move operation
<Const> _DND_MOVE
● _DND_MOVE: "move" = "move"
Defined in dnd.target.ts:43
DND move operation
<Const> _DND_MOVE_INDEX
● _DND_MOVE_INDEX: 4 = 4
Defined in dnd.target.ts:136
bitmask for the move effect
<Const> _DND_NONE
● _DND_NONE: "none" = "none"
Defined in dnd.target.ts:76
DND none operation
<Const> _DND_UNINITIALIZED
● _DND_UNINITIALIZED: "uninitialized" = "uninitialized"
Defined in dnd.target.ts:27
<Const> _EFFECTS_ALLOWED
● _EFFECTS_ALLOWED: string[] = [
_DND_NONE,
_DND_COPY,
_DND_LINK,
_DND_COPY_LINK,
_DND_MOVE,
_DND_COPY_MOVE,
_DND_LINK_MOVE,
_DND_ALL
]
Defined in dnd.target.ts:147
Complete list of allowed effects, ordered by set bits, assuming that COPY=1, LINK=2, MOVE=4, DND_NONE = 000b = 0, DND_COPY = 001b = 1, DND_LINK = 010b = 2, DND_COPY_LINK = 011b = 3, DND_MOVE = 100b = 4, DND_COPY_MOVE = 101b = 5, DND_LINK_MOVE = 110b = 6, DND_ALL = 111b = 7
<Const> _EFFECTS_ALLOWED_MAP
● _EFFECTS_ALLOWED_MAP: Record<string, number> = (function() {
// initialize the map
var i = _EFFECTS_ALLOWED.length,
effect,
result = {};
while (i > 0) {
// get the effect
effect = _EFFECTS_ALLOWED[--i];
// add in different formats
result[effect] = i;
result[effect.toLowerCase()] = i;
result[effect.toUpperCase()] = i;
}
// ok
return result;
})()
Defined in dnd.target.ts:161
Mapping from effect string to effect index
<Const> _INPUT_FIELD_DROP_EFFECT
● _INPUT_FIELD_DROP_EFFECT: "action" = "action"
Defined in dnd.target.ts:101
The name of the action input field
<Const> _INPUT_FIELD_EFFECT_ALLOWED
● _INPUT_FIELD_EFFECT_ALLOWED: "allowedAction" = "allowedAction"
Defined in dnd.target.ts:106
The name of the allowed action input field
<Const> _INPUT_FIELD_SOURCE
● _INPUT_FIELD_SOURCE: "source" = "source"
Defined in dnd.target.ts:96
The name of the source input field
<Const> _JSON
● _JSON: JSON = JSON
Defined in dnd.target.ts:121
Access to the JSON APIs
<Const> _JSON_REGEXP
● _JSON_REGEXP: RegExp = /{.*}/
Defined in dnd.target.ts:181
Regular expression to test for a JSON string
<Const> _LAST_MODIFIED
● _LAST_MODIFIED: "last-modified" = "last-modified"
Defined in dnd.target.ts:111
Last modified parameter for files
<Const> _MIME_TYPE_TEXT
● _MIME_TYPE_TEXT: "text/plain" = "text/plain"
Defined in dnd.target.ts:86
Mime type for text
<Const> _Object
● _Object: ObjectConstructor = Object
Defined in dnd.target.ts:126
The global object reference
<Const> _SCHEME_FILE
● _SCHEME_FILE: "file:" = "file:"
Defined in dnd.target.ts:116
URI scheme for files
<Const> _TRANSFER_TYPE_FILES
● _TRANSFER_TYPE_FILES: "Files" = "Files"
Defined in dnd.target.ts:91
Data transfer type for files
<Const> _TRANSFER_TYPE_TEXT
● _TRANSFER_TYPE_TEXT: "text" = "text"
Defined in dnd.target.ts:81
Data transfer type for text
<Const> _document
● _document: Document = document
Defined in dnd.target.ts:1108
<Let> _effectAllowed
● _effectAllowed: string
Defined in dnd.target.ts:186
local effect allowed property as retreived from the local storage
<Const> _encodeURIComponent
● _encodeURIComponent: encodeURIComponent = encodeURIComponent
Defined in dnd.target.ts:216
Function that performs URL escaping on strings
<Const> _keyEffectAllowed
● _keyEffectAllowed: "com.ibm.portal.dnd.effect.allowed" = KEY_EFFECT_ALLOWED
Defined in dnd.target.ts:1098
<Const> _keyPayload
● _keyPayload: "com.ibm.portal.dnd.payload" = KEY_PAYLOAD
Defined in dnd.target.ts:1093
<Const> _localStorage
● _localStorage: Storage = localStorage
Defined in dnd.target.ts:1103
Functions
_addAddressable
▸ _addAddressable(aForm: HTMLFormElement, aAddressable: Addressable): void
Defined in dnd.target.ts:642
Adds a single addressable to the form
Parameters:
| Name | Type |
|---|---|
| aForm | HTMLFormElement |
| aAddressable | Addressable |
Returns: void
_addAddressables
▸ _addAddressables(aForm: HTMLFormElement, aAddressables: Addressable[]): void
Defined in dnd.target.ts:683
Adds the event payload to the form
Parameters:
| Name | Type |
|---|---|
| aForm | HTMLFormElement |
| aAddressables | Addressable[] |
Returns: void
_addDropEffect
▸ _addDropEffect(aForm: HTMLFormElement, aDropEffect: string): void
Defined in dnd.target.ts:698
Adds the drop effect to the form
Parameters:
| Name | Type |
|---|---|
| aForm | HTMLFormElement |
| aDropEffect | string |
Returns: void
_addEffectAllowed
▸ _addEffectAllowed(aForm: HTMLFormElement, aEffectAllowed: string): void
Defined in dnd.target.ts:706
Adds the effect allowed property to the form
Parameters:
| Name | Type |
|---|---|
| aForm | HTMLFormElement |
| aEffectAllowed | string |
Returns: void
_addEventListener
▸ _addEventListener<K>(aElement: HTMLElement, aName: K, aCallback: function): void
Defined in dnd.target.ts:235
Registers an event callback with the element
Type parameters:
K : keyof HTMLElementEventMap
Parameters:
| Name | Type |
|---|---|
| aElement | HTMLElement |
| aName | K |
| aCallback | function |
Returns: void
_addInputField
▸ _addInputField(aForm: HTMLFormElement, aKey: string, aValue: string): void
Defined in dnd.target.ts:432
Adds a new input field
Parameters:
| Name | Type |
|---|---|
| aForm | HTMLFormElement |
| aKey | string |
| aValue | string |
Returns: void
_andEffectsAllowed
▸ _andEffectsAllowed(aLeft: string, aRight: string): string
Defined in dnd.target.ts:206
Peforms an AND operation on the action sets
Parameters:
| Name | Type |
|---|---|
| aLeft | string |
| aRight | string |
Returns: string
_andInteger
▸ _andInteger(aLeft: number, aRight: number): number
Defined in dnd.target.ts:199
Peforms an AND operation on integers
Parameters:
| Name | Type |
|---|---|
| aLeft | number |
| aRight | number |
Returns: number
_clearLocalStorage
▸ _clearLocalStorage(aLocalStorageKey: string, aLocalStorage: Storage): void
Defined in dnd.target.ts:1144
Performs payload cleanup for the HTML local storage
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
Returns: void
_contains
▸ _contains<T>(aValue: T, aArray: T[]): boolean
Defined in dnd.target.ts:493
Check if the value is contained in the array
Type parameters:
T
Parameters:
| Name | Type |
|---|---|
| aValue | T |
| aArray |
T[] |
Returns: boolean
_copyPayloadTypes
▸ _copyPayloadTypes(aArray: ReadonlyArray<string>): string[]
Defined in dnd.target.ts:500
Copies the source array
Parameters:
| Name | Type |
|---|---|
| aArray |
ReadonlyArray<string> |
Returns: string[]
_createAddressable
▸ _createAddressable(aUri: string, aParams: Parameters): Addressable
Defined in dnd.target.ts:347
Constructs an addressable object
Parameters:
| Name | Type |
|---|---|
| aUri | string |
| aParams | Parameters |
Returns: Addressable
_decodeEffectsAllowed
▸ _decodeEffectsAllowed(aValue?: string): string
Defined in dnd.target.ts:946
Decodes the value to a valid action name
Parameters:
| Name | Type |
|---|---|
Optional aValue |
string |
Returns: string
_decodeFiles
▸ _decodeFiles(aFiles: FileList): Addressable[]
Defined in dnd.target.ts:386
Constructs a JSON payload based on the data transfer files
Parameters:
| Name | Type |
|---|---|
| aFiles | FileList |
Returns: Addressable[]
_decodePayload
▸ _decodePayload(aPayloadString: string): Addressable[]
Defined in dnd.target.ts:357
Constructs a JSON payload based on the data transfer string
Parameters:
| Name | Type |
|---|---|
| aPayloadString | string |
Returns: Addressable[]
_getCombinedDropEffect
▸ _getCombinedDropEffect(aValidationStore: any, aAddressables: Addressable[], aEvent: DragEvent): string
Defined in dnd.target.ts:888
Returns the drop effect for the data transfer object
Parameters:
| Name | Type |
|---|---|
| aValidationStore | any |
| aAddressables | Addressable[] |
| aEvent | DragEvent |
Returns: string
_getCombinedEffectsAllowed
▸ _getCombinedEffectsAllowed(aValidationStore: any, aAddressables: Addressable[], aEvent: DragEvent): string
Defined in dnd.target.ts:839
Returns the allowed drop effects as a combination between the effects allowed by the drag source and the allowed effects by the drop target.
Parameters:
| Name | Type |
|---|---|
| aValidationStore | any |
| aAddressables | Addressable[] |
| aEvent | DragEvent |
Returns: string
_getDataTransfer
▸ _getDataTransfer(aEvent: DragEvent): DataTransfer
Defined in dnd.target.ts:447
Returns the data transfer object from the event
Parameters:
| Name | Type |
|---|---|
| aEvent | DragEvent |
Returns: DataTransfer
_getDropEffect
▸ _getDropEffect(aEvent: DragEvent): string
Defined in dnd.target.ts:864
Safely decodes the drop effect from the event.
Parameters:
| Name | Type |
|---|---|
| aEvent | DragEvent |
Returns: string
_getDropEffectFromEffectsAllowed
▸ _getDropEffectFromEffectsAllowed(aEffectsAllowed: string, aEvent: DragEvent): string
Defined in dnd.target.ts:756
Compute the desired effect given the allowed effects. The allowed effects are already the intersection between the allowed effects that the drag source has defined and the allowed effects that the validation target has defined.
This code also takes modifier keys into account.
drag + CTRL = copy drag + SHIFT + CTRL = link
Parameters:
| Name | Type |
|---|---|
| aEffectsAllowed | string |
| aEvent | DragEvent |
Returns: string
_getDropEffectFromEffectsAllowedWithFallback
▸ _getDropEffectFromEffectsAllowedWithFallback(aEffectsAllowedIndex: number, ...other: number[]): number
Defined in dnd.target.ts:724
Tests a fallback sequence to compute the allowed effects
Parameters:
| Name | Type |
|---|---|
| aEffectsAllowedIndex | number |
Rest other |
number[] |
Returns: number
_getDropTarget
▸ _getDropTarget(aValidator: any): DropTarget
Defined in dnd.target.ts:1183
Constructs a drop target object that performs validation
Parameters:
| Name | Type |
|---|---|
| aValidator | any |
Returns: DropTarget
_getEffectAllowed
▸ _getEffectAllowed(aLocalStorageKey: string, aLocalStorage: Storage, aEvent: DragEvent): string
Defined in dnd.target.ts:624
Returns the effect allowed property for the DND event as a string
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
| aEvent | DragEvent |
Returns: string
_getEffectsAllowed
▸ _getEffectsAllowed(aValidationStore: any, aAddressables: Addressable[]): string
Defined in dnd.target.ts:800
Decodes the allowed effects based on a cached store result and a list of addressable objects
Parameters:
| Name | Type |
|---|---|
| aValidationStore | any |
| aAddressables | Addressable[] |
Returns: string
_getEffectsAllowedIndex
▸ _getEffectsAllowedIndex(aEffectsAllowed: string): number
Defined in dnd.target.ts:191
Maps the effects allowed string to an index
Parameters:
| Name | Type |
|---|---|
| aEffectsAllowed | string |
Returns: number
_getElement
▸ _getElement(aElementRef: HTMLElement | string, aDocument: Document): HTMLElement
Defined in dnd.target.ts:331
Locates an element
Parameters:
| Name | Type |
|---|---|
| aElementRef |
HTMLElement | string
|
| aDocument | Document |
Returns: HTMLElement
_getElementById
▸ _getElementById(aId: string, aDocument: Document): HTMLElement
Defined in dnd.target.ts:228
Returns an element by ID
Parameters:
| Name | Type |
|---|---|
| aId | string |
| aDocument | Document |
Returns: HTMLElement
_getFromLocalStorage
▸ _getFromLocalStorage(aLocalStorageKey: string, aLocalStorage: Storage): string
Defined in dnd.target.ts:454
Receives the DND payload from the local storage
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
Returns: string
_getPayload
▸ _getPayload(aLocalStorageKey: string, aLocalStorage: Storage, aEvent: DragEvent): Addressable[]
Defined in dnd.target.ts:570
Returns the event payload for the DND event as an object
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
| aEvent | DragEvent |
Returns: Addressable[]
_getPayloadTypes
▸ _getPayloadTypes(aLocalStorageKey: string, aLocalStorage: Storage, aEvent: DragEvent): string[]
Defined in dnd.target.ts:540
Decodes the available payload types. If not available on the event, we check for the availability of the data in localstorage.
Parameters:
| Name | Type |
|---|---|
| aLocalStorageKey | string |
| aLocalStorage | Storage |
| aEvent | DragEvent |
Returns: string[]
_getRESTValidator
▸ _getRESTValidator(aGenerator: UrlGenerator | HTMLAnchorElement | string, aDocument: Document): _onValidate
Defined in dnd.target.ts:1058
Returns a RESTful validator
Parameters:
| Name | Type |
|---|---|
| aGenerator |
UrlGenerator | HTMLAnchorElement | string
|
| aDocument | Document |
Returns: _onValidate
_getType
▸ _getType(aObject: any): string
Defined in dnd.target.ts:263
Returns a type string for the object
Parameters:
| Name | Type |
|---|---|
| aObject | any |
Returns: string
_getUrlGenerator
▸ _getUrlGenerator(aGenerator: UrlGenerator | HTMLAnchorElement | string, aDocument: Document): UrlGenerator
Defined in dnd.target.ts:1023
Produces a URL generator for the input
Parameters:
| Name | Type |
|---|---|
| aGenerator |
UrlGenerator | HTMLAnchorElement | string
|
| aDocument | Document |
Returns: UrlGenerator
_getUrlGeneratorFromElement
▸ _getUrlGeneratorFromElement(aAnchor: HTMLAnchorElement): UrlGenerator
Defined in dnd.target.ts:1016
Decodes the URL generator from an anchor element
Parameters:
| Name | Type |
|---|---|
| aAnchor | HTMLAnchorElement |
Returns: UrlGenerator
_getUrlGeneratorFromUrl
▸ _getUrlGeneratorFromUrl(aBaseURL: string): UrlGenerator
Defined in dnd.target.ts:1003
Constructs a generator callback from a URL string
Parameters:
| Name | Type |
|---|---|
| aBaseURL | string |
Returns: UrlGenerator
_hasTransferTypeFiles
▸ _hasTransferTypeFiles(aTypes: string[]): boolean
Defined in dnd.target.ts:530
Check if we have a data transfer type of files
Parameters:
| Name | Type |
|---|---|
| aTypes |
string[] |
Returns: boolean
_hasTransferTypeString
▸ _hasTransferTypeString(aTypes: string[]): boolean
Defined in dnd.target.ts:519
Check if we have a data transfer type of plain text
Parameters:
| Name | Type |
|---|---|
| aTypes |
string[] |
Returns: boolean
_isAnchor
▸ _isAnchor(aType: string): boolean
Defined in dnd.target.ts:300
Checks if the type is an anchor
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isArray
▸ _isArray(aType: string): boolean
Defined in dnd.target.ts:280
Checks if the type is an array type
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isFunction
▸ _isFunction(aType: string): boolean
Defined in dnd.target.ts:290
Checks if the type is a function type
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isJson
▸ _isJson(aString: string): boolean
Defined in dnd.target.ts:474
Basic test to see if a value is in JSON format
Parameters:
| Name | Type |
|---|---|
| aString | string |
Returns: boolean
_isString
▸ _isString(aType: string): boolean
Defined in dnd.target.ts:270
Checks if the type is a string type
Parameters:
| Name | Type |
|---|---|
| aType | string |
Returns: boolean
_isURL
▸ _isURL(aString: string): boolean
Defined in dnd.target.ts:467
Basic test to verify if a string is a URL
Parameters:
| Name | Type |
|---|---|
| aString | string |
Returns: boolean
_isUninitializedEffectsAllowed
▸ _isUninitializedEffectsAllowed(aEffectsAllowed?: string): boolean
Defined in dnd.target.ts:310
Check if the effects allowed are uninitialized
Parameters:
| Name | Type |
|---|---|
Optional aEffectsAllowed |
string |
Returns: boolean
_isValidPayload
▸ _isValidPayload(aPayloadString: string): boolean
Defined in dnd.target.ts:482
Checks if the payload string is valid
Parameters:
| Name | Type |
|---|---|
| aPayloadString | string |
Returns: boolean
_jsonToObject
▸ _jsonToObject(aJson: string): any
Defined in dnd.target.ts:320
Converts the JSON string to a JSON object
Parameters:
| Name | Type |
|---|---|
| aJson | string |
Returns: any
_noop
▸ _noop(): void
Defined in dnd.target.ts:221
Helper that just does nothing
Returns: void
_onAddPayload
▸ _onAddPayload(aFormRef: HTMLFormElement | string, aEvent: DragEvent): void
Defined in dnd.target.ts:1154
Adds the current DND payload to a form
Parameters:
| Name | Type |
|---|---|
| aFormRef |
HTMLFormElement | string
|
| aEvent | DragEvent |
Returns: void
_onGetEffectAllowed
▸ _onGetEffectAllowed(aEvent: DragEvent): string
Defined in dnd.target.ts:1133
Returns the event effect allowed property for the DND event as an object
Parameters:
| Name | Type |
|---|---|
| aEvent | DragEvent |
Returns: string
_onGetPayload
▸ _onGetPayload(aEvent: DragEvent): Addressable[]
Defined in dnd.target.ts:1122
Returns the event payload for the DND event as an object
Parameters:
| Name | Type |
|---|---|
| aEvent | DragEvent |
Returns: Addressable[]
_onGetRESTValidator
▸ _onGetRESTValidator(aGenerator: UrlGenerator | HTMLAnchorElement | string): _onValidate
Defined in dnd.target.ts:1113
Returns a RESTful validator
Parameters:
| Name | Type |
|---|---|
| aGenerator |
UrlGenerator | HTMLAnchorElement | string
|
Returns: _onValidate
_prepareValidationURL
▸ _prepareValidationURL(aBaseURL: string): string
Defined in dnd.target.ts:992
Prepares the validation URL by stripping a potential hash and adding a terminator token
Parameters:
| Name | Type |
|---|---|
| aBaseURL | string |
Returns: string
_preventDefault
▸ _preventDefault(aEvent: Event): void
Defined in dnd.target.ts:938
Prevents the default behaviour on the event
Parameters:
| Name | Type |
|---|---|
| aEvent | Event |
Returns: void
_put
▸ _put<T>(aKey: string, aValue: T, aObject: any): T
Defined in dnd.target.ts:248
Adds the key/value pair to the object and returns the added
Type parameters:
T
Parameters:
| Name | Type |
|---|---|
| aKey | string |
| aValue | T |
| aObject | any |
Returns: T
_sendValidationRequest
▸ _sendValidationRequest(aValidationURL: string, aAddressable: Addressable, aCallback: ValidationCallback): void
Defined in dnd.target.ts:961
Sends a validation request and persists the result in the store
Parameters:
| Name | Type |
|---|---|
| aValidationURL | string |
| aAddressable | Addressable |
| aCallback | ValidationCallback |
Returns: void
_setAttribute
▸ _setAttribute(aElement: HTMLElement, aName: string, aValue: string): void
Defined in dnd.target.ts:425
Adds a new attribute to the element
Parameters:
| Name | Type |
|---|---|
| aElement | HTMLElement |
| aName | string |
| aValue | string |
Returns: void
_setDropEffect
▸ _setDropEffect(aValidationStore: any, aAddressables: Addressable[], aEvent: DragEvent): void
Defined in dnd.target.ts:906
Initializes the drop effect
Parameters:
| Name | Type |
|---|---|
| aValidationStore | any |
| aAddressables | Addressable[] |
| aEvent | DragEvent |
Returns: void
_setEffectAllowed
▸ _setEffectAllowed(effect: string): void
Defined in dnd.target.ts:928
Initializes the drop effect
Parameters:
| Name | Type |
|---|---|
| effect | string |
Returns: void
_testEffectAllowed
▸ _testEffectAllowed(aEffectsAllowedIndex: number, aEffectIndex: number): number
Defined in dnd.target.ts:714
Tests if a particular effect is allowed
Parameters:
| Name | Type |
|---|---|
| aEffectsAllowedIndex | number |
| aEffectIndex | number |
Returns: number
_toString
▸ _toString(aObject: any): string
Defined in dnd.target.ts:256
Converts the object to a string
Parameters:
| Name | Type |
|---|---|
| aObject | any |
Returns: string
@ibm-wch-sdk/layout-editor > "editor"
External module: "editor"
Index
Interfaces
Type aliases
Functions
Type aliases
LayoutChangedCallback
Ƭ LayoutChangedCallback: function
Defined in editor.ts:19
Type declaration
▸(): any
Returns: any
Functions
inlineEditInit
▸ inlineEditInit(aRoot: Element, layoutChangedCallback?: LayoutChangedCallback, newItemSchemes?: String[]): InlineEditModule
Defined in editor.ts:21
Parameters:
| Name | Type |
|---|---|
| aRoot | Element |
Optional layoutChangedCallback |
LayoutChangedCallback |
Optional newItemSchemes |
String[] |
Returns: InlineEditModule
@ibm-wch-sdk/layout-editor > "flexbox.grid"
External module: "flexbox.grid"
Index
Interfaces
Type aliases
Functions
Type aliases
LayoutListener
Ƭ LayoutListener: function
Defined in flexbox.grid.ts:19
Type declaration
▸(aSection: Section, aBreakpoints: Breakpoint[]): any
Parameters:
| Name | Type |
|---|---|
| aSection | Section |
| aBreakpoints | Breakpoint[] |
Returns: any
Functions
gridInit
▸ gridInit(aRoot: Element): object
Defined in flexbox.grid.ts:24
Parameters:
| Name | Type |
|---|---|
| aRoot | Element |
Returns: object
@ibm-wch-sdk/layout-editor > "ibmc"
External module: "ibmc"
Index
Variables
Functions
- addClass
- bindDomEvt
- byId
- createDom
- forEach
- forIn
- hasClass
- isArray
- isDescendant
- isNode
- isString
- partial
- removeClass
- scope
- toArray
- toggleClass
- unbindDomEvt
Variables
add
● add: (Anonymous function) = testNode.addEventListener
? function(node, name, f) {
node.addEventListener(name, f, false);
}
: function(node, name, f) {
node.attachEvent(name, f);
}
Defined in ibmc.ts:247
fixEvtName
● fixEvtName: (Anonymous function) = testNode.addEventListener
? function(n) {
return n.indexOf('on') == 0 ? n.substr(2) : n; // remove on if it's there - W3C
}
: function(n) {
return n.indexOf('on') != 0 ? 'on' + n : n; // add on if it's not there - legacy IE
}
Defined in ibmc.ts:240
remove
● remove: (Anonymous function) = testNode.removeEventListener
? function(node, name, f) {
node.removeEventListener(name, f, false);
}
: function(node, name, f) {
node.detachEvent(name, f);
}
Defined in ibmc.ts:254
<Const> testNode
● testNode: HTMLDivElement = document.createElement('div')
Defined in ibmc.ts:1
Functions
addClass
▸ addClass(node: Element, className: string): void
Defined in ibmc.ts:334
Adds the specified class to the given DOM node.
Parameters:
| Name | Type |
|---|---|
| node | Element |
| className | string |
Returns: void
bindDomEvt
▸ bindDomEvt(node: Window | Node, name: string, f: Function): [Node | Window, string, Function]
Defined in ibmc.ts:288
Binds a function to a DOM event such as 'onmouseleave'.
Parameters:
| Name | Type |
|---|---|
| node |
Window | Node
|
| name | string |
| f | Function |
Returns: [Node | Window, string, Function]
byId
▸ byId(id: string | Node): Node
Defined in ibmc.ts:197
This is a simple alias to document.getElementById, which is shorter to write.
Parameters:
| Name | Type |
|---|---|
| id |
string | Node
|
Returns: Node
createDom
▸ createDom<K>(name: K, attrs: Record<string, string>, parent?: Node): HTMLElementTagNameMap[K]
Defined in ibmc.ts:225
This method create a new DOM node with given attributes and adds it into the DOM at the same time if required
If this is not defined the DOM node will not be inserted into the DOM and must be added manually afterwards.
example: Example 1: Creates a new div element which is not part of any DOM (yet). var divElement = createDom("div");
example: Example 2: Inserts a new input element into a 'form' with the attributes, type, name, value createDom("input", { "type": "hidden", "name": "x-method-override", "value": method.toUpperCase() }, form);
Type parameters:
K : keyof HTMLElementTagNameMap
Parameters:
| Name | Type |
|---|---|
| name | K |
| attrs |
Record<string, string> |
Optional parent |
Node |
Returns: HTMLElementTagNameMap[K]
forEach
▸ forEach<T,A>(arr: A, f: function, start?: number): void
Defined in ibmc.ts:145
Enumerates over all items in an array or an object that is like an array as defined by {@link i$.isLikeArray}, calling function func for each enumerated value.
call for each property or index. Must not be null.
Type parameters:
T
A : ArrayLike<T>
Parameters:
| Name | Type |
|---|---|
| arr | A |
| f | function |
Optional start |
number |
Returns: void
forIn
▸ forIn<T,O>(o: O, f: function): void
Defined in ibmc.ts:165
Enumerates over all properties of obj, calling function func for each enumerated value.
call for each property or index.
Type parameters:
T
O
Parameters:
| Name | Type |
|---|---|
| o | O |
| f | function |
Returns: void
hasClass
▸ hasClass(node: Element, className: string): boolean
Defined in ibmc.ts:364
Determine whether the given DOM node is assigned the given class.
Parameters:
| Name | Type |
|---|---|
| node | Element |
| className | string |
Returns: boolean
isArray
▸ isArray(o: any): boolean
Defined in ibmc.ts:22
Determines if an object is an array or not.
Parameters:
| Name | Type |
|---|---|
| o | any |
Returns: boolean
isDescendant
▸ isDescendant(node: Node, anc: Node): boolean
Defined in ibmc.ts:269
Determines whether the specified node is a descendant of the ancestor.
Parameters:
| Name | Type |
|---|---|
| node | Node |
| anc | Node |
Returns: boolean
isNode
▸ isNode(o: any): boolean
Defined in ibmc.ts:183
Determines if an object is a DOM node or not.
Parameters:
| Name | Type |
|---|---|
| o | any |
Returns: boolean
isString
▸ isString(o: any): boolean
Defined in ibmc.ts:37
Determines if an object is a string or not.
Parameters:
| Name | Type |
|---|---|
| o | any |
Returns: boolean
partial
▸ partial(f: Function): Function
Defined in ibmc.ts:76
Generates a partial function based on an existing function. The first argument denotes the function to create a new partial for. All subsequent arguments after that are used to prefill the original function's parameters with fixed values whenever the partial is called. Any undefined values in the arguments list will be used as a placeholder to shift in the actual calling arguments. Any calling arguments that are left over after shifting into placeholder locations will be concatenated to the end of the resulting arguments that are passed to the original function as if they were default placeholders.
actual arguments.
example: Example 1 var f = i$.partial(function(a, b, c){ alert(a + " - " + b + " - " + c); }, 1, 5); // fixes the first 2 parameters a and b f(10); // alerts "1 - 5 - 10"
example: Example 2 var f = i$.partial(function(a, b, c){ alert(a + " - " + b + " - " + c); }, 1, undefined, 5); // fixes parameter a and c, and marks b as a placeholder f(3); // alerts "1 - 3 - 5"
example: Example 3 var f = i$.partial(function(a, b, c){ alert(a + " - " + b + " - " + c); }, undefined, 10); // fixes parameter b f(1, 100); // alerts "1 - 10 - 100"
Parameters:
| Name | Type |
|---|---|
| f | Function |
Returns: Function
removeClass
▸ removeClass(node: Element, className: string): void
Defined in ibmc.ts:348
Remove a single class from the given DOM node.
Parameters:
| Name | Type |
|---|---|
| node | Element |
| className | string |
Returns: void
scope
▸ scope(s: any, f: Function | string): Function
Defined in ibmc.ts:123
Generates a partial function based on an existing function but fixes the scope in which the partial function is called regardless of the eventual calling scope.
see: i$.partial
function always calls func in context of this scope object. Must not be null.
A new function like {@link i$.partial} but fixes the function's scope permanently. Calling this without additional arguments besides obj and func simply creates a new function of the same arity whose scope is fixed to obj.
example: Example 1: var obj = {a: 1}; var f = i$.scope(obj, function(b, c){ alert(this.a + " - " + b + " - " + c); }); f(3, 5); // alerts "1 - 3 - 5"
example: Example 2: var obj = {a: 1}; var f = i$.scope(obj, function(b, c){ alert(this.a + " - " + b + " - " + c); }, undefined, 5); f(3); // alerts "1 - 3 - 5"
Parameters:
| Name | Type |
|---|---|
| s | any |
| f |
Function | string
|
Returns: Function
toArray
▸ toArray<T>(o: ArrayLike<T>): T[]
Defined in ibmc.ts:11
Returns a true array from obj, creating a copy if obj is already an array. Useful for coercing array-like structures into true arrays safely.
Type parameters:
T
Parameters:
| Name | Type |
|---|---|
| o |
ArrayLike<T> |
Returns: T[]
toggleClass
▸ toggleClass(node: Element, className: string): void
Defined in ibmc.ts:378
Add or remove one class from the given DOM node.
Parameters:
| Name | Type |
|---|---|
| node | Element |
| className | string |
Returns: void
unbindDomEvt
▸ unbindDomEvt(binding: [Node | Window, string, Function]): void
Defined in ibmc.ts:317
Unbinds a previously bound event.
Parameters:
| Name | Type |
|---|---|
| binding | [Node | Window, string, Function] |
Returns: void
@ibm-wch-sdk/layout-editor > "index"
External module: "index"
Index
@ibm-wch-sdk/layout-editor
Index
External modules
@ibm-wch-sdk/layout-editor > "dnd.namespace" > Addressable
Interface: Addressable
Hierarchy
Addressable
Index
Properties
Properties
params
● params: Parameters
Defined in dnd.namespace.ts:8
uri
● uri: string
Defined in dnd.namespace.ts:7
@ibm-wch-sdk/layout-editor > "editor" > InlineEditModule
Interface: InlineEditModule
Hierarchy
InlineEditModule
Index
Properties
Properties
dispose
● dispose: function
Defined in editor.ts:16
Type declaration
▸(): void
Returns: void
@ibm-wch-sdk/layout-editor > "flexbox.grid" > Breakpoint
Interface: Breakpoint
Hierarchy
Breakpoint
Index
Properties
Properties
id
● id: string
Defined in flexbox.grid.ts:11
width
● width: number
Defined in flexbox.grid.ts:12
@ibm-wch-sdk/layout-editor > "flexbox.grid" > Section
Interface: Section
Hierarchy
HTMLElement
↳ Section
Index
Properties
- ATTRIBUTE_NODE
- CDATA_SECTION_NODE
- COMMENT_NODE
- DOCUMENT_FRAGMENT_NODE
- DOCUMENT_NODE
- DOCUMENT_POSITION_CONTAINED_BY
- DOCUMENT_POSITION_CONTAINS
- DOCUMENT_POSITION_DISCONNECTED
- DOCUMENT_POSITION_FOLLOWING
- DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
- DOCUMENT_POSITION_PRECEDING
- DOCUMENT_TYPE_NODE
- ELEMENT_NODE
- ENTITY_NODE
- ENTITY_REFERENCE_NODE
- HTMLElement
- NOTATION_NODE
- PROCESSING_INSTRUCTION_NODE
- TEXT_NODE
- accessKey
- accessKeyLabel
- assignedSlot
- attributes
- autocapitalize
- baseURI
- breakpoints
- childElementCount
- childNodes
- children
- classList
- className
- clientHeight
- clientLeft
- clientTop
- clientWidth
- contentEditable
- dataset
- dir
- draggable
- firstChild
- firstElementChild
- hidden
- id
- innerHTML
- innerText
- inputMode
- isConnected
- isContentEditable
- lang
- lastChild
- lastElementChild
- localName
- namespaceURI
- nextElementSibling
- nextSibling
- nodeName
- nodeType
- nodeValue
- nonce
- offsetHeight
- offsetLeft
- offsetParent
- offsetTop
- offsetWidth
- onabort
- onanimationcancel
- onanimationend
- onanimationiteration
- onanimationstart
- onauxclick
- onblur
- oncancel
- oncanplay
- oncanplaythrough
- onchange
- onclick
- onclose
- oncontextmenu
- oncopy
- oncuechange
- oncut
- ondblclick
- ondrag
- ondragend
- ondragenter
- ondragexit
- ondragleave
- ondragover
- ondragstart
- ondrop
- ondurationchange
- onemptied
- onended
- onerror
- onfocus
- onfullscreenchange
- onfullscreenerror
- ongotpointercapture
- oninput
- oninvalid
- onkeydown
- onkeypress
- onkeyup
- onload
- onloadeddata
- onloadedmetadata
- onloadend
- onloadstart
- onlostpointercapture
- onmousedown
- onmouseenter
- onmouseleave
- onmousemove
- onmouseout
- onmouseover
- onmouseup
- onpaste
- onpause
- onplay
- onplaying
- onpointercancel
- onpointerdown
- onpointerenter
- onpointerleave
- onpointermove
- onpointerout
- onpointerover
- onpointerup
- onprogress
- onratechange
- onreset
- onresize
- onscroll
- onsecuritypolicyviolation
- onseeked
- onseeking
- onselect
- onstalled
- onsubmit
- onsuspend
- ontimeupdate
- ontoggle
- ontouchcancel
- ontouchend
- ontouchmove
- ontouchstart
- ontransitioncancel
- ontransitionend
- ontransitionrun
- ontransitionstart
- onvolumechange
- onwaiting
- onwheel
- outerHTML
- ownerDocument
- parentElement
- parentNode
- prefix
- previousElementSibling
- previousSibling
- scrollHeight
- scrollLeft
- scrollTop
- scrollWidth
- shadowRoot
- slot
- spellcheck
- style
- tabIndex
- tagName
- textContent
- title
- translate
Methods
- addEventListener
- after
- animate
- append
- appendChild
- attachShadow
- before
- blur
- click
- cloneNode
- closest
- compareDocumentPosition
- contains
- dispatchEvent
- focus
- getAnimations
- getAttribute
- getAttributeNS
- getAttributeNames
- getAttributeNode
- getAttributeNodeNS
- getBoundingClientRect
- getClientRects
- getElementsByClassName
- getElementsByTagName
- getElementsByTagNameNS
- getRootNode
- hasAttribute
- hasAttributeNS
- hasAttributes
- hasChildNodes
- hasPointerCapture
- insertAdjacentElement
- insertAdjacentHTML
- insertAdjacentText
- insertBefore
- isDefaultNamespace
- isEqualNode
- isSameNode
- lookupNamespaceURI
- lookupPrefix
- matches
- msGetRegionContent
- normalize
- prepend
- querySelector
- querySelectorAll
- releasePointerCapture
- remove
- removeAttribute
- removeAttributeNS
- removeAttributeNode
- removeChild
- removeEventListener
- replaceChild
- replaceWith
- requestFullscreen
- scroll
- scrollBy
- scrollIntoView
- scrollTo
- setAttribute
- setAttributeNS
- setAttributeNode
- setAttributeNodeNS
- setPointerCapture
- toggleAttribute
- webkitMatchesSelector
Properties
ATTRIBUTE_NODE
● ATTRIBUTE_NODE: number
Inherited from Node.ATTRIBUTE_NODE
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10363
COMMENT_NODE
● COMMENT_NODE: number
Inherited from Node.COMMENT_NODE
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10365
DOCUMENT_NODE
● DOCUMENT_NODE: number
Inherited from Node.DOCUMENT_NODE
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10373
ELEMENT_NODE
● ELEMENT_NODE: number
Inherited from Node.ELEMENT_NODE
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10374
ENTITY_NODE
● ENTITY_NODE: number
Inherited from Node.ENTITY_NODE
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10376
HTMLElement
● HTMLElement: object
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6089
Type declaration
constructor : function
⊕ new __type(): HTMLElement
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6090
Returns: HTMLElement
prototype: HTMLElement
NOTATION_NODE
● NOTATION_NODE: number
Inherited from Node.NOTATION_NODE
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10378
TEXT_NODE
● TEXT_NODE: number
Inherited from Node.TEXT_NODE
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10379
accessKey
● accessKey: string
Inherited from HTMLElement.accessKey
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6066
accessKeyLabel
● accessKeyLabel: string
Inherited from HTMLElement.accessKeyLabel
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4659
attributes
● attributes: NamedNodeMap
Inherited from Element.attributes
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4660
autocapitalize
● autocapitalize: string
Inherited from HTMLElement.autocapitalize
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6068
baseURI
● baseURI: string
Inherited from Node.baseURI
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10264
Returns node's node document's document base URL.
<Optional> breakpoints
● breakpoints: Breakpoint[]
Defined in flexbox.grid.ts:16
childElementCount
● childElementCount: number
Inherited from ParentNode.childElementCount
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10709
childNodes
● childNodes: NodeListOf<ChildNode>
Inherited from Node.childNodes
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10268
Returns the children.
children
● children: HTMLCollection
Inherited from ParentNode.children
Defined in /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4671
clientLeft
● clientLeft: number
Inherited from Element.clientLeft
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4672
clientTop
● clientTop: number
Inherited from Element.clientTop
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4673
clientWidth
● clientWidth: number
Inherited from Element.clientWidth
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4674
contentEditable
● contentEditable: string
Inherited from ElementContentEditable.contentEditable
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4824
dataset
● dataset: DOMStringMap
Inherited from HTMLOrSVGElement.dataset
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7555
dir
● dir: string
Inherited from HTMLElement.dir
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6069
draggable
● draggable: boolean
Inherited from HTMLElement.draggable
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6070
firstChild
● firstChild: ChildNode | null
Inherited from Node.firstChild
Defined in /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6071
id
● id: string
Inherited from Element.id
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4680
innerText
● innerText: string
Inherited from HTMLElement.innerText
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6072
inputMode
● inputMode: string
Inherited from ElementContentEditable.inputMode
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4825
isConnected
● isConnected: boolean
Inherited from Node.isConnected
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4826
lang
● lang: string
Inherited from HTMLElement.lang
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6073
lastChild
● lastChild: ChildNode | null
Inherited from Node.lastChild
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10309
nodeValue
● nodeValue: string | null
Inherited from Node.nodeValue
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10310
nonce
● nonce: string
Inherited from HTMLOrSVGElement.nonce
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7556
offsetHeight
● offsetHeight: number
Inherited from HTMLElement.offsetHeight
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6074
offsetLeft
● offsetLeft: number
Inherited from HTMLElement.offsetLeft
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6075
offsetParent
● offsetParent: Element | null
Inherited from HTMLElement.offsetParent
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6076
offsetTop
● offsetTop: number
Inherited from HTMLElement.offsetTop
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6077
offsetWidth
● offsetWidth: number
Inherited from HTMLElement.offsetWidth
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6078
onabort
● onabort: function | null
Inherited from GlobalEventHandlers.onabort
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5270
onanimationend
● onanimationend: function | null
Inherited from GlobalEventHandlers.onanimationend
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5271
onanimationiteration
● onanimationiteration: function | null
Inherited from GlobalEventHandlers.onanimationiteration
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5272
onanimationstart
● onanimationstart: function | null
Inherited from GlobalEventHandlers.onanimationstart
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5273
onauxclick
● onauxclick: function | null
Inherited from GlobalEventHandlers.onauxclick
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5274
onblur
● onblur: function | null
Inherited from GlobalEventHandlers.onblur
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5280
oncanplay
● oncanplay: function | null
Inherited from GlobalEventHandlers.oncanplay
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5286
onchange
● onchange: function | null
Inherited from GlobalEventHandlers.onchange
Defined in /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5297
oncontextmenu
● oncontextmenu: function | null
Inherited from GlobalEventHandlers.oncontextmenu
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4468
oncuechange
● oncuechange: function | null
Inherited from GlobalEventHandlers.oncuechange
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5303
oncut
● oncut: function | null
Inherited from DocumentAndElementEventHandlers.oncut
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4469
ondblclick
● ondblclick: function | null
Inherited from GlobalEventHandlers.ondblclick
Defined in /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5324
ondragleave
● ondragleave: function | null
Inherited from GlobalEventHandlers.ondragleave
Defined in /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5340
ondurationchange
● ondurationchange: function | null
Inherited from GlobalEventHandlers.ondurationchange
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4689
onfullscreenerror
● onfullscreenerror: function | null
Inherited from Element.onfullscreenerror
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4690
ongotpointercapture
● ongotpointercapture: function | null
Inherited from GlobalEventHandlers.ongotpointercapture
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5366
oninput
● oninput: function | null
Inherited from GlobalEventHandlers.oninput
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5367
oninvalid
● oninvalid: function | null
Inherited from GlobalEventHandlers.oninvalid
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5368
onkeydown
● onkeydown: function | null
Inherited from GlobalEventHandlers.onkeydown
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5399
onloadstart
● onloadstart: function | null
Inherited from GlobalEventHandlers.onloadstart
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5405
onmousedown
● onmousedown: function | null
Inherited from GlobalEventHandlers.onmousedown
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5411
onmouseleave
● onmouseleave: function | null
Inherited from GlobalEventHandlers.onmouseleave
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5412
onmousemove
● onmousemove: function | null
Inherited from GlobalEventHandlers.onmousemove
Defined in /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4470
onpause
● onpause: function | null
Inherited from GlobalEventHandlers.onpause
Defined in /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5448
onpointerdown
● onpointerdown: function | null
Inherited from GlobalEventHandlers.onpointerdown
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5449
onpointerenter
● onpointerenter: function | null
Inherited from GlobalEventHandlers.onpointerenter
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5450
onpointerleave
● onpointerleave: function | null
Inherited from GlobalEventHandlers.onpointerleave
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5451
onpointermove
● onpointermove: function | null
Inherited from GlobalEventHandlers.onpointermove
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5452
onpointerout
● onpointerout: function | null
Inherited from GlobalEventHandlers.onpointerout
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5453
onpointerover
● onpointerover: function | null
Inherited from GlobalEventHandlers.onpointerover
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5454
onpointerup
● onpointerup: function | null
Inherited from GlobalEventHandlers.onpointerup
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5455
onprogress
● onprogress: function | null
Inherited from GlobalEventHandlers.onprogress
Defined in /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5471
onscroll
● onscroll: function | null
Inherited from GlobalEventHandlers.onscroll
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5477
onseeked
● onseeked: function | null
Inherited from GlobalEventHandlers.onseeked
Defined in /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5498
onsuspend
● onsuspend: function | null
Inherited from GlobalEventHandlers.onsuspend
Defined in /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5509
ontouchcancel
● ontouchcancel: function | null
Inherited from GlobalEventHandlers.ontouchcancel
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5510
ontouchend
● ontouchend: function | null
Inherited from GlobalEventHandlers.ontouchend
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5511
ontouchmove
● ontouchmove: function | null
Inherited from GlobalEventHandlers.ontouchmove
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5512
ontouchstart
● ontouchstart: function | null
Inherited from GlobalEventHandlers.ontouchstart
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5513
ontransitioncancel
● ontransitioncancel: function | null
Inherited from GlobalEventHandlers.ontransitioncancel
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5514
ontransitionend
● ontransitionend: function | null
Inherited from GlobalEventHandlers.ontransitionend
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5515
ontransitionrun
● ontransitionrun: function | null
Inherited from GlobalEventHandlers.ontransitionrun
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5516
ontransitionstart
● ontransitionstart: function | null
Inherited from GlobalEventHandlers.ontransitionstart
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5517
onvolumechange
● onvolumechange: function | null
Inherited from GlobalEventHandlers.onvolumechange
Defined in /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5528
outerHTML
● outerHTML: string
Inherited from Element.outerHTML
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4691
ownerDocument
● ownerDocument: Document | null
Inherited from Node.ownerDocument
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4696
scrollLeft
● scrollLeft: number
Inherited from Element.scrollLeft
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4697
scrollTop
● scrollTop: number
Inherited from Element.scrollTop
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4698
scrollWidth
● scrollWidth: number
Inherited from Element.scrollWidth
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4699
shadowRoot
● shadowRoot: ShadowRoot | null
Inherited from Element.shadowRoot
Defined in /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6079
style
● style: CSSStyleDeclaration
Inherited from ElementCSSInlineStyle.style
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4820
tabIndex
● tabIndex: number
Inherited from HTMLOrSVGElement.tabIndex
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7557
tagName
● tagName: string
Inherited from Element.tagName
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10328
title
● title: string
Inherited from HTMLElement.title
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6080
translate
● translate: boolean
Inherited from HTMLElement.translate
Defined in /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:6081
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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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
before
▸ before(...nodes: (string | Node)[]): void
Inherited from ChildNode.before
Defined in /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:7558
Returns: void
click
▸ click(): void
Inherited from HTMLElement.click
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10334
Parameters:
| Name | Type |
|---|---|
| other | Node |
Returns: number
contains
▸ contains(other: Node | null): boolean
Inherited from Node.contains
Defined in /template/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
dispatchEvent
▸ dispatchEvent(event: Event): boolean
Inherited from EventTarget.dispatchEvent
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4768
Returns: any
normalize
▸ normalize(): void
Inherited from Node.normalize
Defined in /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/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 /template/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4807
Parameters:
| Name | Type |
|---|---|
| selectors | string |
Returns: boolean
@ibm-wch-sdk/layout-editor > "dnd.target" > DropTarget
Interface: DropTarget
Hierarchy
DropTarget
Index
Properties
Properties
addEventListeners
● addEventListeners: function
Defined in dnd.target.ts:16
Type declaration
▸(aElementRef: HTMLElement | string): any
Parameters:
| Name | Type |
|---|---|
| aElementRef |
HTMLElement | string
|
Returns: any
dragenter
● dragenter: function
Defined in dnd.target.ts:12
Type declaration
▸(aEvt: DragEvent): any
Parameters:
| Name | Type |
|---|---|
| aEvt | DragEvent |
Returns: any
dragleave
● dragleave: function
Defined in dnd.target.ts:14
Type declaration
▸(aEvt: DragEvent): any
Parameters:
| Name | Type |
|---|---|
| aEvt | DragEvent |
Returns: any
dragover
● dragover: function
Defined in dnd.target.ts:13
Type declaration
▸(aEvt: DragEvent): any
Parameters:
| Name | Type |
|---|---|
| aEvt | DragEvent |
Returns: any
drop
● drop: function
Defined in dnd.target.ts:15
Type declaration
▸(aEvt: DragEvent): any
Parameters:
| Name | Type |
|---|---|
| aEvt | DragEvent |
Returns: any