Interface ImageLayer

Image layer canvas.

interface ImageLayer {
    name: string;
    size: Size;
    mainCanvas: HTMLCanvasElement;
    backCanvas: HTMLCanvasElement;
    mainCtx: CanvasRenderingContext2D;
    backCtx: CanvasRenderingContext2D;
    paintObjects: PaintObject<PaintObjectType>[];
    clear(clearCache: boolean): void;
    dispose(): void;
    ensureBackground(): Promise<void>;
    merge(): Promise<void>;
    saveToDataURL(): Promise<string>;
    drawObjects(): Promise<void>;
    executeTempPaintCommand(cmd: PaintCommand): void;
    getTempPaintCommands(): PaintCommand[];
    clearTempPaintCommands(): void;
}

Methods

clear

clear(clearCache: boolean): void
Removes everything drawn before on image layer.
Parameters
- clearCache: boolean
  Indicates if should clear cache too.
Returns void

dispose

dispose(): void
Clears all resources and removes image layer.

Returns void

ensureBackground

ensureBackground(): Promise<void>
Draws an original viewer image on image layer.

Returns Promise<void>

merge

merge(): Promise<void>
Merges image layer into original viewer image.

Returns Promise<void>

saveToDataURL

saveToDataURL(): Promise<string>
Clears all resources and removes image layer.

Returns Promise<string>
Promise with string that contains dataUrl

drawObjects

drawObjects(): Promise<void>
Call this method to draw the paint objects specified in the paintObjects array onto the canvas.

Returns Promise<void>

executeTempPaintCommand

executeTempPaintCommand(cmd: PaintCommand): void
Run a temporary paint command on a separate temporary canvas layer. This method should create and display the temporary canvas layer if it doesn't exist.
Parameters
- cmd: PaintCommand
Returns void

getTempPaintCommands

getTempPaintCommands(): PaintCommand[]
Get all temporary paint commands.

Returns PaintCommand[]

clearTempPaintCommands

clearTempPaintCommands(): void
Clear all temporary paint commands, clear and dispose the temporary canvas layer.

Returns void

Properties

name

name: string

Image layer name.

`Readonly`size

size: Size

Image layer size.

`Readonly`mainCanvas

mainCanvas: HTMLCanvasElement

Canvas object to paint.

`Readonly`backCanvas

backCanvas: HTMLCanvasElement

Canvas object to paint.

`Readonly`mainCtx

mainCtx: CanvasRenderingContext2D

Main 2D rendering context.

`Readonly`backCtx

backCtx: CanvasRenderingContext2D

Background 2D rendering context.

`Readonly`paintObjects

paintObjects: PaintObject<PaintObjectType>[]

The objects in this array are drawn to the canvas.