@acoustic-content-sdk/ng-edit

Module to attach inline-edit functionality to an WCH based Angular application.

API Documentation

ng-edit package

Module to attach inline-edit functionality to an WCH based Angular application.

Classes

Class	Description
AcNgEditableDirectiveModule	Module implementing the `WchEditableDirectiveService` for the edit case
AcNgEditablePlaceholderDirectiveModule	Module implementing the `WchEditableDirectiveService` for the edit case
AcNgEditComponentsModule	Exports the components and directives used to attach inline edit to code level angular components.
AcNgEditDirectivesModule	Exports the services required to implement the editable directives
AcNgHttpInlineEditProviderModule	Provides token `ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER`
AcNgInlineEditSelectionModule
AcNgInlineEditServiceModule	Provides token `ACOUSTIC_TOKEN_INLINE_EDIT_SERVICE` requires a `ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER` for the backend
AcNgParentInlineEditProviderModule	Exposes the inline edit provider `ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER` from the parent frame. The provider must have been exposed via the `INLINE_EDIT_PROVIDER_ID` constant on that window.Depends on: `ACOUSTIC_TOKEN_EDIT_HOST_WINDOW`, `ACOUSTIC_TOKEN_LOGGER_SERVICE`
AcNgSelectableDirectiveModule	Module implementing the `WchSelectableDirectiveService` for the edit case

Functions

Function	Description
getInlineEditProvider(aHostWindow, aLogSvc)	Accesses the `WchInlineEditProviderV2` from another window. This other window must be enabled for cross frame access. The provider must be available via the `INLINE_EDIT_PROVIDER_ID` key on that window.
internalGetInlineEditProvider(aHostWindow, logger)	Accesses the `WchInlineEditProviderV2` from another window. This other window must be enabled for cross frame access.

Variables

Variable	Description
VERSION	Version and build number of the package

Home > @acoustic-content-sdk/ng-edit > AcNgEditableDirectiveModule

AcNgEditableDirectiveModule class

Module implementing the WchEditableDirectiveService for the edit case

Signature:

export declare class AcNgEditableDirectiveModule

Home > @acoustic-content-sdk/ng-edit > AcNgEditablePlaceholderDirectiveModule

AcNgEditablePlaceholderDirectiveModule class

Module implementing the WchEditableDirectiveService for the edit case

Signature:

export declare class AcNgEditablePlaceholderDirectiveModule

Home > @acoustic-content-sdk/ng-edit > AcNgEditComponentsModule

AcNgEditComponentsModule class

Exports the components and directives used to attach inline edit to code level angular components.

Signature:

export declare class AcNgEditComponentsModule

Constructors

Constructor	Modifiers	Description
(constructor)(aLoggerService)		Constructs a new instance of the `AcNgEditComponentsModule` class

Properties

Property	Modifiers	Type	Description
VERSION		`WchSdkVersion`	Exposes the version information of this module

Home > @acoustic-content-sdk/ng-edit > AcNgEditDirectivesModule

AcNgEditDirectivesModule class

Exports the services required to implement the editable directives

Signature:

export declare class AcNgEditDirectivesModule

Constructors

Constructor	Modifiers	Description
(constructor)(aLoggerService)		Constructs a new instance of the `AcNgEditDirectivesModule` class

Home > @acoustic-content-sdk/ng-edit > AcNgHttpInlineEditProviderModule

AcNgHttpInlineEditProviderModule class

Provides token ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER

Signature:

export declare class AcNgHttpInlineEditProviderModule

Home > @acoustic-content-sdk/ng-edit > AcNgInlineEditSelectionModule

AcNgInlineEditSelectionModule class

Signature:

export declare class AcNgInlineEditSelectionModule

Constructors

Constructor	Modifiers	Description
(constructor)(aSelService)		Constructs a new instance of the `AcNgInlineEditSelectionModule` class

Home > @acoustic-content-sdk/ng-edit > AcNgInlineEditServiceModule

AcNgInlineEditServiceModule class

Provides token ACOUSTIC_TOKEN_INLINE_EDIT_SERVICE requires a ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER for the backend

Signature:

export declare class AcNgInlineEditServiceModule

Constructors

Constructor	Modifiers	Description
(constructor)(aInlineEditService, aSelectedCellConsumer, aLoggerService)		Constructs a new instance of the `AcNgInlineEditServiceModule` class

Home > @acoustic-content-sdk/ng-edit > AcNgParentInlineEditProviderModule

AcNgParentInlineEditProviderModule class

Exposes the inline edit provider ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER from the parent frame. The provider must have been exposed via the INLINE_EDIT_PROVIDER_ID constant on that window.

Depends on: ACOUSTIC_TOKEN_EDIT_HOST_WINDOW, ACOUSTIC_TOKEN_LOGGER_SERVICE

Signature:

export declare class AcNgParentInlineEditProviderModule

Constructors

