BlockSuite API Documentation / @blocksuite/blocks / NoteBlockModel

Class: NoteBlockModel

Extends

NoteBlockModel_base

Implements

GfxElementGeometry

Constructors

new NoteBlockModel()

new NoteBlockModel(): NoteBlockModel

Returns

NoteBlockModel

Inherited from

NoteBlockModel_base.constructor

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:43

Properties

[modelLabel]

[modelLabel]: NoteProps

Inherited from

NoteBlockModel_base.[modelLabel]

Defined in

packages/framework/store/dist/schema/base.d.ts:115

background

background: Color

Inherited from

NoteBlockModel_base.background

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:18

background$

background$: Signal<Color>

Inherited from

NoteBlockModel_base.background$

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

NoteBlockModel_base.childMap

Defined in

packages/framework/store/dist/schema/base.d.ts:108

connectable

connectable: boolean

Inherited from

NoteBlockModel_base.connectable

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:33

created

created: Slot<void>

Inherited from

NoteBlockModel_base.created

Defined in

packages/framework/store/dist/schema/base.d.ts:109

deleted

deleted: Slot<void>

Inherited from

NoteBlockModel_base.deleted

Defined in

packages/framework/store/dist/schema/base.d.ts:110

displayMode

displayMode: NoteDisplayMode

Inherited from

NoteBlockModel_base.displayMode

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:19

displayMode$

displayMode$: Signal<NoteDisplayMode>

Inherited from

NoteBlockModel_base.displayMode$

edgeless

edgeless: NoteEdgelessProps

Inherited from

NoteBlockModel_base.edgeless

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:20

edgeless$

edgeless$: Signal<NoteEdgelessProps>

Inherited from

NoteBlockModel_base.edgeless$

flavour

flavour: string

Inherited from

NoteBlockModel_base.flavour

Defined in

packages/framework/store/dist/schema/base.d.ts:111

hidden

hidden: boolean

Deprecated

use displayMode instead hidden:true -> displayMode:NoteDisplayMode.EdgelessOnly: means the note is visible only in the edgeless mode hidden:false -> displayMode:NoteDisplayMode.DocAndEdgeless: means the note is visible in the doc and edgeless mode

Inherited from

NoteBlockModel_base.hidden

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:29

hidden$

hidden$: Signal<boolean>

Inherited from

NoteBlockModel_base.hidden$

id

id: string

Inherited from

NoteBlockModel_base.id

Defined in

packages/framework/store/dist/schema/base.d.ts:112

index

index: string

Inherited from

NoteBlockModel_base.index

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:13

index$

index$: Signal<string>

Inherited from

NoteBlockModel_base.index$

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

NoteBlockModel_base.isEmpty

Defined in

packages/framework/store/dist/schema/base.d.ts:113

keys

keys: string[]

Inherited from

NoteBlockModel_base.keys

Defined in

packages/framework/store/dist/schema/base.d.ts:114

lockedBySelf?

optional lockedBySelf: boolean

Inherited from

NoteBlockModel_base.lockedBySelf

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:14

lockedBySelf$

lockedBySelf$: Signal<undefined | boolean>

Inherited from

NoteBlockModel_base.lockedBySelf$

pop()

pop: (prop) => void

Parameters

prop

Returns

void

Inherited from

NoteBlockModel_base.pop

Defined in

packages/framework/store/dist/schema/base.d.ts:116

propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

NoteBlockModel_base.propsUpdated

Defined in

packages/framework/store/dist/schema/base.d.ts:117

responseExtension

responseExtension: [number, number]

Defines the extension of the response area beyond the element's bounding box. This tuple specifies the horizontal and vertical margins to be added to the element's [x, y, width, height].

The first value represents the horizontal extension (added to both left and right sides), and the second value represents the vertical extension (added to both top and bottom sides).

The response area is computed as: [x - horizontal, y - vertical, width + 2 * horizontal, height + 2 * vertical].

Example:

Bounding box: [0, 0, 100, 100], responseExtension: [10, 20] Resulting response area: [-10, -20, 120, 140].
responseExtension: [0, 0] keeps the response area equal to the bounding box.

Inherited from

NoteBlockModel_base.responseExtension

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:49

role

role: "root" | "hub" | "content"

Inherited from

NoteBlockModel_base.role

