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

Class: EmbedLinkedDocModel

Extends

EdgelessBlockModel<object & object & GfxCompatibleProps, this>

Constructors

new EmbedLinkedDocModel()

new EmbedLinkedDocModel(): EmbedLinkedDocModel

Returns

EmbedLinkedDocModel

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).constructor

Defined in

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

Properties

[modelLabel]

[modelLabel]: object & object & GfxCompatibleProps

Type declaration

caption

caption: null | string

style

style: EmbedCardStyle

Type declaration

pageId

pageId: string

params?

optional params: object

params.blockIds?

optional params.blockIds: string[]

params.elementIds?

optional params.elementIds: string[]

params.mode?

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

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).[modelLabel]

Defined in

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

caption

caption: null | string

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).caption

Defined in

packages/affine/model/src/blocks/embed/linked-doc/linked-doc-model.ts:18

caption$

caption$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).caption$

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).childMap

Defined in

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

connectable

connectable: boolean

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).connectable

Defined in

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

created

created: Slot<void>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).created

Defined in

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

deleted

deleted: Slot<void>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).deleted

Defined in

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

flavour

flavour: string

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).flavour

Defined in

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

id

id: string

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).id

Defined in

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

index

index: string

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).index

Defined in

packages/affine/model/src/utils/gfx-compatible.ts:8

index$

index$: Signal<string>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).index$

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).isEmpty

Defined in

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

keys

keys: string[]

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).keys

Defined in

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

pageId

pageId: string

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).pageId

Defined in

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

pageId$

pageId$: Signal<string>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).pageId$

params?

optional params: object

blockIds?

optional blockIds: string[]

elementIds?

optional elementIds: string[]

mode?

optional mode: "page" | "edgeless"

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).params

Defined in

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

params$

params$: Signal<undefined | object>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).params$

pop()

pop: (prop) => void

Parameters

Returns

void

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).pop

Defined in

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

propsUpdated

propsUpdated: Slot<object>

Type declaration

key

key: string

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).propsUpdated

Defined in

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

role

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

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).role

Defined in

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

rotate

rotate: number

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).rotate

Defined in

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

stash()

stash: (prop) => void

Parameters

Returns

void

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).stash

Defined in

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

style

style: EmbedCardStyle

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).style

Defined in

packages/affine/model/src/blocks/embed/linked-doc/linked-doc-model.ts:17

style$

style$: Signal<EmbedCardStyle>

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).style$

text?

optional text: Text

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).text

Defined in

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

version

version: number

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).version

Defined in

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

xywh

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

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).xywh

Defined in

packages/affine/model/src/utils/gfx-compatible.ts:7

xywh$

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

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).xywh$

yBlock

yBlock: YBlock

Inherited from

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

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

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).doc

Defined in

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

elementBound

get elementBound(): Bound

Returns

Bound

Inherited from

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

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

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

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

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

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).parent

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).[dispose]

Defined in

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

containsBound()

containsBound(bounds): boolean

Parameters

• bounds: Bound

Returns

boolean

Inherited from

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).containsBound

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

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

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

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

defineEmbedModel<EmbedLinkedDocBlockProps>( BlockModel ).lastChild

Defined in

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

Class: EmbedLinkedDocModel ​

Extends ​

Constructors ​

new EmbedLinkedDocModel() ​

Returns ​

Inherited from ​

Defined in ​

Properties ​

[modelLabel] ​

Type declaration ​

caption ​

style ​

Type declaration ​

pageId ​

params? ​

params.blockIds? ​

params.elementIds? ​

params.mode? ​

Inherited from ​

Defined in ​

caption ​

Inherited from ​

Defined in ​

caption$ ​

Inherited from ​

childMap ​

Inherited from ​

Defined in ​

connectable ​

Inherited from ​

Defined in ​

created ​

Inherited from ​

Defined in ​

deleted ​

Inherited from ​

Defined in ​

flavour ​

Inherited from ​

Defined in ​

id ​

Inherited from ​

Defined in ​

index ​

Inherited from ​

Defined in ​

index$ ​

Inherited from ​

isEmpty ​

Inherited from ​

Defined in ​

keys ​

Inherited from ​

Defined in ​

page ​

Deprecated ​

Inherited from ​

Defined in ​

pageId ​

Inherited from ​

Defined in ​

pageId$ ​

Inherited from ​

params? ​

blockIds? ​

elementIds? ​

mode? ​

Inherited from ​

Defined in ​

params$ ​

Inherited from ​

pop() ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

propsUpdated ​

Type declaration ​

key ​

Inherited from ​

Class: EmbedLinkedDocModel

Extends

Constructors

new EmbedLinkedDocModel()

Returns

Inherited from

Defined in

Properties

[modelLabel]

Type declaration

caption

style

Type declaration

pageId

params?

params.blockIds?

params.elementIds?

params.mode?

Inherited from

Defined in

caption

Inherited from

Defined in

caption$

Inherited from

childMap

Inherited from

Defined in

connectable

Inherited from

Defined in

created

Inherited from

Defined in

deleted

Inherited from

Defined in

flavour

Inherited from

Defined in

id

Inherited from

Defined in

index

Inherited from

Defined in

index$

Inherited from

isEmpty

Inherited from

Defined in

keys

Inherited from

Defined in

page

Deprecated

Inherited from

Defined in

pageId

Inherited from

Defined in

pageId$

Inherited from

params?

blockIds?

elementIds?

mode?

Inherited from

Defined in

params$

Inherited from

pop()

Parameters

Returns

Inherited from

Defined in

propsUpdated

Type declaration

key

Inherited from