BlockSuite API Documentation / @blocksuite/blocks / BrushElement

Class: BrushElement

Contents

• Extends
• Constructors
  • new BrushElement(yMap, options, data)
• Properties
  • _connectable
  • _testCanvas
  • _testCtx
  • computedValue
  • options
  • renderer
  • yMap
• Accessors
  • batch
  • color
  • connectable
  • elementBound
  • h
  • id
  • index
  • lineWidth
  • localRecord
  • points
  • rotate
  • seed
  • type
  • w
  • x
  • xywh
  • y
• Methods
  • applyUpdate()
  • boxSelect()
  • containedByBounds()
  • deserializeXYWH()
  • getLocalRecord()
  • getNearestPoint()
  • getRelativePointLocation()
  • hitTest()
  • init()
  • intersectWithLine()
  • mount()
  • render()
  • serialize()
  • unmount()

Extends

• SurfaceElement<IBrush>

Constructors

new BrushElement(yMap, options, data)

new BrushElement(yMap, options, data): BrushElement

Parameters

• yMap: Map<unknown>

• options: Object

• options.getGroupParent: (element) => GroupElement

• options.getLocalRecord: (id) => undefined | CanvasElementLocalRecordValues

• options.onElementUpdated: (update) => void

• options.pickById: (id) => null | EdgelessElement

• options.removeElement: (id) => void

• options.selectionManager?: EdgelessSelectionManager

• options.setGroupParent: (element, group) => void

• options.updateElementLocalRecord: (id, record) => void

• data: Partial<IBrush>= {}

Returns

BrushElement

Inherited from

SurfaceElement<IBrush>.constructor

Source

packages/blocks/src/surface-block/elements/surface-element.ts:95

Properties

_connectable

protected _connectable: boolean = false

Overrides

SurfaceElement._connectable

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:38

---

_testCanvas

private _testCanvas: HTMLCanvasElement

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:33

---

_testCtx

private _testCtx: CanvasRenderingContext2D

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:34

---

computedValue

computedValue: ComputedValue

Inherited from

SurfaceElement.computedValue

Source

packages/blocks/src/surface-block/elements/surface-element.ts:93

---

options

protected options: Object

Type declaration

getGroupParent

getGroupParent: (element) => GroupElement

Parameters

• element: string | EdgelessElement

Returns

GroupElement

getLocalRecord

getLocalRecord: (id) => undefined | CanvasElementLocalRecordValues

Parameters

• id: string

Returns

undefined | CanvasElementLocalRecordValues

onElementUpdated

onElementUpdated: (update) => void

Parameters

• update: Object

• update.id: string

• update.props: Record<string, unknown>

Returns

void

pickById

pickById: (id) => null | EdgelessElement

Parameters

• id: string

Returns

null | EdgelessElement

removeElement

removeElement: (id) => void

Parameters

• id: string

Returns

void

selectionManager?

selectionManager?: EdgelessSelectionManager

setGroupParent

setGroupParent: (element, group) => void

Parameters

• element: string

• group: GroupElement

Returns

void

updateElementLocalRecord

updateElementLocalRecord: (id, record) => void

Parameters

• id: string

• record: Record<string, unknown>

Returns

void

Inherited from

SurfaceElement.options

Source

packages/blocks/src/surface-block/elements/surface-element.ts:74

---

renderer

protected renderer: null | Renderer = null

Inherited from

SurfaceElement.renderer

Source

packages/blocks/src/surface-block/elements/surface-element.ts:90

---

yMap

yMap: Map<unknown>

Inherited from

SurfaceElement.yMap

Source

packages/blocks/src/surface-block/elements/surface-element.ts:72

Accessors

batch

get batch(): null | NonNullable<T["batch"]>

Returns

null | NonNullable<T["batch"]>

Source

packages/blocks/src/surface-block/elements/surface-element.ts:144

---

color

get color(): string

Returns

string

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:48

---

connectable

get connectable(): boolean

Returns

boolean

Source

packages/blocks/src/surface-block/elements/surface-element.ts:179

---

elementBound

get elementBound(): Bound

Returns

Bound

Source

packages/blocks/src/surface-block/elements/surface-element.ts:148

---

h

get h(): number

Returns

number

Source

packages/blocks/src/surface-block/elements/surface-element.ts:170

---

id

get id(): T["id"]

Returns

T["id"]

Source

packages/blocks/src/surface-block/elements/surface-element.ts:114

