Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ImageSketchpad

Index

Classes

Type aliases

Variables

Type aliases

Options

Options: { enabled: boolean; lineCap: CanvasLineCap; lineColor: string; lineJoin: CanvasLineJoin; lineMaxWidth: number; lineMiterLimit: number; lineWidth: number; writeJsonToHtmlAttribute: boolean }

Image sketchpad options.

Type declaration

  • enabled: boolean

    Enable or disable sketchpad on init.

    defaultvalue

    true

  • lineCap: CanvasLineCap

    Line cap.

    defaultvalue

    round

  • lineColor: string

    Line color.

    defaultvalue

    #000

  • lineJoin: CanvasLineJoin

    Line join.

    defaultvalue

    round

  • lineMaxWidth: number

    Line max width.

    defaultvalue

    -1

  • lineMiterLimit: number

    Line miter limit.

    defaultvalue

    10

  • lineWidth: number

    Line width.

    defaultvalue

    5

  • writeJsonToHtmlAttribute: boolean

    Setting this to true(default) will add a data attribute with the sketchpad json data. This is the same string like you would get with ImageSketchpad.toJson().

    defaultvalue

    true

UserOptions

UserOptions: Partial<Options>

Image sketchpad user options setting all properties as not required (Partial).

Variables

Const DefaultOptions

DefaultOptions: Readonly<Options> = ...

Image sketchpad default options.

Generated using TypeDoc