Class Output

The Output represents output file name and format of Canvas.

Constructors

Properties

Methods

Constructors

  • 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.

    • Optional type: (keyof OutputUTIsByFileExtension) | OutputUTI

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

    Returns Output

    See

    OutputUTIsByFileExtension for available UTIs and file extensions.

Properties

The UTI of the output file.

canvas: Canvas

The Canvas to output.

name: string

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

Methods

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

    Returns void

Generated using TypeDoc