BlockSuite API Documentation / @blocksuite/blocks / EmbedSyncedDocModel

Class: EmbedSyncedDocModel

Extends

• EmbedSyncedDocModel_base

Constructors

new EmbedSyncedDocModel()

new EmbedSyncedDocModel(): EmbedSyncedDocModel

Returns

EmbedSyncedDocModel

Inherited from

EmbedSyncedDocModel_base.constructor

Defined in

packages/affine/model/dist/blocks/embed/synced-doc/synced-doc-model.d.ts:10

Properties

[modelLabel]

[modelLabel]: object & object & GfxCompatibleProps

Type declaration

caption?

optional caption: null | string

scale?

optional scale: number

style

style: EmbedCardStyle

Type declaration

pageId

pageId: string

params?

optional params: object

params.blockIds?

optional params.blockIds: string[]

params.databaseId?

optional params.databaseId: string

params.databaseRowId?

optional params.databaseRowId: string

params.elementIds?

optional params.elementIds: string[]

params.mode?

optional params.mode: "edgeless" | "page"

Inherited from

EmbedSyncedDocModel_base.[modelLabel]

Defined in

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

---

caption?

optional caption: null | string

Inherited from

EmbedSyncedDocModel_base.caption

Defined in

packages/affine/model/dist/blocks/embed/synced-doc/synced-doc-model.d.ts:12

---

caption$

caption$: Signal<undefined | null | string>

Inherited from

EmbedSyncedDocModel_base.caption$

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

EmbedSyncedDocModel_base.childMap

Defined in

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

---

connectable

connectable: boolean

Inherited from

EmbedSyncedDocModel_base.connectable

Defined in

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

---

created

created: Slot<void>

Inherited from

EmbedSyncedDocModel_base.created

Defined in

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

---

deleted

deleted: Slot<void>

Inherited from

EmbedSyncedDocModel_base.deleted

Defined in

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

---

flavour

flavour: string

Inherited from

EmbedSyncedDocModel_base.flavour

Defined in

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

---

id

id: string

Inherited from

EmbedSyncedDocModel_base.id

Defined in

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

---

index

index: string

Inherited from

EmbedSyncedDocModel_base.index

Defined in

packages/affine/model/dist/utils/gfx-compatible.d.ts:6

---

index$

index$: Signal<string>

Inherited from

EmbedSyncedDocModel_base.index$

---

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

EmbedSyncedDocModel_base.isEmpty

Defined in

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

---

keys

keys: string[]

Inherited from

EmbedSyncedDocModel_base.keys

Defined in

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

---

page

page: Doc

Deprecated

use doc instead

Inherited from

EmbedSyncedDocModel_base.page

Defined in

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

---

pageId

pageId: string

Inherited from

EmbedSyncedDocModel_base.pageId

Defined in

packages/affine/model/dist/blocks/embed/synced-doc/synced-doc-model.d.ts:15

---

pageId$

pageId$: Signal<string>

Inherited from

EmbedSyncedDocModel_base.pageId$

---

params?

optional params: object

blockIds?

optional blockIds: string[]

databaseId?

optional databaseId: string

databaseRowId?

optional databaseRowId: string

elementIds?

optional elementIds: string[]

mode?

optional mode: "edgeless" | "page"

Inherited from

EmbedSyncedDocModel_base.params

Defined in

packages/affine/model/dist/blocks/embed/synced-doc/synced-doc-model.d.ts:16

---

params$

params$: Signal<undefined | object>

Inherited from

EmbedSyncedDocModel_base.params$

---

pop()

pop: (prop) => void

Parameters

• prop: "xywh" | "index" | "caption" | "style" | "pageId" | "params" | "scale"

Returns

void

Inherited from

EmbedSyncedDocModel_base.pop

Defined in

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

---

propsUpdated

propsUpdated: Slot<object>

Type declaration

key

key: string

Inherited from

EmbedSyncedDocModel_base.propsUpdated

Defined in

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

---

role

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

Inherited from

EmbedSyncedDocModel_base.role

Defined in

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

---

rotate

rotate: number

Inherited from

EmbedSyncedDocModel_base.rotate

Defined in

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

---

scale?

optional scale: number

Inherited from

EmbedSyncedDocModel_base.scale

Defined in

packages/affine/model/dist/blocks/embed/synced-doc/synced-doc-model.d.ts:13

---

scale$

scale$: Signal<undefined | number>

Inherited from

