BlockSuite API Documentation / @blocksuite/affine-model / EdgelessTextBlockModel

Class: EdgelessTextBlockModel

Extends

EdgelessBlockModel<EdgelessTextProps, this>

Implements

GfxElementGeometry

Constructors

new EdgelessTextBlockModel()

new EdgelessTextBlockModel(): EdgelessTextBlockModel

Returns

EdgelessTextBlockModel

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).constructor

Defined in

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

Properties

[modelLabel]

[modelLabel]: EdgelessTextProps

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).[modelLabel]

Defined in

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

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).childMap

Defined in

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

color

color: Color

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).color

Defined in

packages/affine/model/src/consts/text.ts:26

color$

color$: Signal<Color>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).color$

connectable

connectable: boolean

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).connectable

Defined in

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

created

created: Slot<void>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).created

Defined in

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

deleted

deleted: Slot<void>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).deleted

Defined in

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

flavour

flavour: string

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).flavour

Defined in

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

fontFamily

fontFamily: FontFamily

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).fontFamily

Defined in

packages/affine/model/src/consts/text.ts:27

fontFamily$

fontFamily$: Signal<FontFamily>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).fontFamily$

fontStyle

fontStyle: FontStyle

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).fontStyle

Defined in

packages/affine/model/src/consts/text.ts:29

fontStyle$

fontStyle$: Signal<FontStyle>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).fontStyle$

fontWeight

fontWeight: FontWeight

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).fontWeight

Defined in

packages/affine/model/src/consts/text.ts:30

fontWeight$

fontWeight$: Signal<FontWeight>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).fontWeight$

hasMaxWidth

hasMaxWidth: boolean

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).hasMaxWidth

Defined in

packages/affine/model/src/blocks/edgeless-text/edgeless-text-model.ts:18

hasMaxWidth$

hasMaxWidth$: Signal<boolean>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).hasMaxWidth$

id

id: string

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).id

Defined in

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

index

index: string

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).index

Defined in

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

index$

index$: Signal<string>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).index$

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).isEmpty

Defined in

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

keys

keys: string[]

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).keys

Defined in

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

lockedBySelf?

optional lockedBySelf: boolean

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).lockedBySelf

Defined in

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

lockedBySelf$

lockedBySelf$: Signal<undefined | boolean>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).lockedBySelf$

pop()

pop: (prop) => void

Parameters

prop

Returns

void

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).pop

Defined in

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

propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).propsUpdated

Defined in

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

role

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

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).role

Defined in

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

rotate

rotate: number

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).rotate

Defined in

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

rotate$

rotate$: Signal<number>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).rotate$

scale

scale: number

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).scale

Defined in

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

scale$

scale$: Signal<number>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).scale$

stash()

stash: (prop) => void

Parameters

prop

Returns

void

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).stash

Defined in

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

text?

optional text: Text

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).text

Defined in

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

textAlign

textAlign: TextAlign

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).textAlign

Defined in

packages/affine/model/src/consts/text.ts:31

textAlign$

textAlign$: Signal<TextAlign>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).textAlign$

version

version: number

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).version

Defined in

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

xywh

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

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).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

GfxCompatible<EdgelessTextProps>(BlockModel).xywh$

yBlock

yBlock: YBlock

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).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

GfxCompatible<EdgelessTextProps>(BlockModel).children

Defined in

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

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).deserializedXYWH

Defined in

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

doc

Get Signature

get doc(): Doc

Returns

Doc

Set Signature

set doc(doc): void

Parameters

doc

Doc

Returns

void

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).doc

Defined in

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

elementBound

Get Signature

get elementBound(): Bound

Returns

Bound

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).elementBound

Defined in

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

externalBound

Get Signature

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).externalBound

Defined in

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

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

GfxCompatible<EdgelessTextProps>(BlockModel).externalXYWH

Defined in

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

group

Get Signature

get group(): null | GfxGroupModel

Returns

null | GfxGroupModel

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).group

Defined in

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

groups

Get Signature

get groups(): GfxGroupModel[]

Returns

GfxGroupModel[]

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).groups

Defined in

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

h

Get Signature

get h(): number

Returns

number

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).h

Defined in

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

parent

Get Signature

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).parent

Defined in

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

surface

Get Signature

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).surface

Defined in

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

w

Get Signature

get w(): number

Returns

number

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).w

Defined in

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

x

Get Signature

get x(): number

Returns

number

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).x

Defined in

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

y

Get Signature

get y(): number

Returns

number

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).y

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).[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

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).containsBound

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).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

GfxCompatible<EdgelessTextProps>(BlockModel).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

GfxCompatible<EdgelessTextProps>(BlockModel).getLineIntersections

Defined in

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

getNearestPoint()

getNearestPoint(point): IVec

Parameters

point

IVec

Returns

IVec

Implementation of

GfxElementGeometry.getNearestPoint

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).getNearestPoint

Defined in

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

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

relativePoint

IVec

Returns

PointLocation

Implementation of

GfxElementGeometry.getRelativePointLocation

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).getRelativePointLocation

Defined in

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

includesPoint()

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

Parameters

x

number

y

number

_

PointTestOptions

__

EditorHost

Returns

boolean

Implementation of

GfxElementGeometry.includesPoint

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).includesPoint

Defined in

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

intersectsBound()

intersectsBound(bound): boolean

Parameters

bound

Bound

Returns

boolean

Implementation of

GfxElementGeometry.intersectsBound

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).intersectsBound

Defined in

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

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

GfxCompatible<EdgelessTextProps>(BlockModel).isLocked

Defined in

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

isLockedByAncestor()

isLockedByAncestor(): boolean

Returns

boolean

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).isLockedByAncestor

Defined in

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

isLockedBySelf()

isLockedBySelf(): boolean

Returns

boolean

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).isLockedBySelf

Defined in

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

lastChild()

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).lastChild

Defined in

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

lock()

lock(): void

Returns

void

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).lock

Defined in

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

unlock()

unlock(): void

Returns

void

Inherited from

GfxCompatible<EdgelessTextProps>(BlockModel).unlock

Defined in

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

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 ​

lockedBySelf? ​

Inherited from ​

Defined in ​

lockedBySelf$ ​

Inherited from ​

page ​

Deprecated ​

Inherited from ​

Defined in ​

pop() ​

Parameters ​

prop ​

Returns ​

Inherited from ​

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

lockedBySelf?

Inherited from

Defined in

lockedBySelf$

Inherited from

page

Deprecated

Inherited from

Defined in

pop()

Parameters

prop

Returns

Inherited from