npm package: @ibm-wch-sdk/ng-edit
Description: Module to attach inline-edit functionality to an WCH based Angular application.
Author: Dr. Carsten Leue
Latest version: 6.0.524

<a name="_6413c217ac070f0cc888ef237e5f77bca091ed14c4a6b017e8102394c2fc842d"></a>
# ibm-wch-sdk-ng-edit

Module to attach inline-edit functionality to an [WCH](https://www.npmjs.com/package/@ibm-wch-sdk/ng) based [Angular](https://angular.io/) application. The library exposes the `WchNgEditModule` module.

## Changes

[CHANGELOG](#_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512)

## Details

Refer to the [documentation](#_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375).

## Class documentation

Refer to the [documentation](#_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b).

## Usage

Install the module via

```bash
npm install --save @ibm-wch-sdk/ng-edit
```

Add the module to your root application

```typescript
@NgModule({
  ...
  imports: [
    ...
    WchNgEditModule.forRoot(environment)
  ],
  ...
})
export class AppModule { }
```

The module exposes the `WchEditService` and the `wchEditable` directive.

## Prereqs

- [@ibm-wch-sdk/ng](https://www.npmjs.com/package/@ibm-wch-sdk/ng)
- Angular 6 or higher

## Directive [wchEditable]

The directive attaches inline edit functionality to an element that is managed by [WCH](https://www.npmjs.com/package/ibm-wch-sdk-ng). The implementation in this library only dispatches the actual realization of the inline-edit functionality to a pluggable service provider.

The directive assumes that the [Component](https://angular.io/api/core/Component) contains a `onRenderingContext` property that exposes the `RenderingContext` of the item currently edited. This contract is fulfilled automatically if the component extends [AbstractRenderingComponent](https://www.npmjs.com/package/ibm-wch-sdk-ng#_30d66fd25c62891da799936c1e1454566f3770b753be58d94b5621b01603a546).

The directive requires as a parameter a string identifying the editable property. This string must reference a property on the [Component](https://angular.io/api/core/Component) that has been bound to a field of the content item via a `@RenderingContextBinding` directive. This directive contains the actual selector of the field. Note that this binding is done automatically if the components are generated via the [CLI](https://www.npmjs.com/package/ibm-wch-sdk-cli).

### Example

```html
<div wchEditable="myField">{{renderingContext.elements.myField.value}}</div>
```

assuming the following binding

```typescript
export class MyComponent extends AbstractRenderingComponent {
  @RenderingContextBinding('elements.myField.value') myField: string;
}
```

## WchNgEditModule

The module exposes the directives and services. Per default it provides a service that loads the inline edit functionality from the site composer, when registering the module using the `forRoot` method.

- `forRoot(config?)`: the method registers the module and provides a service to load inline edit from the site composer. The location to load the edit script from is configurable via the config script, typically used for local debugging of the script via the `inlineEditUrl` member on the config object. A convenient way to inject this is to add `inlineEditUrl` to your environment object and then inject the environment object.

### Example

```typescript
import { WchNgEditModule } from '@ibm-wch-sdk/ng-edit';


@NgModule({
  ...
  imports: [
    ...
    WchNgEditModule.forRoot(environment),
    ...
  ]
})
export class AppModule {
}
```

## WchEditInfoService

The service allows to find out if an inline edit operation is taking place. Applications might want to stop any background processing during this period to avoid intercepting with the edit operation.

- `onEditing: Observable<boolean>`: the observable that tracks the state of the current inline edit operation. It is a shared observable that dispatches the current state and all subsequent states.

## WchInlineEditService

Service providers implement the `WchInlineEditService` and provide to the module. This service realizes the actual implementation of the inline edit operation.

- `registerComponent(el, accessor, onRenderingContext): Observable<EventTargetLike>`: this method will be invoked by the `[wchEditable]` directive for every editable element in the application. The `el` parameter references the editable DOM element. The `accessor` is string that represents the [Javascript property accessor](#user-content-accessor-expression) into the content items for the editable element. `onRenderingContext` exposes the context of the currently edited item. The method returns an observable of an [event emitter](http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#static-method-fromEvent). Subscribing to this observable makes the registration active, unsubscribing cancels it. The event emitter is used to listen for edit events.

### Edit events

The following inline edit events are recognized:

- `wchEditStart`: fired when an element enters into inline edit mode. This is used to track this status by the `WchEditInfoService`.
- `wchEditEnd`: fired when an element leaves inline edit mode (no matter whether the edit operation has been canceled or completed). This is used to track this status by the `WchEditInfoService`.

## WchHttpInlineEditService

The default implementation of the `WchInlineEditService`. If the system is in preview mode, then the service lazily loads an inline edit script from a configurable location. Per default this location points to TODO, it can be overridden by the `inlineEditUrl` property on the config object for the module.

### Script requirements

The inline edit script will be loaded via an HTTP request and executed dynamically. It needs to contain an [IIFE](https://en.wikipedia.org/wiki/Immediately-invoked_function_expression) that returns a registration object with the following properties:

- `register(el, accessor, onRenderingContext): Handle`: the register method will be called for every editable element, so the implementation of the method can attach the necessary event handlers to the DOM element to make it editable. The method returns a handle that allows to cancel the registration and to attach event handlers to the inline edit process to monitor it. The method receives the DOM element via the `el` parameter and an `accessor` that represents a Javascript property expression for the editable element in the content item. The `onRenderingContext` observable exposes the current context of the rendered item.

#### Handle

The handle needs to conform to one of the signatures of [EventTargetLike](http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#static-method-fromEvent) from the [RXJS](http://reactivex.io/rxjs/) spec. In addition it can expose a `dispose` method.

- `dispose`: the dispose method on the handle will be invoked to cancel a registration. This happens when the editable element falls out of scope, e.g. because of a page switch or because the application decides to hide it or for any other reason. Implementers need to make sure to unregister all previously registered event handlers.

#### Require

The inline edit script can use a `require` function that is available in its scope to load extra resources or services exposed by the SDK. The following services are available:

- `wch-config`: a configuration object containing URLs for the current tenant
- `wch-info`: the hub configuration exposed to the SDK by the SPA
- `wch-logger`: access to the SDK logging infrastructure. It is suggested to uses the exposed logger instead of console logs.

In addition the `require` function will resolve URLs relative to the URL used to load the script and returns the result as text. All return values are exposed as promises.

Example for accessing the config:

```typescript
const config = require('wch-config');
config.then(c => console.log(c.apiUrl));
```

Example for loading an extra resource:

```typescript
const res = require('./myExtraResource.txt');
res.then(console.log);
```

Example for using the logger:

```typescript
const logger = require('wch-logger');
logger
  .then(logger => logger.get('MyModule'))
  .then(log => log.info('some log output'));
```

## Accessor Expression

Accessor expressions allow to identify the field of a [Content Item](https://developer.ibm.com/customer-engagement/docs/wch/authoring-content/) that the inline edit operation refers to. It is a string in the format of a [Javascript property accessor](https://developer.mozilla.org/en-US/docs/Web/javascript/Reference/Operators/Property_Accessors).

### Examples

- `name`: accesses the name attribute of a content item.
- `elements.myText.value`: accesses the value of a single valued element called `myText`.
- `elements.myTexts.values[2]`: accesses the third value of a multi valued element called `myTexts`.

<a name="_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512"></a>
# Changelog

## Current

## 6.0.69

### Changed

* Improved readme

### Added

* Support for Angular 6
* Support for `group` elements
* Initial version

<a name="_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375"></a>
# WchNgEditModule

Module that allows to attach inline edit functionality to a [WCH](https://www.npmjs.com/package/ibm-wch-sdk-ng) based [Angular](https://angular.io/) application.

## Usage

Install the module

```bash
npm install --save ibm-wch-sdk-ng-edit
```

Import the module into your application. Use the environment variable to configure the module, this is the same configuration as for the main `WchNgModule` module.

```typescript
import {WchNgEditModule} from 'ibm-wch-sdk-ng-edit';

...

@NgModule({
  ...
  imports: [
    WchNgEditModule.forRoot(environment)
    ...
  ]
```

Annotate your [editable components](#_77e8dcf319c2b841f02f187abfc5d5b03000ffc9731da0519fbb8b281ec3bcdb). Pass the selector to the text field as parameter to the directive.

```html
<div wchEditable='elements.myText'>{{renderingContext.elements.myText.value}}</div>
```

## Dependencies

The modules assumes an implementation of the `WchInlineEditService`. This service must be injected into the main module.

## Developing modules based on the SDK

When developing modules that use the SDK, make sure to import the [WchNgEditComponentsModule](#_575fbdac6e637d569d4bfacce517e04a7e73bf62dfb055457e96d0899919b8e3) to have access to the components and directives exposed by the SDK.

## Configuration

The module can be configured via the `forRoot` method or by providing overrides for the individual [configuration tokens](#_f94d364bc469e0a46dbdc939d9d54cc7b5cd275bda2315666ae1cb148ffb5106).

## Components

The module exposes the following [Components](#_fa2f90834dc7bcb7615fc33319f9ed6a63f8c69fa277bfa7f08386c0beb5fb31).

<a name="_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b"></a>

#  @ibm-wch-sdk/ng-edit

## Index

### External modules

* ["components/login/abstract.login.component"](#_57d1536e92f3259a56de83ad4f534e5ef31be6183e35d31a6bef40f1553e9b48)
* ["components/placeholder/placeholder.component"](#_b8bcf24f0eb033b7d92f2763e186e07b041756d7aa5e1b248744fed1898456db)
* ["config/config"](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)
* ["config/index"](#_a88bc243358c568699a774dd415704b39561c4b01f501ada018c9c7074a5baf3)
* ["directives/editable/abstract.editable.directive"](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)
* ["directives/editable/editable.directive"](#_618dfdfe1486cb8727797bb66dfee63b0943431d9825c457884e3e7029808641)
* ["directives/editable/editable.placeholder.directive"](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42)
* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["interfaces/inline.edit.service"](#_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf)
* ["module"](#_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d)
* ["modules/components.module"](#_ac395f8820e08b5a7b39bcf985084d84c19fe9e5a08bfaafcbc3a839960ddbbe)
* ["modules/services.module"](#_592bc31cea7e41c9a14b09ed740079f56fee2ee83bc91d3b963d6df2758cc23b)
* ["placeholder/placeholder"](#_3935f21e7775194b57592db64666e5ab688c3fed9ad4fcd9d0865e8f9dda2554)
* ["services/config/default.wch.edit.config"](#_40a39027970c0330058e6929a2026f389d06f7229dff1d51e88a7aae8cd897bd)
* ["services/config/index"](#_3e9114540ccef1a77f321f6e50702f0823efea1c15bdaff6f6e6fab7454dc345)
* ["services/config/wch.edit.config"](#_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af)
* ["services/edit/wch.inline.edit.service"](#_4f172a76a783780282c4683a98aca107ed39963c000b683d0a358bac3c45a637)
* ["services/http/http.inline.edit.service"](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* ["services/http/index"](#_c842618e34dd28d33eee0ef53a19414267bf6216f7b10fbe2e149ebd086719f9)
* ["services/index"](#_daa53c792a147345f69b4c54fb7760f0068ff15efd60ccac0c438fdebc6dcfe3)
* ["services/info/index"](#_47c4b3a242e166d237a488877efed5a9cebfbebb8de342e9cfd1eae759af6b92)
* ["services/info/wch.edit.info.service"](#_aff61500799f7dc5efe819712a70ef809adfbcd2593d4eb10ac144bd3f91ddc9)
* ["services/info/wch.internal.edit.service"](#_0e84db0522a33d94ed0b1a3df6070965c7bbce1bc22c9b7fd77408813813bd26)
* ["services/placeholders/placeholders.service"](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* ["services/rendering/index"](#_5a526e2333bf33a918e3c394bf1257770a7e77a7d71b2dc9c2a1d38d06a2453c)
* ["services/rendering/placeholder.interceptor"](#_0105599e8003a181a8d32360f01b682fabead43d8584b585cd68cc78a998c221)
* ["services/wch/index"](#_c6eb9a2713080936248fdf042051b8768fa50e7be6647933ec8ccf61c230b1eb)
* ["services/wch/wch.edit.service"](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* ["utils/assert"](#_ea7ca3750272a67afce0dc4ec5a17e56ff64c1aff5c8fdfd7ea4c97c427e1035)
* ["utils/config"](#_7579a88bcba5129ee04566b77f62adc9b6550ffeea53303c012dac3691cf0af6)
* ["utils/events"](#_d5d8e8d0a5717fd5339c0be60b49cc95458277322f9602af09910bdc911c713b)
* ["utils/placeholder"](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* ["utils/replacement"](#_c4b196a7dddf3d93dbfa89b291adacee097f19059a772d03ea801f94173dbacd)

---


<a name="_57d1536e92f3259a56de83ad4f534e5ef31be6183e35d31a6bef40f1553e9b48"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["components/login/abstract.login.component"](#_57d1536e92f3259a56de83ad4f534e5ef31be6183e35d31a6bef40f1553e9b48)

# External module: "components/login/abstract.login.component"

## Index

### Classes

* [AbstractLoginComponent](#_d400150db7ec5c23d9ef55cec1b306a706a2a82a2511a7a80b2334f322702e25)

### Variables

* [LOGGER](#_57d1536e92f3259a56de83ad4f534e5ef31be6183e35d31a6bef40f1553e9b48)

---

## Variables

<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"AbstractLoginComponent"* = "AbstractLoginComponent"

*Defined in components/login/abstract.login.component.ts:17*

___


<a name="_b8bcf24f0eb033b7d92f2763e186e07b041756d7aa5e1b248744fed1898456db"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["components/placeholder/placeholder.component"](#_b8bcf24f0eb033b7d92f2763e186e07b041756d7aa5e1b248744fed1898456db)

# External module: "components/placeholder/placeholder.component"

## Index

### Classes

* [WchPlaceholderComponent](#_1339af9bf0e4051bd98d56ae38553131e2bd574098c3dfdd82a2c3201c570097)

### Variables

* [COUNT](#_b8bcf24f0eb033b7d92f2763e186e07b041756d7aa5e1b248744fed1898456db)
* [LOGGER](#_b8bcf24f0eb033b7d92f2763e186e07b041756d7aa5e1b248744fed1898456db)

---

## Variables

<a id="count"></a>

### `<Let>` COUNT

**● COUNT**: *`number`* = 0

*Defined in components/placeholder/placeholder.component.ts:49*

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

### `<Const>` LOGGER

**● LOGGER**: *"WchPlaceholderComponent"* = "WchPlaceholderComponent"

*Defined in components/placeholder/placeholder.component.ts:46*

___


<a name="_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["config/config"](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)

# External module: "config/config"

## Index

### Variables

* [WCH_EDIT_HUB_INFO_SERVICE](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)
* [WCH_THROTTLE_LOADING](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)
* [WCH_TOKEN_DEBUG_PLACEHOLDERS](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)
* [WCH_TOKEN_DEFAULT_PLACEHOLDER_TEXT](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)
* [WCH_TOKEN_INLINE_EDIT_URL](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)
* [WCH_TOKEN_PLACEHOLDER_TAG](#_a2086ca28d716463fe102f95000441d7440809d064e37722b4424235d75f27c2)

---

## Variables

<a id="wch_edit_hub_info_service"></a>

### `<Const>` WCH_EDIT_HUB_INFO_SERVICE

**● WCH_EDIT_HUB_INFO_SERVICE**: *`InjectionToken`<[EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)>* =  new InjectionToken<EditHubInfoService>(
  'EditHubInfoService'
)

*Defined in config/config.ts:46*

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

### `<Const>` WCH_THROTTLE_LOADING

**● WCH_THROTTLE_LOADING**: *"D1576F60-7D2A-4824-9771-A1EB574771DB"* = "D1576F60-7D2A-4824-9771-A1EB574771DB"

*Defined in config/config.ts:44*

Injection token for placeholder debugging

*__see__*: [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)

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

### `<Const>` WCH_TOKEN_DEBUG_PLACEHOLDERS

**● WCH_TOKEN_DEBUG_PLACEHOLDERS**: *"03066F08-3E5E-41BE-B1E9-B0F31D0C881D"* = "03066F08-3E5E-41BE-B1E9-B0F31D0C881D"

*Defined in config/config.ts:36*

Injection token for placeholder debugging

*__see__*: [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)

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

### `<Const>` WCH_TOKEN_DEFAULT_PLACEHOLDER_TEXT

**● WCH_TOKEN_DEFAULT_PLACEHOLDER_TEXT**: *"10DDECF4-3818-4B08-BD34-CA073F831E9B"* = "10DDECF4-3818-4B08-BD34-CA073F831E9B"

*Defined in config/config.ts:14*

Injection token for default placeholder text

*__see__*: [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733) import { InjectionToken } from '@angular/core';

import { EditHubInfoService } from './../services/config/wch.edit.config';

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

### `<Const>` WCH_TOKEN_INLINE_EDIT_URL

**● WCH_TOKEN_INLINE_EDIT_URL**: *"0E7D0A87-FBDD-4565-9C8F-DB5909B6D9AF"* = "0E7D0A87-FBDD-4565-9C8F-DB5909B6D9AF"

*Defined in config/config.ts:22*

Injection token for inline edit url

*__see__*: [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)

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

### `<Const>` WCH_TOKEN_PLACEHOLDER_TAG

**● WCH_TOKEN_PLACEHOLDER_TAG**: *"C80F7BDA-438D-49F9-B63B-3BDA1FC13E99"* = "C80F7BDA-438D-49F9-B63B-3BDA1FC13E99"

*Defined in config/config.ts:29*

Injection token for placeholder tag

*__see__*: [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)

___


<a name="_a88bc243358c568699a774dd415704b39561c4b01f501ada018c9c7074a5baf3"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["config/index"](#_a88bc243358c568699a774dd415704b39561c4b01f501ada018c9c7074a5baf3)

# External module: "config/index"

## Index

---


<a name="_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["directives/editable/abstract.editable.directive"](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)

# External module: "directives/editable/abstract.editable.directive"

## Index

### Classes

* [AbstractWchEditableDirective](#_1508ecb0efd8e12e4f5ad36111f33b7918b8addfda7796a38d4686140a8652f7)

### Type aliases

* [WchEditableType](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)

### Variables

* [COMPONENT_ACCESSOR](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)
* [COUNT](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)
* [KEY_ON_RENDERING_CONTEXT](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)
* [LOGGER](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)
* [ON_COMPONENT_ACCESSOR](#_ff9cbfff2c820dde883b0f94bcdb766927cfc7a6b9f7a6234b2440f6ce0de23e)

---

## Type aliases

<a id="wcheditabletype"></a>

###  WchEditableType

**Ƭ WchEditableType**: *`string` \| `null`*

*Defined in directives/editable/abstract.editable.directive.ts:80*

___

## Variables

<a id="component_accessor"></a>

### `<Const>` COMPONENT_ACCESSOR

**● COMPONENT_ACCESSOR**: *`AccessorType`* =  null

*Defined in directives/editable/abstract.editable.directive.ts:83*

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

### `<Let>` COUNT

**● COUNT**: *`number`* = 0

*Defined in directives/editable/abstract.editable.directive.ts:73*

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

### `<Const>` KEY_ON_RENDERING_CONTEXT

**● KEY_ON_RENDERING_CONTEXT**: *"onRenderingContext"* = "onRenderingContext"

*Defined in directives/editable/abstract.editable.directive.ts:75*

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

### `<Const>` LOGGER

**● LOGGER**: *"AbstractWchEditableDirective"* = "AbstractWchEditableDirective"

*Defined in directives/editable/abstract.editable.directive.ts:77*

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

### `<Const>` ON_COMPONENT_ACCESSOR

**● ON_COMPONENT_ACCESSOR**: *`Observable`<`string`>* =  of(COMPONENT_ACCESSOR)

*Defined in directives/editable/abstract.editable.directive.ts:86*

___


<a name="_618dfdfe1486cb8727797bb66dfee63b0943431d9825c457884e3e7029808641"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["directives/editable/editable.directive"](#_618dfdfe1486cb8727797bb66dfee63b0943431d9825c457884e3e7029808641)

# External module: "directives/editable/editable.directive"

## Index

### Classes

* [WchEditableDirective](#_d201b45b3a3c15b8e68cfbf064ad720126572b2445afecc9d988f7be807492e8)

---


<a name="_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["directives/editable/editable.placeholder.directive"](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42)

# External module: "directives/editable/editable.placeholder.directive"

## Index

### Classes

* [WchEditablePlaceholderDirective](#_ef53c326ef1c4eb7a31364e550c701ba7d324b00d59e11afee90362a9ff35f83)

### Type aliases

* [TEXT_PROPERTY](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42)

### Variables

* [LOGGER](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42)

### Functions

* [_setText](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42)
* [_textSetter](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42)

---

## Type aliases

<a id="text_property"></a>

###  TEXT_PROPERTY

**Ƭ TEXT_PROPERTY**: *"innerHTML" \| "innerText"*

*Defined in directives/editable/editable.placeholder.directive.ts:72*

___

## Variables

<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"WchEditablePlaceholderDirective"* = "WchEditablePlaceholderDirective"

*Defined in directives/editable/editable.placeholder.directive.ts:70*

___

## Functions

<a id="_settext"></a>

###  _setText

▸ **_setText**(aProp: *[TEXT_PROPERTY](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42)*, aLocalizedText: *`LocalizedText`*, aElement: *`ElementRef`*, aRenderer: *`Renderer2`*): `void`

*Defined in directives/editable/editable.placeholder.directive.ts:82*

Assigns the text to a value

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aProp | [TEXT_PROPERTY](#_0a6816f60b7c2dd418d9685b823d9b9afcf49f533f0384365122a511e4232b42) |  the property to assign |
| aLocalizedText | `LocalizedText` |  the actual text |
| aElement | `ElementRef` |  the native element |
| aRenderer | `Renderer2` |  render used to assign the text |

**Returns:** `void`

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

### `<Const>` _textSetter

▸ **_textSetter**(aElement: *`any`*, aRenderer: *`Renderer2`*): `(Anonymous function)`

*Defined in directives/editable/editable.placeholder.directive.ts:113*

Binds the element ref and the renderer

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aElement | `any` |  the eleemnt reference |
| aRenderer | `Renderer2` |  the renderer |

**Returns:** `(Anonymous function)`
function that only takes the property name and the

___


<a name="_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)

# External module: "index"

## Index

---


<a name="_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/inline.edit.service"](#_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf)

# External module: "interfaces/inline.edit.service"

## Index

### Variables

* [EVENT_EDIT_END](#_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf)
* [EVENT_EDIT_START](#_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf)
* [EVENT_INLINE_EDIT_END](#_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf)
* [EVENT_INLINE_EDIT_START](#_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf)
* [WchInlineEditServiceToken](#_830d7740be790b0e4ae07bd57d207ab02e277920873cf7da8592eec84a8381cf)

---

## Variables

<a id="event_edit_end"></a>

### `<Const>` EVENT_EDIT_END

**● EVENT_EDIT_END**: *"wchEditEnd"* = "wchEditEnd"

*Defined in interfaces/inline.edit.service.ts:7*

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

### `<Const>` EVENT_EDIT_START

**● EVENT_EDIT_START**: *"wchEditStart"* = "wchEditStart"

*Defined in interfaces/inline.edit.service.ts:6*

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

### `<Const>` EVENT_INLINE_EDIT_END

**● EVENT_INLINE_EDIT_END**: *"wchInlineEditEnd"* = "wchInlineEditEnd"

*Defined in interfaces/inline.edit.service.ts:10*

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

### `<Const>` EVENT_INLINE_EDIT_START

**● EVENT_INLINE_EDIT_START**: *"wchInlineEditStart"* = "wchInlineEditStart"

*Defined in interfaces/inline.edit.service.ts:9*

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

### `<Const>` WchInlineEditServiceToken

**● WchInlineEditServiceToken**: *`InjectionToken`<`WchInlineEditService`>* =  new InjectionToken<
  WchInlineEditService
>('WchInlineEditServiceToken')

*Defined in interfaces/inline.edit.service.ts:15*

___


<a name="_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["module"](#_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d)

# External module: "module"

## Index

### Classes

* [WchNgEditModule](#_2f612069c39108e261502ac48f3c318a781b4068ab7eae6e8192caed93b15857)

### Variables

* [WCH_RC_INTERCEPTOR_TOKEN](#_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d)

---

## Variables

<a id="wch_rc_interceptor_token"></a>

### `<Const>` WCH_RC_INTERCEPTOR_TOKEN

**● WCH_RC_INTERCEPTOR_TOKEN**: *"8453750A-4519-4184-840B-D490E909D23E"* = "8453750A-4519-4184-840B-D490E909D23E"

*Defined in module.ts:32*

___


<a name="_ac395f8820e08b5a7b39bcf985084d84c19fe9e5a08bfaafcbc3a839960ddbbe"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["modules/components.module"](#_ac395f8820e08b5a7b39bcf985084d84c19fe9e5a08bfaafcbc3a839960ddbbe)

# External module: "modules/components.module"

## Index

### Classes

* [WchNgEditComponentsModule](#_20bf2964e9cc6c31ae0ba98e7187ab9115a2620e7f202e07bf51495e6b8bc843)

---


<a name="_592bc31cea7e41c9a14b09ed740079f56fee2ee83bc91d3b963d6df2758cc23b"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["modules/services.module"](#_592bc31cea7e41c9a14b09ed740079f56fee2ee83bc91d3b963d6df2758cc23b)

# External module: "modules/services.module"

## Index

### Classes

* [WchNgEditServicesModule](#_32feaf7cc3cc2f5c3e7aea6b752007642663c53d6f05658149c260eadcf8bb7f)

---


<a name="_3935f21e7775194b57592db64666e5ab688c3fed9ad4fcd9d0865e8f9dda2554"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["placeholder/placeholder"](#_3935f21e7775194b57592db64666e5ab688c3fed9ad4fcd9d0865e8f9dda2554)

# External module: "placeholder/placeholder"

## Index

### Variables

* [REL_PATH_TYPE_BY_ID](#_3935f21e7775194b57592db64666e5ab688c3fed9ad4fcd9d0865e8f9dda2554)

### Functions

* [loadAuthoringType](#_3935f21e7775194b57592db64666e5ab688c3fed9ad4fcd9d0865e8f9dda2554)

---

## Variables

<a id="rel_path_type_by_id"></a>

### `<Const>` REL_PATH_TYPE_BY_ID

**● REL_PATH_TYPE_BY_ID**: *"delivery/v1/rendering/type/"* = "delivery/v1/rendering/type/"

*Defined in placeholder/placeholder.ts:8*

___

## Functions

<a id="loadauthoringtype"></a>

###  loadAuthoringType

▸ **loadAuthoringType**(aService: *`WchHttpService`*, aTypeId: *`string`*): `Observable`<`AuthoringType`>

*Defined in placeholder/placeholder.ts:10*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aService | `WchHttpService` |
| aTypeId | `string` |

**Returns:** `Observable`<`AuthoringType`>

___


<a name="_40a39027970c0330058e6929a2026f389d06f7229dff1d51e88a7aae8cd897bd"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/config/default.wch.edit.config"](#_40a39027970c0330058e6929a2026f389d06f7229dff1d51e88a7aae8cd897bd)

# External module: "services/config/default.wch.edit.config"

## Index

### Variables

* [DEFAULT_DEBUG_PLACEHOLDERS](#_40a39027970c0330058e6929a2026f389d06f7229dff1d51e88a7aae8cd897bd)
* [DEFAULT_INLINE_EDIT_URL](#_40a39027970c0330058e6929a2026f389d06f7229dff1d51e88a7aae8cd897bd)

---

## Variables

<a id="default_debug_placeholders"></a>

### `<Const>` DEFAULT_DEBUG_PLACEHOLDERS

**● DEFAULT_DEBUG_PLACEHOLDERS**: *`false`* = false

*Defined in services/config/default.wch.edit.config.ts:8*

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

### `<Const>` DEFAULT_INLINE_EDIT_URL

**● DEFAULT_INLINE_EDIT_URL**: *"${authoringUIBaseUrl.protocol}//${authoringUIBaseUrl.host}/authoring-sites-ui/inline-edit/inline-edit.js"* = "${authoringUIBaseUrl.protocol}//${authoringUIBaseUrl.host}/authoring-sites-ui/inline-edit/inline-edit.js"

*Defined in services/config/default.wch.edit.config.ts:4*

___


<a name="_3e9114540ccef1a77f321f6e50702f0823efea1c15bdaff6f6e6fab7454dc345"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/config/index"](#_3e9114540ccef1a77f321f6e50702f0823efea1c15bdaff6f6e6fab7454dc345)

# External module: "services/config/index"

## Index

---


<a name="_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/config/wch.edit.config"](#_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af)

# External module: "services/config/wch.edit.config"

## Index

### Interfaces

* [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)

### Functions

* [selectDebugPlaceholder](#_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af)
* [selectDefaultPlaceholder](#_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af)
* [selectInlineEditURL](#_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af)
* [selectPlaceholderTag](#_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af)
* [selectThrottleLoading](#_f01bf734c8fcbddf9f52460120c9fbf363521043a55d939f83426391d88c15af)

---

## Functions

<a id="selectdebugplaceholder"></a>

###  selectDebugPlaceholder

▸ **selectDebugPlaceholder**(aConfig?: *[EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)*): `boolean`

*Defined in services/config/wch.edit.config.ts:47*

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aConfig | [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733) |

**Returns:** `boolean`

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

###  selectDefaultPlaceholder

▸ **selectDefaultPlaceholder**(aConfig?: *[EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)*): [WchDefaultPlaceholder](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)

*Defined in services/config/wch.edit.config.ts:41*

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aConfig | [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733) |

**Returns:** [WchDefaultPlaceholder](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)

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

###  selectInlineEditURL

▸ **selectInlineEditURL**(aConfig?: *[EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)*): `HubInfoUrlProvider`

*Defined in services/config/wch.edit.config.ts:51*

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aConfig | [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733) |

**Returns:** `HubInfoUrlProvider`

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

###  selectPlaceholderTag

▸ **selectPlaceholderTag**(aConfig?: *[EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)*): `string`

*Defined in services/config/wch.edit.config.ts:57*

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aConfig | [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733) |

**Returns:** `string`

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

###  selectThrottleLoading

▸ **selectThrottleLoading**(aConfig?: *[EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733)*): `number`

*Defined in services/config/wch.edit.config.ts:61*

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aConfig | [EditHubInfoService](#_27f49184dd1d1f63c31b543830291fa98c5f56250e02194ce2dc55862f390733) |

**Returns:** `number`

___


<a name="_4f172a76a783780282c4683a98aca107ed39963c000b683d0a358bac3c45a637"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/edit/wch.inline.edit.service"](#_4f172a76a783780282c4683a98aca107ed39963c000b683d0a358bac3c45a637)

# External module: "services/edit/wch.inline.edit.service"

## Index

### Classes

* [WchInlineEditRegistrationService](#_3afe747084f20ef30b39a2a80005d7e6f403c95f917d62ca9260bfea6d039573)

### Variables

* [LOGGER](#_4f172a76a783780282c4683a98aca107ed39963c000b683d0a358bac3c45a637)

---

## Variables

<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"WchInlineEditRegistrationService"* = "WchInlineEditRegistrationService"

*Defined in services/edit/wch.inline.edit.service.ts:25*

___


<a name="_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/http/http.inline.edit.service"](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)

# External module: "services/http/http.inline.edit.service"

## Index

### Classes

* [WchHttpInlineEditService](#_c29a79315273736ea75ed1eb78466448b331bf50d3c46d0d223cdc71ea22b8e4)

### Interfaces

* [Disposable](#_41e728e1eb71d4144b02ef46463ad1cbca2e8e5073a2883f055fd92e4599e7b0)

### Variables

* [EMPTY_REGISTRATION](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [LOGGER](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [REG_ID](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [_dummyFromEvent](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [_fromHubInfoUrlProvider](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [_registerDummyComponent](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)

### Functions

* [_createEmptyRegistration](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [_createRegistration](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [_createWchInlineEditEvent](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [_getAbsoluteUrl](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)
* [_registerForEvent](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)

### Object literals

* [EMPTY_WCH_INLINE_EDIT_SERVICE](#_c6cb08bf6c4cd7761ed5639112a07c858071a9c3da013b1a87f897a1f559fa7d)

---

## Variables

<a id="empty_registration"></a>

### `<Const>` EMPTY_REGISTRATION

**● EMPTY_REGISTRATION**: *`NodeStyleEventEmitter` \| `JQueryStyleEventEmitter` \| `HasEventTargetAddRemove`<`any`> \| `NodeStyleEventEmitter` & `Disposable` \| `JQueryStyleEventEmitter` & `Disposable` \| `HasEventTargetAddRemove`<`any`> & `Disposable`* =  _createEmptyRegistration()

*Defined in services/http/http.inline.edit.service.ts:138*

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

### `<Const>` LOGGER

**● LOGGER**: *"WchHttpInlineEditService"* = "WchHttpInlineEditService"

*Defined in services/http/http.inline.edit.service.ts:73*

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

### `<Let>` REG_ID

**● REG_ID**: *`number`* = 0

*Defined in services/http/http.inline.edit.service.ts:141*

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

### `<Const>` _dummyFromEvent

**● _dummyFromEvent**: *`function`* =  constGenerator(EMPTY)

*Defined in services/http/http.inline.edit.service.ts:228*

Dummy callback

*__param__*: 

#### Type declaration
▸<`T`>(): `Observable`<`T`>

**Type parameters:**

#### T 

**Returns:** `Observable`<`T`>

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

### `<Const>` _fromHubInfoUrlProvider

**● _fromHubInfoUrlProvider**: *`UnaryFunction`<`string` \| `URL`, `string`>* =  compose<
  URL | string,
  GeneratorOrT<string>,
  string
>(
  urlToString,
  fromGeneratorOrT
)

*Defined in services/http/http.inline.edit.service.ts:251*

Converts the provider into a URL

*__param__*: the provider

*__returns__*: the URL if available

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

### `<Const>` _registerDummyComponent

**● _registerDummyComponent**: *`function`* =  constGenerator(of(EMPTY_REGISTRATION))

*Defined in services/http/http.inline.edit.service.ts:237*

Registers a dummy component

*__param__*: the native element

*__param__*: the accesor

*__param__*: rendering context

#### Type declaration
▸(): `T`

**Returns:** `T`

___

## Functions

<a id="_createemptyregistration"></a>

###  _createEmptyRegistration

▸ **_createEmptyRegistration**(): `WchInlineEditRegistrationResult`

*Defined in services/http/http.inline.edit.service.ts:85*

Creates an empty registration result as fallback

**Returns:** `WchInlineEditRegistrationResult`

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

###  _createRegistration

▸ **_createRegistration**(aRegisterMethod: *`WchInlineEditRegistration`*, nativeElement: *`any`*, accessor: *`AccessorType`*, onRenderingContext: *`Observable`<`RenderingContext`>*, logger: *`Logger`*): `Observable`<`EventTargetLike`<`any`>>

*Defined in services/http/http.inline.edit.service.ts:153*

Constructs the registration for a native element

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aRegisterMethod | `WchInlineEditRegistration` |  registration callback method |
| nativeElement | `any` |  the native element |
| accessor | `AccessorType` |  accessor string |
| onRenderingContext | `Observable`<`RenderingContext`> |  rendering context |
| logger | `Logger` |

**Returns:** `Observable`<`EventTargetLike`<`any`>>
observable of the registration result in form of an event emitter

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

###  _createWchInlineEditEvent

▸ **_createWchInlineEditEvent**(aType: *`string`*, aData: *`any`*): `WchInlineEditEvent`

*Defined in services/http/http.inline.edit.service.ts:102*

Constructs the event

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aType | `string` |  the event type |
| aData | `any` |  the event data |

**Returns:** `WchInlineEditEvent`
the event object

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

###  _getAbsoluteUrl

▸ **_getAbsoluteUrl**(base: *`string`*, relative: *`string`*): `string`

*Defined in services/http/http.inline.edit.service.ts:199*

Resolves a relative URL against a base URL

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| base | `string` |  the base URL |
| relative | `string` |  the relative URL |

**Returns:** `string`
the result

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

###  _registerForEvent

▸ **_registerForEvent**(aType: *`string`*, aEmitter: *`EventTargetLike`<`any`>*, aLogger: *`Logger`*): `Observable`<`WchInlineEditEvent`>

*Defined in services/http/http.inline.edit.service.ts:121*

Registers for an event

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aType | `string` |  the event type |
| aEmitter | `EventTargetLike`<`any`> |  the event emitter |
| aLogger | `Logger` |

**Returns:** `Observable`<`WchInlineEditEvent`>
the sequence of events

___

## Object literals

<a id="empty_wch_inline_edit_service"></a>

### `<Const>` EMPTY_WCH_INLINE_EDIT_SERVICE

**EMPTY_WCH_INLINE_EDIT_SERVICE**: *`object`*

*Defined in services/http/http.inline.edit.service.ts:240*

<a id="empty_wch_inline_edit_service.fromevent"></a>

####  fromEvent

**● fromEvent**: *`function`* =  _dummyFromEvent

*Defined in services/http/http.inline.edit.service.ts:242*

#### Type declaration
▸<`T`>(): `Observable`<`T`>

**Type parameters:**

#### T 

**Returns:** `Observable`<`T`>

___
<a id="empty_wch_inline_edit_service.registercomponent"></a>

####  registerComponent

**● registerComponent**: *`function`* =  _registerDummyComponent

*Defined in services/http/http.inline.edit.service.ts:241*

#### Type declaration
▸(): `T`

**Returns:** `T`

___

___


<a name="_c842618e34dd28d33eee0ef53a19414267bf6216f7b10fbe2e149ebd086719f9"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/http/index"](#_c842618e34dd28d33eee0ef53a19414267bf6216f7b10fbe2e149ebd086719f9)

# External module: "services/http/index"

## Index

---


<a name="_daa53c792a147345f69b4c54fb7760f0068ff15efd60ccac0c438fdebc6dcfe3"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/index"](#_daa53c792a147345f69b4c54fb7760f0068ff15efd60ccac0c438fdebc6dcfe3)

# External module: "services/index"

## Index

---


<a name="_47c4b3a242e166d237a488877efed5a9cebfbebb8de342e9cfd1eae759af6b92"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/info/index"](#_47c4b3a242e166d237a488877efed5a9cebfbebb8de342e9cfd1eae759af6b92)

# External module: "services/info/index"

## Index

---


<a name="_aff61500799f7dc5efe819712a70ef809adfbcd2593d4eb10ac144bd3f91ddc9"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/info/wch.edit.info.service"](#_aff61500799f7dc5efe819712a70ef809adfbcd2593d4eb10ac144bd3f91ddc9)

# External module: "services/info/wch.edit.info.service"

## Index

### Classes

* [WchEditInfoService](#_1564ff4d4cd398b82cdeb2751f889fe81583cae9622cb0b0aeeeb2ab64f91187)

### Variables

* [LOGGER](#_aff61500799f7dc5efe819712a70ef809adfbcd2593d4eb10ac144bd3f91ddc9)

---

## Variables

<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"WchEditInfoService"* = "WchEditInfoService"

*Defined in services/info/wch.edit.info.service.ts:10*

___


<a name="_0e84db0522a33d94ed0b1a3df6070965c7bbce1bc22c9b7fd77408813813bd26"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/info/wch.internal.edit.service"](#_0e84db0522a33d94ed0b1a3df6070965c7bbce1bc22c9b7fd77408813813bd26)

# External module: "services/info/wch.internal.edit.service"

## Index

### Classes

* [WchInternalEditService](#_ddd8e287b9e638dc495e2d1d59ef526c277973f2d837d5de81b6431106c6878c)

### Variables

* [DEFAULT_EDITING](#_0e84db0522a33d94ed0b1a3df6070965c7bbce1bc22c9b7fd77408813813bd26)
* [DEFAULT_INLINE_EDIT](#_0e84db0522a33d94ed0b1a3df6070965c7bbce1bc22c9b7fd77408813813bd26)

---

## Variables

<a id="default_editing"></a>

### `<Const>` DEFAULT_EDITING

**● DEFAULT_EDITING**: *`false`* = false

*Defined in services/info/wch.internal.edit.service.ts:9*

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

### `<Const>` DEFAULT_INLINE_EDIT

**● DEFAULT_INLINE_EDIT**: *`false`* = false

*Defined in services/info/wch.internal.edit.service.ts:10*

___


<a name="_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/placeholders/placeholders.service"](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)

# External module: "services/placeholders/placeholders.service"

## Index

### Classes

* [WchPlaceholderImpl](#_098cd45a43223772c56114866bee23e21138496184bd59dc62cabc1fb74e0291)
* [WchPlaceholderService](#_39229a2e36bb0275bb7c4d577b1b3f8402800c668745eceac33d769911067967)

### Interfaces

* [WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756)

### Variables

* [LOGGER](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [_selectFromWchPlaceholder](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [opOnAccessor](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [opOnData](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [opOnFormattedText](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [opOnPlaceholder](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [opOnPlainText](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [opOnType](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [selectOnAccessor](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [selectOnData](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [selectOnFormattedText](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [selectOnPlaceholder](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [selectOnPlainText](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)
* [selectOnType](#_83282f2ea80758da0dd4c7d1c854ce5dd48c7bbf460b8229a109158914715837)

---

## Variables

<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"WchPlaceholderImpl"* = "WchPlaceholderImpl"

*Defined in services/placeholders/placeholders.service.ts:94*

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

### `<Const>` _selectFromWchPlaceholder

**● _selectFromWchPlaceholder**: *`function`* =  pluckProperty

*Defined in services/placeholders/placeholders.service.ts:339*

some type magic

#### Type declaration
▸<`K`>(aKey: *`K`*): `UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `WchPlaceholder[K]`>

**Type parameters:**

#### K :  `keyof WchPlaceholder`
**Parameters:**

| Name | Type |
| ------ | ------ |
| aKey | `K` |

**Returns:** `UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `WchPlaceholder[K]`>

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

### `<Const>` opOnAccessor

**● opOnAccessor**: *`OperatorFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `string`>* =  switchMap(
  selectOnAccessor
)

*Defined in services/placeholders/placeholders.service.ts:357*

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

### `<Const>` opOnData

**● opOnData**: *`OperatorFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `any`>* =  switchMap(
  selectOnData
)

*Defined in services/placeholders/placeholders.service.ts:364*

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

### `<Const>` opOnFormattedText

**● opOnFormattedText**: *`OperatorFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `LocalizedText`>* =  switchMap(selectOnFormattedText)

*Defined in services/placeholders/placeholders.service.ts:371*

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

### `<Const>` opOnPlaceholder

**● opOnPlaceholder**: *`OperatorFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `AuthoringPlaceholder`>* =  switchMap(selectOnPlaceholder)

*Defined in services/placeholders/placeholders.service.ts:360*

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

### `<Const>` opOnPlainText

**● opOnPlainText**: *`OperatorFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `LocalizedText`>* =  switchMap(selectOnPlainText)

*Defined in services/placeholders/placeholders.service.ts:367*

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

### `<Const>` opOnType

**● opOnType**: *`OperatorFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `string`>* =  switchMap(
  selectOnType
)

*Defined in services/placeholders/placeholders.service.ts:375*

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

### `<Const>` selectOnAccessor

**● selectOnAccessor**: *`UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `Observable`<`string`>>* =  _selectFromWchPlaceholder('onAccessor')

*Defined in services/placeholders/placeholders.service.ts:347*

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

### `<Const>` selectOnData

**● selectOnData**: *`UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `Observable`<`any`>>* =  _selectFromWchPlaceholder('onData')

*Defined in services/placeholders/placeholders.service.ts:349*

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

### `<Const>` selectOnFormattedText

**● selectOnFormattedText**: *`UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `Observable`<`Object`>>* =  _selectFromWchPlaceholder(
  'onFormattedText'
)

*Defined in services/placeholders/placeholders.service.ts:351*

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

### `<Const>` selectOnPlaceholder

**● selectOnPlaceholder**: *`UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `Observable`<`AuthoringPlaceholder`>>* =  _selectFromWchPlaceholder('onPlaceholder')

*Defined in services/placeholders/placeholders.service.ts:348*

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

### `<Const>` selectOnPlainText

**● selectOnPlainText**: *`UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `Observable`<`Object`>>* =  _selectFromWchPlaceholder('onPlainText')

*Defined in services/placeholders/placeholders.service.ts:350*

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

### `<Const>` selectOnType

**● selectOnType**: *`UnaryFunction`<[WchPlaceholder](#_1d005905ce4eb40a6d99e84b7aa8a2adb18c0fa446afc53abdfa9429a3efe756), `Observable`<`string`>>* =  _selectFromWchPlaceholder('onType')

*Defined in services/placeholders/placeholders.service.ts:354*

___


<a name="_5a526e2333bf33a918e3c394bf1257770a7e77a7d71b2dc9c2a1d38d06a2453c"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/rendering/index"](#_5a526e2333bf33a918e3c394bf1257770a7e77a7d71b2dc9c2a1d38d06a2453c)

# External module: "services/rendering/index"

## Index

---


<a name="_0105599e8003a181a8d32360f01b682fabead43d8584b585cd68cc78a998c221"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/rendering/placeholder.interceptor"](#_0105599e8003a181a8d32360f01b682fabead43d8584b585cd68cc78a998c221)

# External module: "services/rendering/placeholder.interceptor"

## Index

### Classes

* [PlaceholderInterceptor](#_b2489c8ee7690d26f16a2887ba209f70aa8029315c2aae8772bffead398a7b5b)

### Variables

* [LOGGER](#_0105599e8003a181a8d32360f01b682fabead43d8584b585cd68cc78a998c221)

---

## Variables

<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"PlaceholderInterceptor"* = "PlaceholderInterceptor"

*Defined in services/rendering/placeholder.interceptor.ts:38*

___


<a name="_c6eb9a2713080936248fdf042051b8768fa50e7be6647933ec8ccf61c230b1eb"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/wch/index"](#_c6eb9a2713080936248fdf042051b8768fa50e7be6647933ec8ccf61c230b1eb)

# External module: "services/wch/index"

## Index

---


<a name="_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/wch/wch.edit.service"](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)

# External module: "services/wch/wch.edit.service"

## Index

### Classes

* [WchEditService](#_12d0f9e1fcaa3c003e857f5f4a565462731a6732896bcaf52c3bd0dedd85269d)

### Variables

* [FALSE_OBSERVABLE](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [LOGGER](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)

### Functions

* [TO_ANONYMOUS](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [TO_FALSE](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [getCurrentTenantUrl](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [getCurrentUserUrl](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [isAuthenticated](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)

### Object literals

* [ANONYMOUS_USER](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [HTTP_WITH_CREDENTIALS](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [JSON_WITHOUT_CREDENTIALS](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)
* [JSON_WITH_CREDENTIALS](#_af4374a0a7e826e53a9c73030607dce3c38676e140a44b879c8ec05ff2b1b666)

---

## Variables

<a id="false_observable"></a>

### `<Const>` FALSE_OBSERVABLE

**● FALSE_OBSERVABLE**: *`Observable`<`boolean`>* =  opFalse

*Defined in services/wch/wch.edit.service.ts:74*

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

### `<Const>` LOGGER

**● LOGGER**: *"WchEditService"* = "WchEditService"

*Defined in services/wch/wch.edit.service.ts:72*

___

## Functions

<a id="to_anonymous"></a>

### `<Const>` TO_ANONYMOUS

▸ **TO_ANONYMOUS**(): `Observable`<`User`>

*Defined in services/wch/wch.edit.service.ts:76*

**Returns:** `Observable`<`User`>

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

### `<Const>` TO_FALSE

▸ **TO_FALSE**(): `Observable`<`boolean`>

*Defined in services/wch/wch.edit.service.ts:75*

**Returns:** `Observable`<`boolean`>

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

### `<Const>` getCurrentTenantUrl

▸ **getCurrentTenantUrl**(aBase: *`string`*): `string`

*Defined in services/wch/wch.edit.service.ts:90*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aBase | `string` |

**Returns:** `string`

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

### `<Const>` getCurrentUserUrl

▸ **getCurrentUserUrl**(aBase: *`string`*): `string`

*Defined in services/wch/wch.edit.service.ts:89*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aBase | `string` |

**Returns:** `string`

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

### `<Const>` isAuthenticated

▸ **isAuthenticated**(aUser: *`User`*): `boolean`

*Defined in services/wch/wch.edit.service.ts:94*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aUser | `User` |

**Returns:** `boolean`

___

## Object literals

<a id="anonymous_user"></a>

### `<Const>` ANONYMOUS_USER

**ANONYMOUS_USER**: *`object`*

*Defined in services/wch/wch.edit.service.ts:66*

<a id="anonymous_user.externalid"></a>

####  externalId

**● externalId**: *`string`* = "ibm_anonymous_user@de.ibm.com"

*Defined in services/wch/wch.edit.service.ts:69*

___
<a id="anonymous_user.id"></a>

####  id

**● id**: *`string`* = "00000000-0000-f000-0000-000000000000"

*Defined in services/wch/wch.edit.service.ts:67*

___
<a id="anonymous_user.roles"></a>

####  roles

**● roles**: *`undefined`[]* =  []

*Defined in services/wch/wch.edit.service.ts:68*

___

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

### `<Const>` HTTP_WITH_CREDENTIALS

**HTTP_WITH_CREDENTIALS**: *`object`*

*Defined in services/wch/wch.edit.service.ts:78*

<a id="http_with_credentials.withcredentials"></a>

####  withCredentials

**● withCredentials**: *`true`* = true

*Defined in services/wch/wch.edit.service.ts:78*

___

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

### `<Const>` JSON_WITHOUT_CREDENTIALS

**JSON_WITHOUT_CREDENTIALS**: *`object`*

*Defined in services/wch/wch.edit.service.ts:83*

<a id="json_without_credentials.responsetype"></a>

####  responseType

**● responseType**: *"json"* = "json"

*Defined in services/wch/wch.edit.service.ts:86*

___
<a id="json_without_credentials.withcredentials-1"></a>

####  withCredentials

**● withCredentials**: *`false`* = false

*Defined in services/wch/wch.edit.service.ts:86*

___

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

### `<Const>` JSON_WITH_CREDENTIALS

**JSON_WITH_CREDENTIALS**: *`object`*

*Defined in services/wch/wch.edit.service.ts:79*

<a id="json_with_credentials.responsetype-1"></a>

####  responseType

**● responseType**: *"json"* = "json"

*Defined in services/wch/wch.edit.service.ts:82*

___
<a id="json_with_credentials.withcredentials-2"></a>

####  withCredentials

**● withCredentials**: *`true`* = true

*Defined in services/wch/wch.edit.service.ts:82*

___

___


<a name="_ea7ca3750272a67afce0dc4ec5a17e56ff64c1aff5c8fdfd7ea4c97c427e1035"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["utils/assert"](#_ea7ca3750272a67afce0dc4ec5a17e56ff64c1aff5c8fdfd7ea4c97c427e1035)

# External module: "utils/assert"

## Index

### Functions

* [_assert](#_ea7ca3750272a67afce0dc4ec5a17e56ff64c1aff5c8fdfd7ea4c97c427e1035)

---

## Functions

<a id="_assert"></a>

###  _assert

▸ **_assert**<`T`>(aPredicate: *`function`*, aFailHandler: *`function`*): `function`

*Defined in utils/assert.ts:3*

**Type parameters:**

#### T 
**Parameters:**

| Name | Type |
| ------ | ------ |
| aPredicate | `function` |
| aFailHandler | `function` |

**Returns:** `function`

___


<a name="_7579a88bcba5129ee04566b77f62adc9b6550ffeea53303c012dac3691cf0af6"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["utils/config"](#_7579a88bcba5129ee04566b77f62adc9b6550ffeea53303c012dac3691cf0af6)

# External module: "utils/config"

## Index

### Functions

* [loadWchConfig](#_7579a88bcba5129ee04566b77f62adc9b6550ffeea53303c012dac3691cf0af6)

---

## Functions

<a id="loadwchconfig"></a>

###  loadWchConfig

▸ **loadWchConfig**(aJsonp: *`WchHttpService`*): `Observable`<`WchConfig`>

*Defined in utils/config.ts:16*

Loads the WCH config

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aJsonp | `WchHttpService` |  the JSONp callback |

**Returns:** `Observable`<`WchConfig`>
the resulting config object

___


<a name="_d5d8e8d0a5717fd5339c0be60b49cc95458277322f9602af09910bdc911c713b"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["utils/events"](#_d5d8e8d0a5717fd5339c0be60b49cc95458277322f9602af09910bdc911c713b)

# External module: "utils/events"

## Index

### Functions

* [_createWchEditableEvent](#_d5d8e8d0a5717fd5339c0be60b49cc95458277322f9602af09910bdc911c713b)
* [_registerForEvent](#_d5d8e8d0a5717fd5339c0be60b49cc95458277322f9602af09910bdc911c713b)
* [createWchEditableEvents](#_d5d8e8d0a5717fd5339c0be60b49cc95458277322f9602af09910bdc911c713b)

---

## Functions

<a id="_createwcheditableevent"></a>

###  _createWchEditableEvent

▸ **_createWchEditableEvent**(aType: *`string`*, aTarget: *`HTMLElement`*, aData: *`any`*): `WchEditableEvent`

*Defined in utils/events.ts:18*

Constructs the event

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aType | `string` |  the event type |
| aTarget | `HTMLElement` |  the target node |
| aData | `any` |  the event data |

**Returns:** `WchEditableEvent`
the event object

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

###  _registerForEvent

▸ **_registerForEvent**(aType: *`string`*, aTarget: *`HTMLElement`*, aEmitter: *`EventTargetLike`<`any`>*, aLogger: *`Logger`*): `Observable`<`WchEditableEvent`>

*Defined in utils/events.ts:41*

Registers for an event

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aType | `string` |  the event type |
| aTarget | `HTMLElement` |  the current element |
| aEmitter | `EventTargetLike`<`any`> |  the event emitter |
| aLogger | `Logger` |

**Returns:** `Observable`<`WchEditableEvent`>
the sequence of events

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

###  createWchEditableEvents

▸ **createWchEditableEvents**(aTarget: *`HTMLElement`*, aEmitter: *`EventTargetLike`<`any`>*, aLogger: *`Logger`*): `Observable`<`WchEditableEvent`>

*Defined in utils/events.ts:67*

Construct the event stream

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aTarget | `HTMLElement` |  the target element |
| aEmitter | `EventTargetLike`<`any`> |  the event emitter |
| aLogger | `Logger` |

**Returns:** `Observable`<`WchEditableEvent`>
the event stream

___


<a name="_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060"></a>
[@ibm-wch-sdk/ng-edit](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["utils/placeholder"](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)

# External module: "utils/placeholder"

## Index

### Type aliases

* [WchDefaultPlaceholder](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [WchEditableFormat](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)

### Variables

* [UNDEFINED](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [WCH_EDITABLE_AUTO_FORMAT](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [WCH_EDITABLE_HTML_FORMAT](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [WCH_EDITABLE_TEXT_FORMAT](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phParseExpression](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)

### Functions

* [_anyToString](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [_formatFromType](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [_missingPlaceholderText](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [_phEscapedText](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [_phGetDefault](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [_phGetLocalizedText](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [_phGetStaticDefault](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [_showPlaceholder](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phDefaultPlaceholderText](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phFormat](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phFormattedText](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phPlaceholderFromAccessor](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phPlainText](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phShowPlaceholder](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)
* [phTypeFromAccessor](#_33e52481b7361b5664490c37c64d640cfcf494a4301f481aab5c8e5955343060)

---

## Type aliases

<a id="wchdefaultplaceholder"></a>

###  WchDefaultPlaceholder

**Ƭ WchDefaultPlaceholder**: *`ObservableOrT`<`string` \| `LocalizedText`>*

*Defined in utils/placeholder.ts:43*

type for placeholder

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

###  WchEditableFormat

**Ƭ WchEditableFormat**: *"text" \| "html" \| "auto"*

*Defined in utils/placeholder.ts:50*

Potential values for the 'wchFormat' field

___

## Variables

<a id="undefined"></a>

### `<Const>` UNDEFINED

**● UNDEFINED**: *`any`* =  undefined

*Defined in utils/placeholder.ts:56*

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

### `<Const>` WCH_EDITABLE_AUTO_FORMAT

**● WCH_EDITABLE_AUTO_FORMAT**: *"auto"* = "auto"

*Defined in utils/placeholder.ts:53*

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

### `<Const>` WCH_EDITABLE_HTML_FORMAT

**● WCH_EDITABLE_HTML_FORMAT**: *"html"* = "html"

*Defined in utils/placeholder.ts:54*

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

### `<Const>` WCH_EDITABLE_TEXT_FORMAT

**● WCH_EDITABLE_TEXT_FORMAT**: *"text"* = "text"

*Defined in utils/placeholder.ts:52*

___
<a id="phparseexpression"><