BlockSuite API Documentation / @blocksuite/blocks / EdgelessTextBlockModel

Class: EdgelessTextBlockModel

Extends

EdgelessTextBlockModel_base

Implements

GfxElementGeometry

Constructors

new EdgelessTextBlockModel()

new EdgelessTextBlockModel(): EdgelessTextBlockModel

Returns

EdgelessTextBlockModel

Inherited from

EdgelessTextBlockModel_base.constructor

Defined in

packages/affine/model/dist/blocks/edgeless-text/edgeless-text-model.d.ts:26

Properties

[modelLabel]

[modelLabel]: EdgelessTextProps

Inherited from

EdgelessTextBlockModel_base.[modelLabel]

Defined in

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

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

EdgelessTextBlockModel_base.childMap

Defined in

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

color

color: Color

Inherited from

EdgelessTextBlockModel_base.color

Defined in

packages/affine/model/dist/consts/text.d.ts:20

color$

color$: Signal<Color>

Inherited from

EdgelessTextBlockModel_base.color$

connectable

connectable: boolean

Inherited from

EdgelessTextBlockModel_base.connectable

Defined in

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

created

created: Slot<void>

Inherited from

EdgelessTextBlockModel_base.created

Defined in

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

deleted

deleted: Slot<void>

Inherited from

EdgelessTextBlockModel_base.deleted

Defined in

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

flavour

flavour: string

Inherited from

EdgelessTextBlockModel_base.flavour

Defined in

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

fontFamily

fontFamily: FontFamily

Inherited from

EdgelessTextBlockModel_base.fontFamily

Defined in

packages/affine/model/dist/consts/text.d.ts:21

fontFamily$

fontFamily$: Signal<FontFamily>

Inherited from

EdgelessTextBlockModel_base.fontFamily$

fontStyle

fontStyle: FontStyle

Inherited from

EdgelessTextBlockModel_base.fontStyle

Defined in

packages/affine/model/dist/consts/text.d.ts:23

fontStyle$

fontStyle$: Signal<FontStyle>

Inherited from

EdgelessTextBlockModel_base.fontStyle$

fontWeight

fontWeight: FontWeight

Inherited from

EdgelessTextBlockModel_base.fontWeight

Defined in

packages/affine/model/dist/consts/text.d.ts:24

fontWeight$

fontWeight$: Signal<FontWeight>

Inherited from

EdgelessTextBlockModel_base.fontWeight$

hasMaxWidth

hasMaxWidth: boolean

Inherited from

EdgelessTextBlockModel_base.hasMaxWidth

Defined in

packages/affine/model/dist/blocks/edgeless-text/edgeless-text-model.d.ts:9

hasMaxWidth$

hasMaxWidth$: Signal<boolean>

Inherited from

EdgelessTextBlockModel_base.hasMaxWidth$

id

id: string

Inherited from

EdgelessTextBlockModel_base.id

Defined in

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

index

index: string

Inherited from

EdgelessTextBlockModel_base.index

Defined in

packages/affine/model/dist/blocks/edgeless-text/edgeless-text-model.d.ts:6

index$

index$: Signal<string>

Inherited from

EdgelessTextBlockModel_base.index$

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

EdgelessTextBlockModel_base.isEmpty

Defined in

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

keys

keys: string[]

Inherited from

EdgelessTextBlockModel_base.keys

Defined in

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

pop()

pop: (prop) => void

Parameters

Returns

void

Inherited from

EdgelessTextBlockModel_base.pop

Defined in

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

propsUpdated

propsUpdated: Slot<object>

Type declaration

key

key: string

Inherited from

EdgelessTextBlockModel_base.propsUpdated

Defined in

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

role

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

Inherited from

EdgelessTextBlockModel_base.role

Defined in

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

rotate

rotate: number

Inherited from

EdgelessTextBlockModel_base.rotate

Defined in

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

rotate$

rotate$: Signal<number>

Inherited from

EdgelessTextBlockModel_base.rotate$

scale

scale: number

Inherited from

EdgelessTextBlockModel_base.scale

Defined in

packages/affine/model/dist/blocks/edgeless-text/edgeless-text-model.d.ts:7

scale$

scale$: Signal<number>

Inherited from

EdgelessTextBlockModel_base.scale$

stash()

stash: (prop) => void

Parameters

Returns

void

Inherited from

EdgelessTextBlockModel_base.stash

Defined in

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

text?

optional text: Text

Inherited from

EdgelessTextBlockModel_base.text

Defined in

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

textAlign

textAlign: TextAlign

Inherited from

EdgelessTextBlockModel_base.textAlign

Defined in

packages/affine/model/dist/consts/text.d.ts:25

textAlign$

textAlign$: Signal<TextAlign>

Inherited from

EdgelessTextBlockModel_base.textAlign$

version

version: number

Inherited from

EdgelessTextBlockModel_base.version

Defined in

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

xywh

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

Inherited from

EdgelessTextBlockModel_base.xywh

Defined in

packages/affine/model/dist/blocks/edgeless-text/edgeless-text-model.d.ts:5

xywh$

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

Inherited from

EdgelessTextBlockModel_base.xywh$

yBlock

yBlock: YBlock

Inherited from

EdgelessTextBlockModel_base.yBlock

Defined in

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

Accessors