Defined in

packages/framework/store/dist/schema/base.d.ts:120

rotate

rotate: number

Inherited from

NoteBlockModel_base.rotate

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:50

stash()

stash: (prop) => void

Parameters

prop

Returns

void

Inherited from

NoteBlockModel_base.stash

Defined in

packages/framework/store/dist/schema/base.d.ts:121

text?

optional text: Text

Inherited from

NoteBlockModel_base.text

Defined in

packages/framework/store/dist/schema/base.d.ts:122

version

version: number

Inherited from

NoteBlockModel_base.version

Defined in

packages/framework/store/dist/schema/base.d.ts:123

xywh

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

Inherited from

NoteBlockModel_base.xywh

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:12

xywh$

xywh$: Signal<`[${number},${number},${number},${number}]`>

Inherited from

NoteBlockModel_base.xywh$

yBlock

yBlock: YBlock

Inherited from

NoteBlockModel_base.yBlock

Defined in

packages/framework/store/dist/schema/base.d.ts:124

Accessors

children

Get Signature

get children(): BlockModel<object, SignaledProps<object>>[]

Returns

BlockModel<object, SignaledProps<object>>[]

Inherited from

NoteBlockModel_base.children

Defined in

packages/framework/store/dist/schema/base.d.ts:125

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

NoteBlockModel_base.deserializedXYWH

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:51

doc

Get Signature

get doc(): Doc

Returns

Doc

Set Signature

set doc(doc): void

Parameters

doc

Doc

Returns

void

Inherited from

NoteBlockModel_base.doc

Defined in

packages/framework/store/dist/schema/base.d.ts:126

elementBound

Get Signature

get elementBound(): Bound

The bound of the element without considering the response extension.

Returns

Bound

Inherited from

NoteBlockModel_base.elementBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:52

externalBound

Get Signature

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

NoteBlockModel_base.externalBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:53

externalXYWH

Get Signature

get externalXYWH(): undefined | `[${number},${number},${number},${number}]`

Returns

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

Set Signature

set externalXYWH(xywh): void

Parameters

xywh

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

Returns

void

Inherited from

NoteBlockModel_base.externalXYWH

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:54

group

Get Signature

get group(): null | GfxGroupModel

Returns

null | GfxGroupModel

Inherited from

NoteBlockModel_base.group

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:56

groups

Get Signature

get groups(): GfxGroupModel[]

Returns

GfxGroupModel[]

Inherited from

NoteBlockModel_base.groups

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:57

h

Get Signature

get h(): number

Returns

number

Inherited from

NoteBlockModel_base.h

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:58

parent

Get Signature

