sips-js-api
    Preparing search index...

    Class Output

    The Output represents output file name and format of Canvas.

    Index
    • Output the context to disk with name and optional type (extension or UTI). UTI must inherits public.image.

      Parameters

      • context: Canvas

        The Canvas to output.

      • name: string

        The filename of the output file. It can be either of absolute path or relative path.

      • Optionaltype: (keyof OutputUTIsByFileExtension) | OutputUTI

        The preferred file extension of the output file or UTI. If not specified, the extension of name is used.

      Returns Output

      OutputUTIsByFileExtension for available UTIs and file extensions.

    canvas: Canvas

    The Canvas to output.

    name: string

    The filename of the output file. It can be either of absolute path or relative path.

    The UTI of the output file.

    • Adds the output to the queue to be written to disk.

      Returns void