Skip to content

SprayBrush

Defined in: src/brushes/SprayBrush.ts:31

demo

new SprayBrush(canvas): SprayBrush

Defined in: src/brushes/SprayBrush.ts:77

Constructor

Canvas

SprayBrush

Instance of a spray brush

BaseBrush.constructor

canvas: Canvas

Defined in: src/brushes/BaseBrush.ts:66

add type

BaseBrush.canvas


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

Defined in: src/brushes/BaseBrush.ts:15

Color of a brush

BaseBrush.color


density: number = 20

Defined in: src/brushes/SprayBrush.ts:42

Density of a spray (number of dots per chunk)


dotWidth: number = 1

Defined in: src/brushes/SprayBrush.ts:48

Width of spray dots


dotWidthVariance: number = 1

Defined in: src/brushes/SprayBrush.ts:54

Width variance of spray dots


limitedToCanvasSize: boolean = false

Defined in: src/brushes/BaseBrush.ts:61

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

false

BaseBrush.limitedToCanvasSize


optimizeOverlapping: boolean = true

Defined in: src/brushes/SprayBrush.ts:66

Whether overlapping dots (rectangles) should be removed (for performance reasons)


randomOpacity: boolean = false

Defined in: src/brushes/SprayBrush.ts:60

Whether opacity of a dot should be random


shadow: null | Shadow = null

Defined in: src/brushes/BaseBrush.ts:29

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

BaseBrush.shadow


strokeDashArray: null | number[] = null

Defined in: src/brushes/BaseBrush.ts:53

Stroke Dash Array.

BaseBrush.strokeDashArray


strokeLineCap: CanvasLineCap = 'round'

Defined in: src/brushes/BaseBrush.ts:35

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

BaseBrush.strokeLineCap


strokeLineJoin: CanvasLineJoin = 'round'

Defined in: src/brushes/BaseBrush.ts:41

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

BaseBrush.strokeLineJoin


strokeMiterLimit: number = 10

Defined in: src/brushes/BaseBrush.ts:47

Maximum miter length (used for strokeLineJoin = “miter”) of a brush’s

BaseBrush.strokeMiterLimit


width: number = 10

Defined in: src/brushes/SprayBrush.ts:36

Width of a spray

BaseBrush.width

_render(): void

Defined in: src/brushes/SprayBrush.ts:171

Render all spray chunks

void

BaseBrush._render


addSprayChunk(pointer): void

Defined in: src/brushes/SprayBrush.ts:186

Point

void


onMouseDown(pointer): void

Defined in: src/brushes/SprayBrush.ts:87

Invoked on mouse down

Point

void

BaseBrush.onMouseDown


onMouseMove(pointer): void

Defined in: src/brushes/SprayBrush.ts:100

Invoked on mouse move

Point

void

BaseBrush.onMouseMove


onMouseUp(): void

Defined in: src/brushes/SprayBrush.ts:111

Invoked on mouse up

void

BaseBrush.onMouseUp


renderChunck(sprayChunck): void

Defined in: src/brushes/SprayBrush.ts:153

SprayBrushPoint[]

void