EmbedSyncedDocModel_base.scale$

---

stash()

stash: (prop) => void

Parameters

• prop: "xywh" | "index" | "caption" | "style" | "pageId" | "params" | "scale"

Returns

void

Inherited from

EmbedSyncedDocModel_base.stash

Defined in

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

---

style

style: EmbedCardStyle

Inherited from

EmbedSyncedDocModel_base.style

Defined in

packages/affine/model/dist/blocks/embed/synced-doc/synced-doc-model.d.ts:11

---

style$

style$: Signal<EmbedCardStyle>

Inherited from

EmbedSyncedDocModel_base.style$

---

text?

optional text: Text

Inherited from

EmbedSyncedDocModel_base.text

Defined in

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

---

version

version: number

Inherited from

EmbedSyncedDocModel_base.version

Defined in

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

---

xywh

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

Inherited from

EmbedSyncedDocModel_base.xywh

Defined in

packages/affine/model/dist/utils/gfx-compatible.d.ts:5

---

xywh$

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

Inherited from

EmbedSyncedDocModel_base.xywh$

---

yBlock

yBlock: YBlock

Inherited from

EmbedSyncedDocModel_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

EmbedSyncedDocModel_base.children

Defined in

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

---

container

get container(): null | GfxModel & GfxContainerElement

Returns

null | GfxModel & GfxContainerElement

Inherited from

EmbedSyncedDocModel_base.container

Defined in

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

---

deserializedXYWH

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

EmbedSyncedDocModel_base.deserializedXYWH

Defined in

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

---

doc

get doc(): Doc

set doc(doc): void

Parameters

• doc: Doc

Returns

Doc

Inherited from

EmbedSyncedDocModel_base.doc

Defined in

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

---

elementBound

get elementBound(): Bound

Returns

Bound

Inherited from

EmbedSyncedDocModel_base.elementBound

Defined in

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

---

externalBound

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

EmbedSyncedDocModel_base.externalBound

Defined in

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

---

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

EmbedSyncedDocModel_base.externalXYWH

Defined in

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

---

group

get group(): null | SurfaceGroupLikeModel<BaseElementProps>

Returns

null | SurfaceGroupLikeModel<BaseElementProps>

Inherited from

EmbedSyncedDocModel_base.group

Defined in

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

---

groups

get groups(): SurfaceGroupLikeModel<BaseElementProps>[]

Returns

SurfaceGroupLikeModel<BaseElementProps>[]

Inherited from

EmbedSyncedDocModel_base.groups

Defined in

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

---

h

get h(): number

Returns

number

Inherited from

EmbedSyncedDocModel_base.h

Defined in

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

---

parent

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EmbedSyncedDocModel_base.parent

Defined in

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

---

surface

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

EmbedSyncedDocModel_base.surface

Defined in

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

---

w

get w(): number

Returns

number

Inherited from

EmbedSyncedDocModel_base.w

Defined in

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

---

x

get x(): number

Returns

number

Inherited from

EmbedSyncedDocModel_base.x

Defined in

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

---

y

get y(): number

Returns

number

Inherited from

EmbedSyncedDocModel_base.y

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

EmbedSyncedDocModel_base.[dispose]

Defined in

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

---

containsBound()

containsBound(bounds): boolean

Parameters

• bounds: Bound

Returns

boolean

Inherited from

EmbedSyncedDocModel_base.containsBound

Defined in

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

---

dispose()

dispose(): void

Returns

void

Inherited from

EmbedSyncedDocModel_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

EmbedSyncedDocModel_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[]

Inherited from

EmbedSyncedDocModel_base.getLineIntersections

Defined in

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

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

• point: IVec

Returns

IVec

Inherited from

EmbedSyncedDocModel_base.getNearestPoint

Defined in

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

---

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

• relativePoint: IVec

Returns

PointLocation

Inherited from

EmbedSyncedDocModel_base.getRelativePointLocation

Defined in

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

---

includesPoint()

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

Parameters

• x: number

• y: number

• _: PointTestOptions

• __: EditorHost

Returns

boolean

Inherited from

EmbedSyncedDocModel_base.includesPoint

Defined in

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

---

intersectsBound()

intersectsBound(bound): boolean

Parameters

• bound: Bound

Returns

boolean

Inherited from

EmbedSyncedDocModel_base.intersectsBound

Defined in

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

---

lastChild()

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EmbedSyncedDocModel_base.lastChild

Defined in

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