get parent(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

NoteBlockModel_base.parent

Defined in

packages/framework/store/dist/schema/base.d.ts:128

responseBound

Get Signature

get responseBound(): Bound

The bound of the element considering the response extension.

Returns

Bound

Inherited from

NoteBlockModel_base.responseBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:59

surface

Get Signature

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

NoteBlockModel_base.surface

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:60

w

Get Signature

get w(): number

Returns

number

Inherited from

NoteBlockModel_base.w

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:61

x

Get Signature

get x(): number

Returns

number

Inherited from

NoteBlockModel_base.x

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:62

y

Get Signature

get y(): number

Returns

number

Inherited from

NoteBlockModel_base.y

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:63

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

NoteBlockModel_base.[dispose]

Defined in

packages/framework/store/dist/schema/base.d.ts:133

containsBound()

containsBound(bounds): boolean

Parameters

bounds

Bound

Returns

boolean

Implementation of

GfxElementGeometry.containsBound

Overrides

NoteBlockModel_base.containsBound

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:47

dispose()

dispose(): void

Returns

void

Inherited from

NoteBlockModel_base.dispose

Defined in

packages/framework/store/dist/schema/base.d.ts:130

firstChild()

firstChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

NoteBlockModel_base.firstChild

Defined in

packages/framework/store/dist/schema/base.d.ts:131

getLineIntersections()

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

Parameters

start

IVec

end

IVec

Returns

null | PointLocation[]

Implementation of

GfxElementGeometry.getLineIntersections

Inherited from

NoteBlockModel_base.getLineIntersections

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:65

getNearestPoint()

getNearestPoint(point): IVec

Parameters

point

IVec

Returns

IVec

Implementation of

GfxElementGeometry.getNearestPoint

Inherited from

NoteBlockModel_base.getNearestPoint

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:66

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

relativePoint

IVec

Returns

PointLocation

Implementation of

GfxElementGeometry.getRelativePointLocation

Inherited from

NoteBlockModel_base.getRelativePointLocation

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:67

includesPoint()

includesPoint(x, y): boolean

Parameters

x

number

y

number

Returns

boolean

Implementation of

GfxElementGeometry.includesPoint

Overrides

NoteBlockModel_base.includesPoint

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:48

intersectsBound()

intersectsBound(bound): boolean

Parameters

bound

Bound

Returns

boolean

Implementation of

GfxElementGeometry.intersectsBound

Overrides

NoteBlockModel_base.intersectsBound

Defined in

packages/affine/model/dist/blocks/note/note-model.d.ts:49

isLocked()

isLocked(): boolean

Check if the element is locked. It will check the lock status of the element and its ancestors.

Returns

boolean

Inherited from

NoteBlockModel_base.isLocked

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:70

isLockedByAncestor()

isLockedByAncestor(): boolean

Returns

boolean

Inherited from

NoteBlockModel_base.isLockedByAncestor

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:71

isLockedBySelf()

isLockedBySelf(): boolean

Returns

boolean

Inherited from

NoteBlockModel_base.isLockedBySelf

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:72

lastChild()

lastChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

NoteBlockModel_base.lastChild

Defined in

packages/framework/store/dist/schema/base.d.ts:132

lock()

lock(): void

Returns

void

Inherited from

NoteBlockModel_base.lock

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:73

unlock()

unlock(): void

Returns

void

Inherited from

NoteBlockModel_base.unlock

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:74

Class: NoteBlockModel ​

Extends ​

Implements ​

Constructors ​

new NoteBlockModel() ​

Returns ​

Inherited from ​

Defined in ​

Properties ​

[modelLabel] ​

Inherited from ​

Defined in ​

background ​

Inherited from ​

Defined in ​

background$ ​

Inherited from ​

childMap ​

Inherited from ​

Defined in ​

connectable ​

Inherited from ​

Defined in ​

created ​

Inherited from ​

Defined in ​

deleted ​

Inherited from ​

Defined in ​

displayMode ​

Inherited from ​

Defined in ​

displayMode$ ​

Inherited from ​

edgeless ​

Inherited from ​

Defined in ​

edgeless$ ​

Inherited from ​

flavour ​

Inherited from ​

Defined in ​

hidden ​

Deprecated ​

Inherited from ​

Defined in ​

hidden$ ​

Inherited from ​

id ​

Inherited from ​

Defined in ​

index ​

Inherited from ​

Defined in ​

index$ ​

Inherited from ​

isEmpty ​

Inherited from ​

Defined in ​

keys ​

Inherited from ​

Defined in ​

lockedBySelf? ​

Inherited from ​

Defined in ​

lockedBySelf$ ​

Inherited from ​

page ​

Deprecated ​

Inherited from ​

Defined in ​

pop() ​

Parameters ​

prop ​

Returns ​

Inherited from ​

Defined in ​

propsUpdated ​

Inherited from ​

Defined in ​

Class: NoteBlockModel

Extends

Implements

Constructors

new NoteBlockModel()

Returns

Inherited from

Defined in

Properties

[modelLabel]

Inherited from

Defined in

background

Inherited from

Defined in

background$

Inherited from

childMap

Inherited from

Defined in

connectable

Inherited from

Defined in

created

Inherited from

Defined in

deleted

Inherited from

Defined in

displayMode

Inherited from

Defined in

displayMode$

Inherited from

edgeless

Inherited from

Defined in

edgeless$

Inherited from

flavour

Inherited from

Defined in

hidden

Deprecated

Inherited from

Defined in

hidden$

Inherited from

id

Inherited from

Defined in

index

Inherited from

Defined in

index$

Inherited from

isEmpty

Inherited from

Defined in

keys

Inherited from

Defined in

lockedBySelf?

Inherited from

Defined in

lockedBySelf$

Inherited from

page

Deprecated

Inherited from

Defined in

pop()

Parameters

prop

Returns

Inherited from

Defined in

propsUpdated

Inherited from

Defined in