Class BaseBrushAbstract

See

demo

Hierarchy

Constructors

constructor

Properties

canvas color limitedToCanvasSize shadow strokeDashArray strokeLineCap strokeLineJoin strokeMiterLimit width

Methods

_isOutSideCanvas _render _resetShadow _saveAndTransform _setBrushStyles _setShadow needsFullRender onMouseDown onMouseMove onMouseUp

Constructors

constructor

Properties

canvas

canvas: Canvas

Todo

add type

color

color: string = 'rgb(0, 0, 0)'

Color of a brush

Default

limitedToCanvasSize

limitedToCanvasSize: boolean = false

When true, the free drawing is limited to the whiteboard size. Default to false.

Default

false

shadow

shadow: null | Shadow = null

Shadow object representing shadow of this shape. Backwards incompatibility note: This property replaces "shadowColor" (String), "shadowOffsetX" (Number), "shadowOffsetY" (Number) and "shadowBlur" (Number) since v1.2.12

Default

strokeDashArray

strokeDashArray: null | number[] = null

Stroke Dash Array.

Default

strokeLineCap

strokeLineCap: CanvasLineCap = 'round'

Line endings style of a brush (one of "butt", "round", "square")

Default

strokeLineJoin

strokeLineJoin: CanvasLineJoin = 'round'

Corner style of a brush (one of "bevel", "round", "miter")

Default

strokeMiterLimit

strokeMiterLimit: number = 10

Maximum miter length (used for strokeLineJoin = "miter") of a brush's

Default

width

width: number = 1

Width of a brush, has to be a Number, no string literals

Default

Methods

Private _isOutSideCanvas

  • _isOutSideCanvas(pointer): boolean
  • Private

    Check is pointer is outside canvas boundaries

    Parameters

    Returns boolean

Abstract _render

Private _resetShadow

Private _saveAndTransform

  • _saveAndTransform(ctx): void
  • Private

    Sets the transformation on given context

    Parameters

    • ctx: CanvasRenderingContext2D

      context to render on

    Returns void

Private _setBrushStyles

  • _setBrushStyles(ctx): void
  • Private

    Sets brush styles

    Parameters

    • ctx: CanvasRenderingContext2D

    Returns void

Private _setShadow

Protected needsFullRender

Abstract onMouseDown

Abstract onMouseMove

Abstract onMouseUp

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc