BlockSuite API Documentation / @blocksuite/blocks / EmbedLinkedDocModel

Class: EmbedLinkedDocModel

Extends

• EmbedLinkedDocModel_base

Constructors

new EmbedLinkedDocModel()

new EmbedLinkedDocModel(): EmbedLinkedDocModel

Returns

EmbedLinkedDocModel

Inherited from

EmbedLinkedDocModel_base.constructor

Defined in

packages/affine/model/dist/blocks/embed/linked-doc/linked-doc-model.d.ts:9

Properties

[modelLabel]

[modelLabel]: object & object & GfxCompatibleProps

Type declaration

caption

caption: null | string

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

EmbedLinkedDocModel_base.[modelLabel]

Defined in

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

---

caption

caption: null | string

Inherited from

EmbedLinkedDocModel_base.caption

Defined in

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

---

caption$

caption$: Signal<null | string>

Inherited from

EmbedLinkedDocModel_base.caption$

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

EmbedLinkedDocModel_base.childMap

Defined in

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

---

connectable

connectable: boolean

Inherited from

EmbedLinkedDocModel_base.connectable

Defined in

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

---

created

created: Slot<void>

Inherited from

EmbedLinkedDocModel_base.created

Defined in

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

---

deleted

deleted: Slot<void>

Inherited from

EmbedLinkedDocModel_base.deleted

Defined in

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

---

description?

optional description: string

Inherited from

EmbedLinkedDocModel_base.description

Defined in

packages/affine/model/dist/blocks/embed/linked-doc/linked-doc-model.d.ts:14

---

description$

description$: Signal<undefined | string>

Inherited from

EmbedLinkedDocModel_base.description$

---

flavour

flavour: string

Inherited from

EmbedLinkedDocModel_base.flavour

Defined in

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

---

id

id: string

Inherited from

EmbedLinkedDocModel_base.id

Defined in

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

---

index

index: string

Inherited from

EmbedLinkedDocModel_base.index

Defined in

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

---

index$

index$: Signal<string>

Inherited from

EmbedLinkedDocModel_base.index$

---

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

EmbedLinkedDocModel_base.isEmpty

Defined in

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

---

keys

keys: string[]

Inherited from

EmbedLinkedDocModel_base.keys

Defined in

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

---

lockedBySelf?

optional lockedBySelf: boolean

Inherited from

EmbedLinkedDocModel_base.lockedBySelf

Defined in

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

---

lockedBySelf$

lockedBySelf$: Signal<undefined | boolean>

Inherited from

EmbedLinkedDocModel_base.lockedBySelf$

---

page

page: Doc

Deprecated

use doc instead

Inherited from

EmbedLinkedDocModel_base.page

Defined in

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

---

pageId

pageId: string

Inherited from

EmbedLinkedDocModel_base.pageId

Defined in

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

---

pageId$

pageId$: Signal<string>

Inherited from

EmbedLinkedDocModel_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

EmbedLinkedDocModel_base.params

Defined in

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

---

params$

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

Inherited from

EmbedLinkedDocModel_base.params$

---

pop()

pop: (prop) => void

Parameters

prop

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

Returns

void

Inherited from

EmbedLinkedDocModel_base.pop

Defined in

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

---

propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

EmbedLinkedDocModel_base.propsUpdated

Defined in

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

---

role

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

Inherited from

EmbedLinkedDocModel_base.role

Defined in

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

---

rotate

rotate: number

Inherited from

EmbedLinkedDocModel_base.rotate

Defined in

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

---

stash()

stash: (prop) => void

Parameters

prop

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

Returns

void

Inherited from

EmbedLinkedDocModel_base.stash

Defined in

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

---

style

style: EmbedCardStyle

Inherited from

EmbedLinkedDocModel_base.style

Defined in

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

---

style$

style$: Signal<EmbedCardStyle>

Inherited from

EmbedLinkedDocModel_base.style$

---

text?

optional text: Text

Inherited from

EmbedLinkedDocModel_base.text

Defined in

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

---

title?

optional title: string

Inherited from

EmbedLinkedDocModel_base.title

Defined in

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

---

title$

title$: Signal<undefined | string>

Inherited from

EmbedLinkedDocModel_base.title$

---

version

version: number

Inherited from

EmbedLinkedDocModel_base.version

Defined in

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

---

xywh

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

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.xywh$

---

yBlock

yBlock: YBlock

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.children

Defined in

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

---

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.doc

Defined in

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

---

elementBound

Get Signature

get elementBound(): Bound

Returns

Bound

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.parent

Defined in

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

---

surface

Get Signature

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.y

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

EmbedLinkedDocModel_base.[dispose]

Defined in

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

---

containsBound()

containsBound(bounds): boolean

Parameters

bounds

Bound

Returns

boolean

Inherited from

EmbedLinkedDocModel_base.containsBound

Defined in

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

---

dispose()

dispose(): void

Returns

void

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.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

Inherited from

EmbedLinkedDocModel_base.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

Inherited from

EmbedLinkedDocModel_base.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

Inherited from

EmbedLinkedDocModel_base.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

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.isLocked

Defined in

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

---

isLockedByAncestor()

isLockedByAncestor(): boolean

Returns

boolean

Inherited from

EmbedLinkedDocModel_base.isLockedByAncestor

Defined in

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

---

isLockedBySelf()

isLockedBySelf(): boolean

Returns

boolean

Inherited from

EmbedLinkedDocModel_base.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

EmbedLinkedDocModel_base.lastChild

Defined in

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

---

lock()

lock(): void

Returns

void

Inherited from

EmbedLinkedDocModel_base.lock

Defined in

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

---

unlock()

unlock(): void

Returns

void

Inherited from

EmbedLinkedDocModel_base.unlock

Defined in

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