BaseBrush
Defined in: src/brushes/BaseBrush.ts:10
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseBrush(
canvas):BaseBrush
Defined in: src/brushes/BaseBrush.ts:75
Parameters
Section titled “Parameters”canvas
Section titled “canvas”Returns
Section titled “Returns”BaseBrush
Properties
Section titled “Properties”canvas
Section titled “canvas”canvas:
Canvas
Defined in: src/brushes/BaseBrush.ts:73
add type
color:
string='rgb(0, 0, 0)'
Defined in: src/brushes/BaseBrush.ts:16
Color of a brush
Default
Section titled “Default”limitedToCanvasSize
Section titled “limitedToCanvasSize”limitedToCanvasSize:
boolean=false
Defined in: src/brushes/BaseBrush.ts:68
When true, the free drawing is limited to the whiteboard size. Default to false.
Default
Section titled “Default”falseshadow
Section titled “shadow”shadow:
null|Shadow=null
Defined in: src/brushes/BaseBrush.ts:32
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
Section titled “Default”strokeDashArray
Section titled “strokeDashArray”strokeDashArray:
null|number[] =null
Defined in: src/brushes/BaseBrush.ts:60
Stroke Dash Array.
Default
Section titled “Default”strokeLineCap
Section titled “strokeLineCap”strokeLineCap:
CanvasLineCap='round'
Defined in: src/brushes/BaseBrush.ts:39
Line endings style of a brush (one of “butt”, “round”, “square”)
Default
Section titled “Default”strokeLineJoin
Section titled “strokeLineJoin”strokeLineJoin:
CanvasLineJoin='round'
Defined in: src/brushes/BaseBrush.ts:46
Corner style of a brush (one of “bevel”, “round”, “miter”)
Default
Section titled “Default”strokeMiterLimit
Section titled “strokeMiterLimit”strokeMiterLimit:
number=10
Defined in: src/brushes/BaseBrush.ts:53
Maximum miter length (used for strokeLineJoin = “miter”) of a brush’s
Default
Section titled “Default”width:
number=1
Defined in: src/brushes/BaseBrush.ts:23
Width of a brush, has to be a Number, no string literals
Default
Section titled “Default”Methods
Section titled “Methods”_render()
Section titled “_render()”
abstract_render():void
Defined in: src/brushes/BaseBrush.ts:79
Returns
Section titled “Returns”void
onMouseDown()
Section titled “onMouseDown()”
abstractonMouseDown(pointer,ev):void
Defined in: src/brushes/BaseBrush.ts:80
Parameters
Section titled “Parameters”pointer
Section titled “pointer”Returns
Section titled “Returns”void
onMouseMove()
Section titled “onMouseMove()”
abstractonMouseMove(pointer,ev):void
Defined in: src/brushes/BaseBrush.ts:81
Parameters
Section titled “Parameters”pointer
Section titled “pointer”Returns
Section titled “Returns”void
onMouseUp()
Section titled “onMouseUp()”
abstractonMouseUp(ev):boolean|void
Defined in: src/brushes/BaseBrush.ts:85
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean | void
true if brush should continue blocking interaction