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

Class: EmbedSyncedDocModel

Extends

• EdgelessBlockModel<object & object & GfxCompatibleProps, this>

Constructors

new EmbedSyncedDocModel()

new EmbedSyncedDocModel(): EmbedSyncedDocModel

Returns

EmbedSyncedDocModel

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).constructor

Defined in

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

Properties

[modelLabel]

[modelLabel]: object & object & GfxCompatibleProps

Type declaration

caption?

optional caption: null | string

scale?

optional scale: number

style

style: EmbedCardStyle

Type declaration

description?

optional description: string

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"

title?

optional title: string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).[modelLabel]

Defined in

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

---

caption?

optional caption: null | string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).caption

Defined in

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

---

caption$

caption$: Signal<undefined | null | string>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).caption$

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).childMap

Defined in

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

---

connectable

connectable: boolean

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).connectable

Defined in

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

---

created

created: Slot<void>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).created

Defined in

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

---

deleted

deleted: Slot<void>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).deleted

Defined in

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

---

description?

optional description: string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).description

Defined in

packages/affine/model/src/consts/doc.ts:19

---

description$

description$: Signal<undefined | string>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).description$

---

flavour

flavour: string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).flavour

Defined in

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

---

id

id: string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).id

Defined in

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

---

index

index: string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).index

Defined in

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

---

index$

index$: Signal<string>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).index$

---

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).isEmpty

Defined in

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

---

keys

keys: string[]

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).keys

Defined in

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

---

lockedBySelf?

optional lockedBySelf: boolean

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).lockedBySelf

Defined in

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

---

lockedBySelf$

lockedBySelf$: Signal<undefined | boolean>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).lockedBySelf$

---

page

page: Doc

Deprecated

use doc instead

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).page

Defined in

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

---

pageId

pageId: string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).pageId

Defined in

packages/affine/model/src/consts/doc.ts:39

---

pageId$

pageId$: Signal<string>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).params

Defined in

packages/affine/model/src/consts/doc.ts:40

---

params$

params$: Signal<undefined | { blockIds: string[]; databaseId: string; databaseRowId: string; elementIds: string[]; mode: "edgeless" | "page"; }>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).params$

---

pop()

pop: (prop) => void

Parameters

prop

"xywh" | "index" | "lockedBySelf" | "description" | "scale" | "caption" | "style" | "title" | "params" | "pageId"

Returns

void

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).pop

Defined in

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

---

propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).responseExtension

Defined in

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

---

role

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

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).role

Defined in

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

---

rotate

rotate: number

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).rotate

Defined in

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

---

scale?

optional scale: number

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).scale

Defined in

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

---

scale$

scale$: Signal<undefined | number>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).scale$

---

stash()

stash: (prop) => void

Parameters

prop

"xywh" | "index" | "lockedBySelf" | "description" | "scale" | "caption" | "style" | "title" | "params" | "pageId"

Returns

void

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).stash

Defined in

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

---

style

style: EmbedCardStyle

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).style

Defined in

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

---

style$

style$: Signal<EmbedCardStyle>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).style$

---

text?

optional text: Text

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).text

Defined in

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

---

title?

optional title: string

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).title

Defined in

packages/affine/model/src/consts/doc.ts:18

---

title$

title$: Signal<undefined | string>

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).title$

---

version

version: number

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).version

Defined in

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

---

xywh

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

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( 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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).xywh$

---

yBlock

yBlock: YBlock

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( 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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).children

Defined in

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

---

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).y

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).[dispose]

Defined in

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

---

containsBound()

containsBound(bounds): boolean

Parameters

bounds

Bound

Returns

boolean

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).containsBound

Defined in

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

---

dispose()

dispose(): void

Returns

void

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( 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

defineEmbedModel<EmbedSyncedDocBlockProps>( 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[]

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).getRelativePointLocation

Defined in

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

---

includesPoint()

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

Parameters

x

number

y

number

opt

PointTestOptions

__

EditorHost

Returns

boolean

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).includesPoint

Defined in

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

---

intersectsBound()

intersectsBound(bound): boolean

Parameters

bound

Bound

Returns

boolean

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).intersectsBound

Defined in

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

---

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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).isLocked

Defined in

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

---

isLockedByAncestor()

isLockedByAncestor(): boolean

Returns

boolean

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).isLockedByAncestor

Defined in

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

---

isLockedBySelf()

isLockedBySelf(): boolean

Returns

boolean

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).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

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).lastChild

Defined in

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

---

lock()

lock(): void

Returns

void

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).lock

Defined in

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

---

unlock()

unlock(): void

Returns

void

Inherited from

defineEmbedModel<EmbedSyncedDocBlockProps>( BlockModel ).unlock

Defined in

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