BlockSuite

Appearance

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

Class: EdgelessTextBlockModel ​

Extends ​

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:134

Properties ​

[modelLabel] ​

[modelLabel]: EdgelessTextProps

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).[modelLabel]

Defined in ​

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

childMap ​

childMap: ReadonlySignal<Map<string, number>>

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).childMap

Defined in ​

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

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/gfx-block-model.d.ts:8

created ​

created: Slot<void>

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).created

Defined in ​

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

deleted ​

deleted: Slot<void>

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).deleted

Defined in ​

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

flavour ​

flavour: string

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).flavour

Defined in ​

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

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:20

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:113

index ​

index: string

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).index

Defined in ​

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

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:114

keys ​

keys: string[]

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).keys

Defined in ​

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

page ​

page: Doc

Deprecated ​

use doc instead

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).page

Defined in ​

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

pop() ​

pop: (prop) => void

Parameters ​

• prop: "xywh" | "index" | "rotate" | "color" | "fontFamily" | "fontStyle" | "fontWeight" | "textAlign" | "scale" | "hasMaxWidth"

Returns ​

void

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).pop

Defined in ​

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

propsUpdated ​

propsUpdated: Slot<object>

Type declaration ​

key ​

key: string

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).propsUpdated

Defined in ​

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

role ​

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

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).role

Defined in ​

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

rotate ​

rotate: number

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).rotate

Defined in ​

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

rotate$ ​

rotate$: Signal<number>

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).rotate$

scale ​

scale: number

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).scale

Defined in ​

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

scale$ ​

scale$: Signal<number>

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).scale$

stash() ​

stash: (prop) => void

Parameters ​

• prop: "xywh" | "index" | "rotate" | "color" | "fontFamily" | "fontStyle" | "fontWeight" | "textAlign" | "scale" | "hasMaxWidth"

Returns ​

void

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).stash

Defined in ​

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

text? ​

optional text: Text

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).text

Defined in ​

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

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:128

xywh ​

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

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).xywh

Defined in ​

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

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:129

Accessors ​

children ​

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:130

doc ​

get doc(): Doc

set doc(doc): void

Parameters ​

• doc: Doc

Returns ​

Doc

Inherited from ​

GfxCompatible<EdgelessTextProps>(BlockModel).doc

Defined in ​

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

elementBound ​

get elementBound(): Bound

Returns ​

Bound

Inherited from ​

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

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

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

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

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

GfxCompatible<EdgelessTextProps>(BlockModel).parent

Defined in ​

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

Methods ​

[dispose]() ​

[dispose](): void

Returns ​

void

Inherited from ​

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

GfxCompatible<EdgelessTextProps>(BlockModel).containsBound

Defined in ​

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

dispose() ​

dispose(): void

Returns ​

void

Inherited from ​

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

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

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

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

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

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

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

GfxCompatible<EdgelessTextProps>(BlockModel).lastChild

Defined in ​

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

Copyright © 2022-present Toeverything