@musallam/photoshop-client
    Preparing search index...

    Interface PsOutputDetails

    An output object.

    interface PsOutputDetails {
        compression?: PhotoshopClient.CompressionType;
        href: string;
        iccProfile?: IccProfileDetails;
        layers?: LayerReference[];
        maxWidth?: number;
        overwrite?: boolean;
        quality?: number;
        storage: PhotoshopClient.StorageType;
        trimToCanvas?: boolean;
        type: PhotoshopClient.ImageFormatType;
        width?: number;
    }
    Index

    Properties

    compression? href iccProfile? layers? maxWidth? overwrite? quality? storage trimToCanvas? type width?

    Properties

    compression?: PhotoshopClient.CompressionType
    href: string

    A pre-signed POST URL to the output file.

    iccProfile?: IccProfileDetails
    layers?: LayerReference[]

    An array of layer objects. By including this array you are signaling that you'd like a rendition created from these layer id's or layer names. Excluding it will generate a document-level rendition.

    maxWidth?: number

    The size, in pixels, of the renditions. When width is 0, maxWidth can be provided to get the rendition size. maxWidth when less than document width gets precedence over width. Height is not necessary as the rendition generate will automatically maintain the aspect ratio.

    overwrite?: boolean

    If the file already exists, indicates if the output file should be overwritten. Will eventually support eTags. Only applies to CC Storage.

    quality?: number

    The quality of the renditions for JPEG. The range is 1 to 7, 7 being the highest quality. 1 7

    storage: PhotoshopClient.StorageType
    trimToCanvas?: boolean
    type: PhotoshopClient.ImageFormatType
    width?: number

    The width, in pixels, of the renditions. A width of 0 generates a full size rendition. Height is generated automatically using the aspect ratio. Only supported for image rendition.

    Settings

    Member Visibility

    On This Page

    Properties