BlockSuite API Documentation / @blocksuite/affine-block-surface / RoughCanvas

Class: RoughCanvas

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:11

Constructors

new RoughCanvas()

new RoughCanvas(canvas, config?): RoughCanvas

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:22

Parameters

canvas

HTMLCanvasElement

config?

Config

Returns

RoughCanvas

Accessors

generator

Get Signature

get generator(): RoughGenerator

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:18

Returns

RoughGenerator

Methods

arc()

arc(x, y, width, height, start, stop, closed, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:89

Parameters

x

number

y

number

width

number

height

number

start

number

stop

number

closed

boolean = false

options?

Options

Returns

Drawable

---

circle()

circle(x, y, diameter, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:104

Parameters

x

number

y

number

diameter

number

options?

Options

Returns

Drawable

---

curve()

curve(points, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:110

Parameters

points

Point[]

options?

Options

Returns

Drawable

---

draw()

draw(drawable): void

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:116

Parameters

drawable

Drawable

Returns

void

---

ellipse()

ellipse(x, y, width, height, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:157

Parameters

x

number

y

number

width

number

height

number

options?

Options

Returns

Drawable

---

getDefaultOptions()

getDefaultOptions(): ResolvedOptions

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:169

Returns

ResolvedOptions

---

line()

line(x1, y1, x2, y2, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:173

Parameters

x1

number

y1

number

x2

number

y2

number

options?

Options

Returns

Drawable

---

linearPath()

linearPath(points, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:185

Parameters

points

Point[]

options?

Options

Returns

Drawable

---

path()

path(d, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:191

Parameters

d

string

options?

Options

Returns

Drawable

---

polygon()

polygon(points, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:197

Parameters

points

Point[]

options?

Options

Returns

Drawable

---

rectangle()

rectangle(x, y, width, height, options?): Drawable

Defined in: packages/affine/blocks/block-surface/src/utils/rough/canvas.ts:203

Parameters

x

number

y

number

width

number

height

number

options?

Options

Returns

Drawable