children

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

Returns

BlockModel<object, SignaledProps<object>>[]

Inherited from

EdgelessTextBlockModel_base.children

Defined in

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

doc

get doc(): Doc

set doc(doc): void

Parameters

• doc: Doc

Returns

Doc

Inherited from

EdgelessTextBlockModel_base.doc

Defined in

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

elementBound

get elementBound(): Bound

Returns

Bound

Inherited from

EdgelessTextBlockModel_base.elementBound

Defined in

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

externalBound

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

EdgelessTextBlockModel_base.externalBound

Defined in

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

externalXYWH

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

set externalXYWH(xywh): void

Parameters

• xywh: undefined | `[${number},${number},${number},${number}]`

Returns

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

Inherited from

EdgelessTextBlockModel_base.externalXYWH

Defined in

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

group

get group(): null | SurfaceGroupLikeModel<BaseElementProps>

Returns

null | SurfaceGroupLikeModel<BaseElementProps>

Inherited from

EdgelessTextBlockModel_base.group

Defined in

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

groups

get groups(): SurfaceGroupLikeModel<BaseElementProps>[]

Returns

SurfaceGroupLikeModel<BaseElementProps>[]

Inherited from

EdgelessTextBlockModel_base.groups

Defined in

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

parent

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EdgelessTextBlockModel_base.parent

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

EdgelessTextBlockModel_base.[dispose]

Defined in

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

containsBound()

containsBound(bounds): boolean

Parameters

• bounds: Bound

Returns

boolean

Implementation of

GfxElementGeometry.containsBound

Inherited from

EdgelessTextBlockModel_base.containsBound

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

EdgelessTextBlockModel_base.dispose

Defined in

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

firstChild()

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EdgelessTextBlockModel_base.firstChild

Defined in

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

getLineIntersections()

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

Parameters

• start: IVec

• end: IVec

Returns

null | PointLocation[]

Implementation of

GfxElementGeometry.getLineIntersections

Inherited from

EdgelessTextBlockModel_base.getLineIntersections

Defined in

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

getNearestPoint()

getNearestPoint(point): IVec

Parameters

• point: IVec

Returns

IVec

Implementation of

GfxElementGeometry.getNearestPoint

Inherited from

EdgelessTextBlockModel_base.getNearestPoint

Defined in

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

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

• relativePoint: IVec

Returns

PointLocation

Implementation of

GfxElementGeometry.getRelativePointLocation

Inherited from

EdgelessTextBlockModel_base.getRelativePointLocation

Defined in

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

includesPoint()

includesPoint(x, y, _, __): boolean

Parameters

• x: number

• y: number

• _: PointTestOptions

• __: EditorHost

Returns

boolean

Implementation of

GfxElementGeometry.includesPoint

Inherited from

EdgelessTextBlockModel_base.includesPoint

Defined in

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

intersectsBound()

intersectsBound(bound): boolean

Parameters

• bound: Bound

Returns

boolean

Implementation of

GfxElementGeometry.intersectsBound

Inherited from

EdgelessTextBlockModel_base.intersectsBound

Defined in

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

lastChild()

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EdgelessTextBlockModel_base.lastChild

Defined in

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

Class: EdgelessTextBlockModel ​

Extends ​

Implements ​

Constructors ​

new EdgelessTextBlockModel() ​

Returns ​

Inherited from ​

Defined in ​

Properties ​

[modelLabel] ​

Inherited from ​

Defined in ​

childMap ​

Inherited from ​

Defined in ​

color ​

Inherited from ​

Defined in ​

color$ ​

Inherited from ​

connectable ​

Inherited from ​

Defined in ​

created ​

Inherited from ​

Defined in ​

deleted ​

Inherited from ​

Defined in ​

flavour ​

Inherited from ​

Defined in ​

fontFamily ​

Inherited from ​

Defined in ​

fontFamily$ ​

Inherited from ​

fontStyle ​

Inherited from ​

Defined in ​

fontStyle$ ​

Inherited from ​

fontWeight ​

Inherited from ​

Defined in ​

fontWeight$ ​

Inherited from ​

hasMaxWidth ​

Inherited from ​

Defined in ​

hasMaxWidth$ ​

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 ​

page ​

Deprecated ​

Inherited from ​

Defined in ​

pop() ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

propsUpdated ​

Type declaration ​

key ​

Inherited from ​

Defined in ​

Class: EdgelessTextBlockModel

Extends

Implements

Constructors

new EdgelessTextBlockModel()

Returns

Inherited from

Defined in

Properties

[modelLabel]

Inherited from

Defined in

childMap

Inherited from

Defined in

color

Inherited from

Defined in

color$

Inherited from

connectable

Inherited from

Defined in

created

Inherited from

Defined in

deleted

Inherited from

Defined in

flavour

Inherited from

Defined in

fontFamily

Inherited from

Defined in

fontFamily$

Inherited from

fontStyle

Inherited from

Defined in

fontStyle$

Inherited from

fontWeight

Inherited from

Defined in

fontWeight$

Inherited from

hasMaxWidth

Inherited from

Defined in

hasMaxWidth$

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

page

Deprecated

Inherited from

Defined in

pop()

Parameters

Returns

Inherited from

Defined in

propsUpdated

Type declaration

key

Inherited from

Defined in