Constructor	Modifiers	Description
(constructor)(aLoggerService)		Constructs a new instance of the `AcNgParentInlineEditProviderModule` class

Home > @acoustic-content-sdk/ng-edit > AcNgSelectableDirectiveModule

AcNgSelectableDirectiveModule class

Module implementing the WchSelectableDirectiveService for the edit case

Signature:

export declare class AcNgSelectableDirectiveModule

Home > @acoustic-content-sdk/ng-edit > getInlineEditProvider

getInlineEditProvider() function

Accesses the WchInlineEditProviderV2 from another window. This other window must be enabled for cross frame access. The provider must be available via the INLINE_EDIT_PROVIDER_ID key on that window.

Signature:

export declare function getInlineEditProvider(aHostWindow: WindowType, aLogSvc: LoggerService): Observable<WchInlineEditProviderV2>;

Parameters

Parameter	Type	Description
aHostWindow	`WindowType`	the parent window
aLogSvc	`LoggerService`	logger

Returns:

Observable<WchInlineEditProviderV2>

an observable of the inline edit provider

Home > @acoustic-content-sdk/ng-edit > internalGetInlineEditProvider

internalGetInlineEditProvider() function

Accesses the WchInlineEditProviderV2 from another window. This other window must be enabled for cross frame access.

Signature:

export declare function internalGetInlineEditProvider(aHostWindow: WindowType, logger: Logger): Observable<WchInlineEditProviderV2>;

Parameters

Parameter	Type	Description
aHostWindow	`WindowType`	the parent window
logger	`Logger`	logger

Returns:

Observable<WchInlineEditProviderV2>

an observable of the inline edit provider

Home > @acoustic-content-sdk/ng-edit > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/ng-edit > AcNgEditDirectivesModule > (constructor)

AcNgEditDirectivesModule.(constructor)

Constructs a new instance of the AcNgEditDirectivesModule class

Signature:

constructor(aLoggerService: LoggerService);

Parameters

Parameter	Type	Description
aLoggerService	`LoggerService`

Home > @acoustic-content-sdk/ng-edit > AcNgEditComponentsModule > (constructor)

AcNgEditComponentsModule.(constructor)

Constructs a new instance of the AcNgEditComponentsModule class

Signature:

constructor(aLoggerService: LoggerService);

Parameters

Parameter	Type	Description
aLoggerService	`LoggerService`

Home > @acoustic-content-sdk/ng-edit > AcNgEditComponentsModule > VERSION

AcNgEditComponentsModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;

Home > @acoustic-content-sdk/ng-edit > AcNgInlineEditSelectionModule > (constructor)

AcNgInlineEditSelectionModule.(constructor)

Constructs a new instance of the AcNgInlineEditSelectionModule class

Signature:

constructor(aSelService: WchInlineEditSelectionService);

Parameters

Parameter	Type	Description
aSelService	`WchInlineEditSelectionService`

Home > @acoustic-content-sdk/ng-edit > AcNgInlineEditServiceModule > (constructor)

AcNgInlineEditServiceModule.(constructor)

Constructs a new instance of the AcNgInlineEditServiceModule class

Signature:

constructor(aInlineEditService: WchInlineEditServiceV2, aSelectedCellConsumer?: Consumer<string>, aLoggerService?: LoggerService);

Parameters

Parameter	Type	Description
aInlineEditService	`WchInlineEditServiceV2`
aSelectedCellConsumer	`Consumer<string>`
aLoggerService	`LoggerService`

Home > @acoustic-content-sdk/ng-edit > AcNgParentInlineEditProviderModule > (constructor)

AcNgParentInlineEditProviderModule.(constructor)

Constructs a new instance of the AcNgParentInlineEditProviderModule class

Signature:

constructor(aLoggerService: LoggerService);

Parameters

Parameter	Type	Description
aLoggerService	`LoggerService`

@acoustic-content-sdk/ng-edit

Table of Contents

ng-edit package

Classes

Functions

Variables

AcNgEditableDirectiveModule class

AcNgEditablePlaceholderDirectiveModule class

AcNgEditComponentsModule class

Constructors

Properties

AcNgEditDirectivesModule class

Constructors

AcNgHttpInlineEditProviderModule class

AcNgInlineEditSelectionModule class

Constructors

AcNgInlineEditServiceModule class

Constructors

AcNgParentInlineEditProviderModule class

Constructors

AcNgSelectableDirectiveModule class

getInlineEditProvider() function

Parameters

internalGetInlineEditProvider() function

Parameters

VERSION variable

AcNgEditDirectivesModule.(constructor)

Parameters

AcNgEditComponentsModule.(constructor)

Parameters

AcNgEditComponentsModule.VERSION property

AcNgInlineEditSelectionModule.(constructor)

Parameters

AcNgInlineEditServiceModule.(constructor)

Parameters

AcNgParentInlineEditProviderModule.(constructor)

Parameters

Readme

Keywords

Package Sidebar

Install

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

Weekly Downloads