---

index

get index(): T["index"]

Returns

T["index"]

Source

packages/blocks/src/surface-block/elements/surface-element.ts:119

---

lineWidth

get lineWidth(): number

Returns

number

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:53

---

localRecord

get localRecord(): undefined | CanvasElementLocalRecordValues

Returns

undefined | CanvasElementLocalRecordValues

Source

packages/blocks/src/surface-block/elements/surface-element.ts:175

---

points

get points(): number[][]

Returns

number[][]

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:41

---

rotate

get rotate(): T["rotate"]

Returns

T["rotate"]

Source

packages/blocks/src/surface-block/elements/surface-element.ts:139

---

seed

get seed(): T["seed"]

Returns

T["seed"]

Source

packages/blocks/src/surface-block/elements/surface-element.ts:134

---

type

get type(): T["type"]

Returns

T["type"]

Source

packages/blocks/src/surface-block/elements/surface-element.ts:124

---

w

get w(): number

Returns

number

Source

packages/blocks/src/surface-block/elements/surface-element.ts:165

---

x

get x(): number

Returns

number

Source

packages/blocks/src/surface-block/elements/surface-element.ts:155

---

xywh

get xywh(): `[${number},${number},${number},${number}]`

Returns

`[${number},${number},${number},${number}]`

Source

packages/blocks/src/surface-block/elements/surface-element.ts:129

---

y

get y(): number

Returns

number

Source

packages/blocks/src/surface-block/elements/surface-element.ts:160

Methods

applyUpdate()

applyUpdate(props): void

Parameters

• props: Partial<IBrush>

Returns

void

Overrides

SurfaceElement.applyUpdate

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:104

---

boxSelect()

boxSelect(bound): boolean

Parameters

• bound: Bound

Returns

boolean

Inherited from

SurfaceElement.boxSelect

Source

packages/blocks/src/surface-block/elements/surface-element.ts:63

---

containedByBounds()

containedByBounds(bounds): boolean

Parameters

• bounds: Bound

Returns

boolean

Overrides

SurfaceElement.containedByBounds

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:155

---

deserializeXYWH()

deserializeXYWH(): XYWH

Returns

XYWH

Inherited from

SurfaceElement.deserializeXYWH

Source

packages/blocks/src/surface-block/elements/surface-element.ts:193

---

getLocalRecord()

getLocalRecord(): ISurfaceElementLocalRecord

Returns

ISurfaceElementLocalRecord

Inherited from

SurfaceElement.getLocalRecord

Source

packages/blocks/src/surface-block/elements/surface-element.ts:183

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

• point: IVec

Returns

IVec

Overrides

SurfaceElement.getNearestPoint

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:160

---

getRelativePointLocation()

getRelativePointLocation(position): PointLocation

Parameters

• position: IVec

Returns

PointLocation

Overrides

SurfaceElement.getRelativePointLocation

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:197

---

hitTest()

hitTest(px, py, options?): boolean

Parameters

• px: number

• py: number

• options?: HitTestOptions

Returns

boolean

Overrides

SurfaceElement.hitTest

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:60

---

init()

init(): void

Returns

void

Inherited from

SurfaceElement.init

Source

packages/blocks/src/surface-block/elements/surface-element.ts:112

---

intersectWithLine()

intersectWithLine(start, end): null | PointLocation[]

Parameters

• start: IVec

• end: IVec

Returns

null | PointLocation[]

Overrides

SurfaceElement.intersectWithLine

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:168

---

mount()

mount(renderer): void

Parameters

• renderer: Renderer

Returns

void

Inherited from

SurfaceElement.mount

Source

packages/blocks/src/surface-block/elements/surface-element.ts:219

---

render()

render(ctx, matrix): void

Parameters

• ctx: CanvasRenderingContext2D

• matrix: DOMMatrix

Returns

void

Overrides

SurfaceElement.render

Source

packages/blocks/src/surface-block/elements/brush/brush-element.ts:86

---

serialize()

serialize(): IBrush

Returns

IBrush

Inherited from

SurfaceElement.serialize

Source

packages/blocks/src/surface-block/elements/surface-element.ts:197

---

unmount()

unmount(): void

Returns

void

Inherited from

SurfaceElement.unmount

Source

packages/blocks/src/surface-block/elements/surface-element.ts:225

---

Generated using typedoc-plugin-markdown and TypeDoc