Interface Configuration

Component configuration.

interface Configuration {
    factoryPid: undefined | string;
    get(key): any;
    pid: string;
    properties: ComponentProperties;
    remove(): void;
    update(properties): void;
}

Properties

factoryPid pid properties

Methods

get remove update

Properties

Readonly factoryPid

factoryPid: undefined | string

Persistent identifier of a factory component.

Readonly pid

pid: string

Persistent identifier.

Readonly properties

properties: ComponentProperties

Configuration properties.

Methods

get

  • get(key): any

  • Parameters

    • key: string

    Returns any

    Deprecated

    use flat properties, e.g. pid or properties directly.

remove

  • remove(): void

  • Removes this configuration.

    Returns void

update

  • update(properties): void

  • Used to update the configuration.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

factoryPidpidpropertiesgetremoveupdate

Generated using TypeDoc