npm package: @ibm-wch-sdk/layout-editor
Description: Exposes framework independent APIs for @ibm-wch-sdk/ng and similar SDKs.
Author: Carsten Leue
Latest version: 7.2.608

<a name="_8288cff9ec4dbc1a1d241b9c9c346d34ec891d7baaf30d7ce96fe2e99849a4e4"></a>
# ibm-wch-sdk-api

Exposes framework independent APIs for [ibm-wch-sdk-ng](https://www.npmjs.com/package/ibm-wch-sdk-ng) and similar SDKs.

## Details

Refer to the [documentation](#_12582009ebaadb6a15359df758c6dc302ed295b663d882488b4017ba8fc7e5b6).

## Changes

[CHANGELOG](#_6a4613fd54e183a25f5f9edc57afe92b6413b6c1cc4f70246cc9aff18b3878d8)

## Class documentation

Refer to the [documentation](#_07fc3e3f0a90e5b4ec028dbdbbcb2ae68d690cf82df3975bd8efb74f0c36ba69).

## Usage

Install the module via

```bash
npm install --save ibm-wch-sdk-theme
```

<a name="_12582009ebaadb6a15359df758c6dc302ed295b663d882488b4017ba8fc7e5b6"></a>
# API

<a name="_6a4613fd54e183a25f5f9edc57afe92b6413b6c1cc4f70246cc9aff18b3878d8"></a>
# 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 `group` and `groups` on the `RenderingContext`
- Typing support for `group` elements
- Declaration of the event types and payloads for cross iframe events to switch between public and protected mode.

## 5.0.217

### Added

- Initial version

<a name="_07fc3e3f0a90e5b4ec028dbdbbcb2ae68d690cf82df3975bd8efb74f0c36ba69"></a>

#  @ibm-wch-sdk/layout-editor

## Index

### External modules

* ["dnd.namespace"](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)
* ["dnd.source"](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* ["dnd.target"](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* ["editor"](#_d1816695fcd0001605d6d6a0362d7f5be0f7d1d25e2bcb893c41bda238b27e6a)
* ["flexbox.grid"](#_efa6b5d44805f5d325c885815273622cc81aedc0476d957d7c0cdc3f9571cf65)
* ["ibmc"](#_f0f46c4f75c6d25b9a75c0884065815ad5da14d445b399f2aad2303c88689628)
* ["index"](#_5ccd4d73cc1cdd2aa8f4e5f7a4737bc7f3fd50d7d5c26b8484e764b8b655f040)

---


<a name="_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee"></a>
[@ibm-wch-sdk/layout-editor](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["dnd.namespace"](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)

# External module: "dnd.namespace"

## Index

### Interfaces

* [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

### Type aliases

* [Parameters](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)

### Variables

* [KEY_EFFECT_ALLOWED](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)
* [KEY_PAYLOAD](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)

---

## Type aliases

<a id="parameters"></a>

###  Parameters

**Ƭ Parameters**: *`Record`<`string`, `string`>*

*Defined in dnd.namespace.ts:4*

___

## Variables

<a id="key_effect_allowed"></a>

### `<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*

___
<a id="key_payload"></a>

### `<Const>` KEY_PAYLOAD

**● KEY_PAYLOAD**: *"com.ibm.portal.dnd.payload"* = "com.ibm.portal.dnd.payload"

*Defined in dnd.namespace.ts:1*

___


<a name="_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296"></a>
[@ibm-wch-sdk/layout-editor](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["dnd.source"](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)

# External module: "dnd.source"

## Index

### Type aliases

* [AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)

### Variables

* [_DATA_PARAM_PREFIX](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_DATA_PREFIX](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_JSON](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_TRANSFER_TYPE](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_document](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_keyEffectAllowed](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_keyPayload](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_localStorage](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_onDrag](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)

### Functions

* [_addAddressable](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_addAddressablesFromDefinitionList](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_addAddressablesFromElement](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_addAddressablesFromString](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_addEventListener](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_addEventListeners](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_clearLocalStorage](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_createAddressable](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_encodePayload](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_getDataFromNode](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_getDataTransfer](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_getDragSource](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_getElement](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_getElementById](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_getTextContent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_getType](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_isAnchor](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_isArray](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_isDefinitionList](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_isDiv](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_isNodeList](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_isObject](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_isString](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_noop](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_objectToAddressable](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_objectToJson](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_onDragEnd](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_onDragStart](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_onRemoveEffectAllowed](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_onRemovePayload](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_onSetEffectAllowed](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_onSetPayload](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_preventDefault](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_removeEffectAllowed](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_removePayload](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_setEffectAllowed](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_setPayload](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_setToLocalStorage](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_stringToAddressable](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_toString](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_toStringArray](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)
* [_trim](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)

---

## Type aliases

<a id="addressableinput"></a>

###  AddressableInput

**Ƭ AddressableInput**: *`string` \| [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76) \| `HTMLAnchorElement` \| `HTMLDListElement` \| `HTMLDivElement` \| `NodeList` \| `HTMLCollection` \| `Array`<`string` \| [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76) \| `HTMLAnchorElement` \| `HTMLDListElement` \| `HTMLDivElement` \| `HTMLCollection` \| `NodeList`>*

*Defined in dnd.source.ts:12*

___
<a id="dndevent"></a>

###  DndEvent

**Ƭ DndEvent**: *`DragEvent` & `DragEventInit`*

*Defined in dnd.source.ts:30*

___

## Variables

<a id="_data_param_prefix"></a>

### `<Const>` _DATA_PARAM_PREFIX

**● _DATA_PARAM_PREFIX**: *`string`* =  _DATA_PREFIX + 'param-'

*Defined in dnd.source.ts:62*

Prefix for parameter attributes

___
<a id="_data_prefix"></a>

### `<Const>` _DATA_PREFIX

**● _DATA_PREFIX**: *"data-"* = "data-"

*Defined in dnd.source.ts:54*

Prefix for data attributes

___
<a id="_json"></a>

### `<Const>` _JSON

**● _JSON**: *`JSON`* =  JSON

*Defined in dnd.source.ts:38*

___
<a id="_transfer_type"></a>

### `<Const>` _TRANSFER_TYPE

**● _TRANSFER_TYPE**: *"text"* = "text"

*Defined in dnd.source.ts:46*

Data transfer type

___
<a id="_document"></a>

### `<Const>` _document

**● _document**: *`Document`* =  document

*Defined in dnd.source.ts:799*

___
<a id="_keyeffectallowed"></a>

### `<Const>` _keyEffectAllowed

**● _keyEffectAllowed**: *"com.ibm.portal.dnd.effect.allowed"* =  KEY_EFFECT_ALLOWED

*Defined in dnd.source.ts:792*

___
<a id="_keypayload"></a>

### `<Const>` _keyPayload

**● _keyPayload**: *"com.ibm.portal.dnd.payload"* =  KEY_PAYLOAD

*Defined in dnd.source.ts:785*

___
<a id="_localstorage"></a>

### `<Const>` _localStorage

**● _localStorage**: *`Storage`* =  localStorage

*Defined in dnd.source.ts:806*

___
<a id="_ondrag"></a>

### `<Const>` _onDrag

**● _onDrag**: *[_noop](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)* =  _noop

*Defined in dnd.source.ts:823*

The drag callback

___

## Functions

<a id="_addaddressable"></a>

###  _addAddressable

▸ **_addAddressable**(aDst: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*, aObject: *[AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*, aDocument: *`Document`*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

*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](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |
| aObject | [AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |
| aDocument | `Document` |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

___
<a id="_addaddressablesfromdefinitionlist"></a>

###  _addAddressablesFromDefinitionList

▸ **_addAddressablesFromDefinitionList**(aDst: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*, 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](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |
| aObject | `HTMLDListElement` |

**Returns:** `void`

___
<a id="_addaddressablesfromelement"></a>

###  _addAddressablesFromElement

▸ **_addAddressablesFromElement**(aDst: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*, aObject: *`Element`*): `void`

*Defined in dnd.source.ts:406*

Converts an HTML element to an addressable object

**Parameters:**

| Name | Type |
| ------ | ------ |
| aDst | [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |
| aObject | `Element` |

**Returns:** `void`

___
<a id="_addaddressablesfromstring"></a>

###  _addAddressablesFromString

▸ **_addAddressablesFromString**(aDst: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*, aUris: *`string`*, aParams: *[Parameters](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)*): `void`

*Defined in dnd.source.ts:375*

Adds a set of addressabled

**Parameters:**

| Name | Type |
| ------ | ------ |
| aDst | [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |
| aUris | `string` |
| aParams | [Parameters](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee) |

**Returns:** `void`

___
<a id="_addeventlistener"></a>

###  _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`

___
<a id="_addeventlisteners"></a>

###  _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`

___
<a id="_clearlocalstorage"></a>

###  _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`

___
<a id="_createaddressable"></a>

###  _createAddressable

▸ **_createAddressable**(aUri: *`string`*, aParams: *[Parameters](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

*Defined in dnd.source.ts:322*

Constructs an addressable object

**Parameters:**

| Name | Type |
| ------ | ------ |
| aUri | `string` |
| aParams | [Parameters](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee) |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

___
<a id="_encodepayload"></a>

###  _encodePayload

▸ **_encodePayload**(aAddressables: *[AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*, aDocument: *`Document`*): `string`

*Defined in dnd.source.ts:613*

Constructs a string based payload based on the argument list

**Parameters:**

| Name | Type |
| ------ | ------ |
| aAddressables | [AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |
| aDocument | `Document` |

**Returns:** `string`

___
<a id="_getdatafromnode"></a>

###  _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`

___
<a id="_getdatatransfer"></a>

###  _getDataTransfer

▸ **_getDataTransfer**(aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*): `DataTransfer`

*Defined in dnd.source.ts:631*

Returns the data transfer object from the event

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | [DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |

**Returns:** `DataTransfer`

___
<a id="_getdragsource"></a>

###  _getDragSource

▸ **_getDragSource**(): `object`

*Defined in dnd.source.ts:917*

Returns the event handlers for a drag source

**Returns:** `object`

___
<a id="_getelement"></a>

###  _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`

___
<a id="_getelementbyid"></a>

###  _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`

___
<a id="_gettextcontent"></a>

###  _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`

___
<a id="_gettype"></a>

###  _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`

___
<a id="_isanchor"></a>

###  _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`

___
<a id="_isarray"></a>

###  _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`

___
<a id="_isdefinitionlist"></a>

###  _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`

___
<a id="_isdiv"></a>

###  _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`

___
<a id="_isnodelist"></a>

###  _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`

___
<a id="_isobject"></a>

###  _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`

___
<a id="_isstring"></a>

###  _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`

___
<a id="_noop"></a>

###  _noop

▸ **_noop**(): `void`

*Defined in dnd.source.ts:69*

Helper that just does nothing

**Returns:** `void`

___
<a id="_objecttoaddressable"></a>

###  _objectToAddressable

▸ **_objectToAddressable**(aObject: *`any`*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

*Defined in dnd.source.ts:350*

Converts an object to an addressable object

**Parameters:**

| Name | Type |
| ------ | ------ |
| aObject | `any` |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

___
<a id="_objecttojson"></a>

###  _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`

___
<a id="_ondragend"></a>

###  _onDragEnd

▸ **_onDragEnd**(aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*): `void`

*Defined in dnd.source.ts:888*

The dragend callback

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | [DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |

**Returns:** `void`

___
<a id="_ondragstart"></a>

###  _onDragStart

▸ **_onDragStart**(aEvent: *`DragEvent`*): `void`

*Defined in dnd.source.ts:813*

The dragstart callback

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | `DragEvent` |

**Returns:** `void`

___
<a id="_onremoveeffectallowed"></a>

###  _onRemoveEffectAllowed

▸ **_onRemoveEffectAllowed**(aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*): `void`

*Defined in dnd.source.ts:876*

Removes the effect allowed property

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | [DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |

**Returns:** `void`

___
<a id="_onremovepayload"></a>

###  _onRemovePayload

▸ **_onRemovePayload**(aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*): `void`

*Defined in dnd.source.ts:864*

Removes the payload

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | [DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |

**Returns:** `void`

___
<a id="_onseteffectallowed"></a>

###  _onSetEffectAllowed

▸ **_onSetEffectAllowed**(aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*, aEffect?: *`string`*): `void`

*Defined in dnd.source.ts:852*

Sets the effect allowed property

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | [DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |
| `Optional` aEffect | `string` |

**Returns:** `void`

___
<a id="_onsetpayload"></a>

###  _onSetPayload

▸ **_onSetPayload**(aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*, ...aAddressables: *[AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)[]*): `void`

*Defined in dnd.source.ts:831*

Sets the payload

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | [DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |
| `Rest` aAddressables | [AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)[] |

**Returns:** `void`

___
<a id="_preventdefault"></a>

###  _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`

___
<a id="_removeeffectallowed"></a>

###  _removeEffectAllowed

▸ **_removeEffectAllowed**(aLocalStorageKey: *`string`*, aLocalStorage: *`Storage`*, aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*): `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](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |

**Returns:** `void`

___
<a id="_removepayload"></a>

###  _removePayload

▸ **_removePayload**(aLocalStorageKey: *`string`*, aLocalStorage: *`Storage`*, aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*): `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](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |

**Returns:** `void`

___
<a id="_seteffectallowed"></a>

###  _setEffectAllowed

▸ **_setEffectAllowed**(aLocalStorageKey: *`string`*, aLocalStorage: *`Storage`*, aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*, 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](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |
| `Optional` aEffect | `string` |

**Returns:** `void`

___
<a id="_setpayload"></a>

###  _setPayload

▸ **_setPayload**(aLocalStorageKey: *`string`*, aLocalStorage: *`Storage`*, aEvent: *[DndEvent](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*, aAddressables: *[AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296)*, 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](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |
| aAddressables | [AddressableInput](#_a9fe8a17799ace6ad35a3d04f654610094d45c36061b02ada2d04b2312eb8296) |
| aDocument | `Document` |

**Returns:** `void`

___
<a id="_settolocalstorage"></a>

###  _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`

___
<a id="_stringtoaddressable"></a>

###  _stringToAddressable

▸ **_stringToAddressable**(aUri: *`string`*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

*Defined in dnd.source.ts:337*

Converts a string URI string into an addressable object

**Parameters:**

| Name | Type |
| ------ | ------ |
| aUri | `string` |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

___
<a id="_tostring"></a>

###  _toString

▸ **_toString**(aObject: *`any`*): `string`

*Defined in dnd.source.ts:121*

Converts the object to a string

**Parameters:**

| Name | Type |
| ------ | ------ |
| aObject | `any` |

**Returns:** `string`

___
<a id="_tostringarray"></a>

###  _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`[]

___
<a id="_trim"></a>

###  _trim

▸ **_trim**(aString: *`string`*): `string`

*Defined in dnd.source.ts:134*

Trims whitespaces from the string

**Parameters:**

| Name | Type |
| ------ | ------ |
| aString | `string` |

**Returns:** `string`

___


<a name="_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea"></a>
[@ibm-wch-sdk/layout-editor](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["dnd.target"](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

# External module: "dnd.target"

## Index

### Interfaces

* [DropTarget](#_7520a43a16cab88e061abdec99bf8f21cb69728cba7d0815fc4492d952a76496)

### Type aliases

* [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [ValidationCallback](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

### Variables

* [_DND_ALL](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_COPY](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_COPY_INDEX](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_COPY_LINK](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_COPY_MOVE](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_LINK](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_LINK_INDEX](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_LINK_MOVE](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_MOVE](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_MOVE_INDEX](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_NONE](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_DND_UNINITIALIZED](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_EFFECTS_ALLOWED](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_EFFECTS_ALLOWED_MAP](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_INPUT_FIELD_DROP_EFFECT](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_INPUT_FIELD_EFFECT_ALLOWED](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_INPUT_FIELD_SOURCE](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_JSON](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_JSON_REGEXP](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_LAST_MODIFIED](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_MIME_TYPE_TEXT](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_Object](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_SCHEME_FILE](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_TRANSFER_TYPE_FILES](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_TRANSFER_TYPE_TEXT](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_document](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_effectAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_encodeURIComponent](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_keyEffectAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_keyPayload](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_localStorage](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

### Functions

* [_addAddressable](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_addAddressables](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_addDropEffect](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_addEffectAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_addEventListener](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_addInputField](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_andEffectsAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_andInteger](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_clearLocalStorage](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_contains](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_copyPayloadTypes](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_createAddressable](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_decodeEffectsAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_decodeFiles](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_decodePayload](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getCombinedDropEffect](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getCombinedEffectsAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getDataTransfer](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getDropEffect](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getDropEffectFromEffectsAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getDropEffectFromEffectsAllowedWithFallback](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getDropTarget](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getEffectAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getEffectsAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getEffectsAllowedIndex](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getElement](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getElementById](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getFromLocalStorage](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getPayload](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getPayloadTypes](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getRESTValidator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getType](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getUrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getUrlGeneratorFromElement](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_getUrlGeneratorFromUrl](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_hasTransferTypeFiles](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_hasTransferTypeString](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isAnchor](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isArray](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isFunction](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isJson](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isString](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isURL](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isUninitializedEffectsAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_isValidPayload](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_jsonToObject](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_noop](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_onAddPayload](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_onGetEffectAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_onGetPayload](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_onGetRESTValidator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_prepareValidationURL](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_preventDefault](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_put](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_sendValidationRequest](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_setAttribute](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_setDropEffect](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_setEffectAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_testEffectAllowed](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)
* [_toString](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

---

## Type aliases

<a id="urlgenerator"></a>

###  UrlGenerator

**Ƭ UrlGenerator**: *`function`*

*Defined in dnd.target.ts:8*

#### Type declaration
▸(addr: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)*, evt: *`DragEvent`*): `string`

**Parameters:**

| Name | Type |
| ------ | ------ |
| addr | [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76) |
| evt | `DragEvent` |

**Returns:** `string`

___
<a id="validationcallback"></a>

###  ValidationCallback

**Ƭ ValidationCallback**: *`function`*

*Defined in dnd.target.ts:9*

#### Type declaration
▸(addr: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)*, effect: *`string`*): `any`

**Parameters:**

| Name | Type |
| ------ | ------ |
| addr | [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76) |
| effect | `string` |

**Returns:** `any`

___

## Variables

<a id="_dnd_all"></a>

### `<Const>` _DND_ALL

**● _DND_ALL**: *"all"* = "all"

*Defined in dnd.target.ts:71*

DND all operation

___
<a id="_dnd_copy"></a>

### `<Const>` _DND_COPY

**● _DND_COPY**: *"copy"* = "copy"

*Defined in dnd.target.ts:35*

DND copy operation

___
<a id="_dnd_copy_index"></a>

### `<Const>` _DND_COPY_INDEX

**● _DND_COPY_INDEX**: *`1`* = 1

*Defined in dnd.target.ts:131*

bitmask for the copy effect

___
<a id="_dnd_copy_link"></a>

### `<Const>` _DND_COPY_LINK

**● _DND_COPY_LINK**: *"copyLink"* = "copyLink"

*Defined in dnd.target.ts:61*

DND copy/link operation

___
<a id="_dnd_copy_move"></a>

### `<Const>` _DND_COPY_MOVE

**● _DND_COPY_MOVE**: *"copyMove"* = "copyMove"

*Defined in dnd.target.ts:56*

DND copy/move operation

___
<a id="_dnd_link"></a>

### `<Const>` _DND_LINK

**● _DND_LINK**: *"link"* = "link"

*Defined in dnd.target.ts:51*

DND link operation

___
<a id="_dnd_link_index"></a>

### `<Const>` _DND_LINK_INDEX

**● _DND_LINK_INDEX**: *`2`* = 2

*Defined in dnd.target.ts:141*

bitmask for the link effect

___
<a id="_dnd_link_move"></a>

### `<Const>` _DND_LINK_MOVE

**● _DND_LINK_MOVE**: *"linkMove"* = "linkMove"

*Defined in dnd.target.ts:66*

DND link/move operation

___
<a id="_dnd_move"></a>

### `<Const>` _DND_MOVE

**● _DND_MOVE**: *"move"* = "move"

*Defined in dnd.target.ts:43*

DND move operation

___
<a id="_dnd_move_index"></a>

### `<Const>` _DND_MOVE_INDEX

**● _DND_MOVE_INDEX**: *`4`* = 4

*Defined in dnd.target.ts:136*

bitmask for the move effect

___
<a id="_dnd_none"></a>

### `<Const>` _DND_NONE

**● _DND_NONE**: *"none"* = "none"

*Defined in dnd.target.ts:76*

DND none operation

___
<a id="_dnd_uninitialized"></a>

### `<Const>` _DND_UNINITIALIZED

**● _DND_UNINITIALIZED**: *"uninitialized"* = "uninitialized"

*Defined in dnd.target.ts:27*

___
<a id="_effects_allowed"></a>

### `<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

___
<a id="_effects_allowed_map"></a>

### `<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

___
<a id="_input_field_drop_effect"></a>

### `<Const>` _INPUT_FIELD_DROP_EFFECT

**● _INPUT_FIELD_DROP_EFFECT**: *"action"* = "action"

*Defined in dnd.target.ts:101*

The name of the action input field

___
<a id="_input_field_effect_allowed"></a>

### `<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

___
<a id="_input_field_source"></a>

### `<Const>` _INPUT_FIELD_SOURCE

**● _INPUT_FIELD_SOURCE**: *"source"* = "source"

*Defined in dnd.target.ts:96*

The name of the source input field

___
<a id="_json"></a>

### `<Const>` _JSON

**● _JSON**: *`JSON`* =  JSON

*Defined in dnd.target.ts:121*

Access to the JSON APIs

___
<a id="_json_regexp"></a>

### `<Const>` _JSON_REGEXP

**● _JSON_REGEXP**: *`RegExp`* =  /\{.*\}/

*Defined in dnd.target.ts:181*

Regular expression to test for a JSON string

___
<a id="_last_modified"></a>

### `<Const>` _LAST_MODIFIED

**● _LAST_MODIFIED**: *"last-modified"* = "last-modified"

*Defined in dnd.target.ts:111*

Last modified parameter for files

___
<a id="_mime_type_text"></a>

### `<Const>` _MIME_TYPE_TEXT

**● _MIME_TYPE_TEXT**: *"text/plain"* = "text/plain"

*Defined in dnd.target.ts:86*

Mime type for text

___
<a id="_object"></a>

### `<Const>` _Object

**● _Object**: *`ObjectConstructor`* =  Object

*Defined in dnd.target.ts:126*

The global object reference

___
<a id="_scheme_file"></a>

### `<Const>` _SCHEME_FILE

**● _SCHEME_FILE**: *"file:"* = "file:"

*Defined in dnd.target.ts:116*

URI scheme for files

___
<a id="_transfer_type_files"></a>

### `<Const>` _TRANSFER_TYPE_FILES

**● _TRANSFER_TYPE_FILES**: *"Files"* = "Files"

*Defined in dnd.target.ts:91*

Data transfer type for files

___
<a id="_transfer_type_text"></a>

### `<Const>` _TRANSFER_TYPE_TEXT

**● _TRANSFER_TYPE_TEXT**: *"text"* = "text"

*Defined in dnd.target.ts:81*

Data transfer type for text

___
<a id="_document"></a>

### `<Const>` _document

**● _document**: *`Document`* =  document

*Defined in dnd.target.ts:1108*

___
<a id="_effectallowed"></a>

### `<Let>` _effectAllowed

**● _effectAllowed**: *`string`*

*Defined in dnd.target.ts:186*

local effect allowed property as retreived from the local storage

___
<a id="_encodeuricomponent"></a>

### `<Const>` _encodeURIComponent

**● _encodeURIComponent**: *`encodeURIComponent`* =  encodeURIComponent

*Defined in dnd.target.ts:216*

Function that performs URL escaping on strings

___
<a id="_keyeffectallowed"></a>

### `<Const>` _keyEffectAllowed

**● _keyEffectAllowed**: *"com.ibm.portal.dnd.effect.allowed"* =  KEY_EFFECT_ALLOWED

*Defined in dnd.target.ts:1098*

___
<a id="_keypayload"></a>

### `<Const>` _keyPayload

**● _keyPayload**: *"com.ibm.portal.dnd.payload"* =  KEY_PAYLOAD

*Defined in dnd.target.ts:1093*

___
<a id="_localstorage"></a>

### `<Const>` _localStorage

**● _localStorage**: *`Storage`* =  localStorage

*Defined in dnd.target.ts:1103*

___

## Functions

<a id="_addaddressable"></a>

###  _addAddressable

▸ **_addAddressable**(aForm: *`HTMLFormElement`*, aAddressable: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)*): `void`

*Defined in dnd.target.ts:642*

Adds a single addressable to the form

**Parameters:**

| Name | Type |
| ------ | ------ |
| aForm | `HTMLFormElement` |
| aAddressable | [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76) |

**Returns:** `void`

___
<a id="_addaddressables"></a>

###  _addAddressables

▸ **_addAddressables**(aForm: *`HTMLFormElement`*, aAddressables: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*): `void`

*Defined in dnd.target.ts:683*

Adds the event payload to the form

**Parameters:**

| Name | Type |
| ------ | ------ |
| aForm | `HTMLFormElement` |
| aAddressables | [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |

**Returns:** `void`

___
<a id="_adddropeffect"></a>

###  _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`

___
<a id="_addeffectallowed"></a>

###  _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`

___
<a id="_addeventlistener"></a>

###  _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`

___
<a id="_addinputfield"></a>

###  _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`

___
<a id="_andeffectsallowed"></a>

###  _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`

___
<a id="_andinteger"></a>

###  _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`

___
<a id="_clearlocalstorage"></a>

###  _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`

___
<a id="_contains"></a>

###  _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`

___
<a id="_copypayloadtypes"></a>

###  _copyPayloadTypes

▸ **_copyPayloadTypes**(aArray: *`ReadonlyArray`<`string`>*): `string`[]

*Defined in dnd.target.ts:500*

Copies the source array

**Parameters:**

| Name | Type |
| ------ | ------ |
| aArray | `ReadonlyArray`<`string`> |

**Returns:** `string`[]

___
<a id="_createaddressable"></a>

###  _createAddressable

▸ **_createAddressable**(aUri: *`string`*, aParams: *[Parameters](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee)*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

*Defined in dnd.target.ts:347*

Constructs an addressable object

**Parameters:**

| Name | Type |
| ------ | ------ |
| aUri | `string` |
| aParams | [Parameters](#_c7129785aebf61b4f8459438cfe5ed499470c9f134c4c68fbd03e92d2d0781ee) |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)

___
<a id="_decodeeffectsallowed"></a>

###  _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`

___
<a id="_decodefiles"></a>

###  _decodeFiles

▸ **_decodeFiles**(aFiles: *`FileList`*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

*Defined in dnd.target.ts:386*

Constructs a JSON payload based on the data transfer files

**Parameters:**

| Name | Type |
| ------ | ------ |
| aFiles | `FileList` |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

___
<a id="_decodepayload"></a>

###  _decodePayload

▸ **_decodePayload**(aPayloadString: *`string`*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

*Defined in dnd.target.ts:357*

Constructs a JSON payload based on the data transfer string

**Parameters:**

| Name | Type |
| ------ | ------ |
| aPayloadString | `string` |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

___
<a id="_getcombineddropeffect"></a>

###  _getCombinedDropEffect

▸ **_getCombinedDropEffect**(aValidationStore: *`any`*, aAddressables: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*, 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](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |
| aEvent | `DragEvent` |

**Returns:** `string`

___
<a id="_getcombinedeffectsallowed"></a>

###  _getCombinedEffectsAllowed

▸ **_getCombinedEffectsAllowed**(aValidationStore: *`any`*, aAddressables: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*, 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](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |
| aEvent | `DragEvent` |

**Returns:** `string`

___
<a id="_getdatatransfer"></a>

###  _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`

___
<a id="_getdropeffect"></a>

###  _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`

___
<a id="_getdropeffectfromeffectsallowed"></a>

###  _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`

___
<a id="_getdropeffectfromeffectsallowedwithfallback"></a>

###  _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`

___
<a id="_getdroptarget"></a>

###  _getDropTarget

▸ **_getDropTarget**(aValidator: *`any`*): [DropTarget](#_7520a43a16cab88e061abdec99bf8f21cb69728cba7d0815fc4492d952a76496)

*Defined in dnd.target.ts:1183*

Constructs a drop target object that performs validation

**Parameters:**

| Name | Type |
| ------ | ------ |
| aValidator | `any` |

**Returns:** [DropTarget](#_7520a43a16cab88e061abdec99bf8f21cb69728cba7d0815fc4492d952a76496)

___
<a id="_geteffectallowed"></a>

###  _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`

___
<a id="_geteffectsallowed"></a>

###  _getEffectsAllowed

▸ **_getEffectsAllowed**(aValidationStore: *`any`*, aAddressables: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]*): `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](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[] |

**Returns:** `string`

___
<a id="_geteffectsallowedindex"></a>

###  _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`

___
<a id="_getelement"></a>

###  _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`

___
<a id="_getelementbyid"></a>

###  _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`

___
<a id="_getfromlocalstorage"></a>

###  _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`

___
<a id="_getpayload"></a>

###  _getPayload

▸ **_getPayload**(aLocalStorageKey: *`string`*, aLocalStorage: *`Storage`*, aEvent: *`DragEvent`*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

*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](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

___
<a id="_getpayloadtypes"></a>

###  _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`[]

___
<a id="_getrestvalidator"></a>

###  _getRESTValidator

▸ **_getRESTValidator**(aGenerator: *[UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea) \| `HTMLAnchorElement` \| `string`*, aDocument: *`Document`*): `_onValidate`

*Defined in dnd.target.ts:1058*

Returns a RESTful validator

**Parameters:**

| Name | Type |
| ------ | ------ |
| aGenerator | [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea) \| `HTMLAnchorElement` \| `string` |
| aDocument | `Document` |

**Returns:** `_onValidate`

___
<a id="_gettype"></a>

###  _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`

___
<a id="_geturlgenerator"></a>

###  _getUrlGenerator

▸ **_getUrlGenerator**(aGenerator: *[UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea) \| `HTMLAnchorElement` \| `string`*, aDocument: *`Document`*): [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

*Defined in dnd.target.ts:1023*

Produces a URL generator for the input

**Parameters:**

| Name | Type |
| ------ | ------ |
| aGenerator | [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea) \| `HTMLAnchorElement` \| `string` |
| aDocument | `Document` |

**Returns:** [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

___
<a id="_geturlgeneratorfromelement"></a>

###  _getUrlGeneratorFromElement

▸ **_getUrlGeneratorFromElement**(aAnchor: *`HTMLAnchorElement`*): [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

*Defined in dnd.target.ts:1016*

Decodes the URL generator from an anchor element

**Parameters:**

| Name | Type |
| ------ | ------ |
| aAnchor | `HTMLAnchorElement` |

**Returns:** [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

___
<a id="_geturlgeneratorfromurl"></a>

###  _getUrlGeneratorFromUrl

▸ **_getUrlGeneratorFromUrl**(aBaseURL: *`string`*): [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

*Defined in dnd.target.ts:1003*

Constructs a generator callback from a URL string

**Parameters:**

| Name | Type |
| ------ | ------ |
| aBaseURL | `string` |

**Returns:** [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)

___
<a id="_hastransfertypefiles"></a>

###  _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`

___
<a id="_hastransfertypestring"></a>

###  _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`

___
<a id="_isanchor"></a>

###  _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`

___
<a id="_isarray"></a>

###  _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`

___
<a id="_isfunction"></a>

###  _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`

___
<a id="_isjson"></a>

###  _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`

___
<a id="_isstring"></a>

###  _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`

___
<a id="_isurl"></a>

###  _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`

___
<a id="_isuninitializedeffectsallowed"></a>

###  _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`

___
<a id="_isvalidpayload"></a>

###  _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`

___
<a id="_jsontoobject"></a>

###  _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`

___
<a id="_noop"></a>

###  _noop

▸ **_noop**(): `void`

*Defined in dnd.target.ts:221*

Helper that just does nothing

**Returns:** `void`

___
<a id="_onaddpayload"></a>

###  _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`

___
<a id="_ongeteffectallowed"></a>

###  _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`

___
<a id="_ongetpayload"></a>

###  _onGetPayload

▸ **_onGetPayload**(aEvent: *`DragEvent`*): [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

*Defined in dnd.target.ts:1122*

Returns the event payload for the DND event as an object

**Parameters:**

| Name | Type |
| ------ | ------ |
| aEvent | `DragEvent` |

**Returns:** [Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)[]

___
<a id="_ongetrestvalidator"></a>

###  _onGetRESTValidator

▸ **_onGetRESTValidator**(aGenerator: *[UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea) \| `HTMLAnchorElement` \| `string`*): `_onValidate`

*Defined in dnd.target.ts:1113*

Returns a RESTful validator

**Parameters:**

| Name | Type |
| ------ | ------ |
| aGenerator | [UrlGenerator](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea) \| `HTMLAnchorElement` \| `string` |

**Returns:** `_onValidate`

___
<a id="_preparevalidationurl"></a>

###  _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`

___
<a id="_preventdefault"></a>

###  _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`

___
<a id="_put"></a>

###  _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`

___
<a id="_sendvalidationrequest"></a>

###  _sendValidationRequest

▸ **_sendValidationRequest**(aValidationURL: *`string`*, aAddressable: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76)*, aCallback: *[ValidationCallback](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea)*): `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](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe2859c1ab32e5d031cca76) |
| aCallback | [ValidationCallback](#_d9ad2818c5c1f4564c86bec8bba1870200bdf9447df7a0a6fe399195054c86ea) |

**Returns:** `void`

___
<a id="_setattribute"></a>

###  _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`

___
<a id="_setdropeffect"></a>

###  _setDropEffect

▸ **_setDropEffect**(aValidationStore: *`any`*, aAddressables: *[Addressable](#_85ec1450dd3a96c22e328c33f272c63c9b72ac6c9fe28