UXP Toolkit
    Preparing search index...

    Interface LayerCompCreateOptions

    An object literal can be constructed with any of the following properties and passed to LayerComps.add. As a type, LayerCompCreateOptions can be used in Typescript development.

    const options = { name: "mockup", comment: "First attempt", visibility: true };
    await require('photoshop').app.activeDocument.layerComps.add(options);

    objects/createoptions

    interface LayerCompCreateOptions {
        appearance?: boolean;
        childComp?: boolean;
        comment?: string;
        name?: string;
        position?: boolean;
        visibility?: boolean;
    }
    Index

    Properties

    appearance? childComp? comment? name? position? visibility?

    Properties

    appearance?: boolean

    Record the state of the layers' effects.

    false

    24.0

    childComp?: boolean

    Record the state of any Layer Comps contained in the recorded layers' Smart Objects.

    false

    24.0

    comment?: string

    The comment appears in the Layer Comp Options dialog.

    null

    24.0

    name?: string

    The name shown in the Layer Comps panel. If no value is provided, then a name will be generated following the template, "Layer Comp #".

    -

    24.0

    position?: boolean

    Record the state of the layers' position.

    true

    24.0

    visibility?: boolean

    Record the state of the layers' visibility.

    false

    24.0

    Settings

    Member Visibility

    On This Page

    Properties