API > @blocksuite/blocks > BrushElement

Class: BrushElement ​

Extends ​

• SurfaceElement< IBrush >

Constructors ​

constructor ​

new BrushElement( yMap, options, data = {}): BrushElement

Parameters ​

Returns ​

BrushElement

Inherited from ​

SurfaceElement<IBrush>.constructor

Defined In ​

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

Properties ​

_connectable ​

protected _connectable: boolean = false

Defined In ​

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

Overrides ​

SurfaceElement._connectable

_testCanvas ​

private _testCanvas: HTMLCanvasElement

Defined In ​

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

_testCtx ​

private _testCtx: CanvasRenderingContext2D

Defined In ​

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

computedValue ​

computedValue: ComputedValue

Defined In ​

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

Inherited from ​

SurfaceElement.computedValue

options ​

protected options: object

Type declaration ​

options.getGroupParent ​

getGroupParent: function

Parameters ​

Parameter	Type
element	string | EdgelessElement

Returns ​

GroupElement

options.getLocalRecord ​

getLocalRecord: function

Parameters ​

Parameter	Type
id	string

Returns ​

undefined | IShapeLocalRecord | ISurfaceElementLocalRecord

options.onElementUpdated ​

onElementUpdated: function

Parameters ​

Parameter	Type
update	object
update.id	string
update.props	object

Returns ​

void

options.pickById ​

pickById: function

Parameters ​

Parameter	Type
id	string

Returns ​

null | EdgelessElement

options.selectionManager ​

optional selectionManager: EdgelessSelectionManager

options.setGroupParent ​

setGroupParent: function

Parameters ​

Parameter	Type
element	string | EdgelessElement
group	GroupElement

Returns ​

void

options.updateElementLocalRecord ​

updateElementLocalRecord: function

Parameters ​

Parameter	Type
id	string
record	Record< string, unknown >

Returns ​

void

Defined In ​

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

Inherited from ​

SurfaceElement.options

renderer ​

protected renderer: null | Renderer = null

Defined In ​

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

Inherited from ​

SurfaceElement.renderer

yMap ​

yMap: Map< unknown >

Defined In ​

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

Inherited from ​

SurfaceElement.yMap

Accessors ​

batch ​

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

Defined In ​

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

Inherited from ​

SurfaceElement.batch

color ​

get color(): string

Defined In ​

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

connectable ​

get connectable(): boolean

Defined In ​

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

Inherited from ​

SurfaceElement.connectable

gridBound ​

get gridBound(): Bound

Defined In ​

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

Inherited from ​

SurfaceElement.gridBound

h ​

get h(): number

Defined In ​

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

Inherited from ​

SurfaceElement.h

id ​

get id(): T["id"]

Defined In ​

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

Inherited from ​

SurfaceElement.id

index ​

get index(): T["index"]

Defined In ​

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

Inherited from ​

SurfaceElement.index

lineWidth ​

get lineWidth(): number

Defined In ​

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

localRecord ​

get localRecord(): undefined | IShapeLocalRecord | ISurfaceElementLocalRecord

Defined In ​

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

Inherited from ​

SurfaceElement.localRecord

points ​

get points(): number[][]

Defined In ​

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

rotate ​

get rotate(): T["rotate"]

Defined In ​

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

Inherited from ​

SurfaceElement.rotate

seed ​

get seed(): T["seed"]

Defined In ​

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

Inherited from ​

SurfaceElement.seed

type ​

get type(): T["type"]

Defined In ​

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

Inherited from ​

SurfaceElement.type

w ​

get w(): number

Defined In ​

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

Inherited from ​

SurfaceElement.w

x ​

get x(): number

Defined In ​

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

Inherited from ​

SurfaceElement.x

xywh ​

get xywh(): T["xywh"]

Defined In ​

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

Inherited from ​

SurfaceElement.xywh

y ​

get y(): number

Defined In ​

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

Inherited from ​

SurfaceElement.y

Methods ​

applyUpdate ​

applyUpdate(props): void

Parameters ​

Returns ​

void

Overrides ​

SurfaceElement.applyUpdate

Defined In ​

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

boxSelect ​

boxSelect(bound): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

SurfaceElement.boxSelect

Defined In ​

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

containedByBounds ​

containedByBounds(bounds): boolean

Parameters ​

Returns ​

boolean

Overrides ​

SurfaceElement.containedByBounds

Defined In ​

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

deserializeXYWH ​

deserializeXYWH(): XYWH

Returns ​

XYWH

Inherited from ​

SurfaceElement.deserializeXYWH

Defined In ​

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

getLocalRecord ​

getLocalRecord(): ISurfaceElementLocalRecord

Returns ​

ISurfaceElementLocalRecord

Inherited from ​

SurfaceElement.getLocalRecord

Defined In ​

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

getNearestPoint ​

getNearestPoint(point): IVec

Parameters ​

Returns ​

IVec

Overrides ​

SurfaceElement.getNearestPoint

Defined In ​

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

getRelativePointLocation ​

getRelativePointLocation(position): PointLocation

Parameters ​

Returns ​

PointLocation

Overrides ​

SurfaceElement.getRelativePointLocation

Defined In ​

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

hitTest ​

hitTest( px, py, options?): boolean

Parameters ​

Returns ​

boolean

Overrides ​

SurfaceElement.hitTest

Defined In ​

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

init ​

init(): void

Returns ​

void

Inherited from ​

SurfaceElement.init

Defined In ​

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

intersectWithLine ​

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

Parameters ​

Returns ​

null | PointLocation[]

Overrides ​

SurfaceElement.intersectWithLine

Defined In ​

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

mount ​

mount(renderer): void

Parameters ​

Returns ​

void

Inherited from ​

SurfaceElement.mount

Defined In ​

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

render ​

render(ctx, matrix): void

Parameters ​

Returns ​

void

Overrides ​

SurfaceElement.render

Defined In ​

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

serialize ​

serialize(): IBrush

Returns ​

IBrush

Inherited from ​

SurfaceElement.serialize

Defined In ​

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

unmount ​

unmount(): void

Returns ​

void

Inherited from ​

SurfaceElement.unmount

Defined In ​

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