BlockSuite API Documentation / @blocksuite/blocks / AttachmentBlockModel

Class: AttachmentBlockModel

Extends

AttachmentBlockModel_base

Implements

GfxElementGeometry

Constructors

new AttachmentBlockModel()

new AttachmentBlockModel(): AttachmentBlockModel

Returns

AttachmentBlockModel

Inherited from

AttachmentBlockModel_base.constructor

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:57

Properties

[modelLabel]

[modelLabel]: AttachmentBlockProps

Inherited from

AttachmentBlockModel_base.[modelLabel]

Defined in

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

caption?

optional caption: string

Inherited from

AttachmentBlockModel_base.caption

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:34

caption$

caption$: Signal<undefined | string>

Inherited from

AttachmentBlockModel_base.caption$

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

AttachmentBlockModel_base.childMap

Defined in

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

connectable

connectable: boolean

Inherited from

AttachmentBlockModel_base.connectable

Defined in

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

created

created: Slot<void>

Inherited from

AttachmentBlockModel_base.created

Defined in

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

deleted

deleted: Slot<void>

Inherited from

AttachmentBlockModel_base.deleted

Defined in

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

embed

embed: undefined | boolean

Whether to show the attachment as an embed view.

Inherited from

AttachmentBlockModel_base.embed

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:39

embed$

embed$: Signal<undefined | boolean>

Inherited from

AttachmentBlockModel_base.embed$

flavour

flavour: string

Inherited from

AttachmentBlockModel_base.flavour

Defined in

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

id

id: string

Inherited from

AttachmentBlockModel_base.id

Defined in

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

index

index: string

Inherited from

AttachmentBlockModel_base.index

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:23

index$

index$: Signal<string>

Inherited from

AttachmentBlockModel_base.index$

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

AttachmentBlockModel_base.isEmpty

Defined in

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

keys

keys: string[]

Inherited from

AttachmentBlockModel_base.keys

Defined in

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

name

name: string

Inherited from

AttachmentBlockModel_base.name

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:28

name$

name$: Signal<string>

Inherited from

AttachmentBlockModel_base.name$

pop()

pop: (prop) => void

Parameters

Returns

void

Inherited from

AttachmentBlockModel_base.pop

Defined in

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

propsUpdated

propsUpdated: Slot<object>

Type declaration

key

key: string

Inherited from

AttachmentBlockModel_base.propsUpdated

Defined in

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

role

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

Inherited from

AttachmentBlockModel_base.role

Defined in

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

rotate

rotate: number

Inherited from

AttachmentBlockModel_base.rotate

Defined in

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

rotate$

rotate$: Signal<number>

Inherited from

AttachmentBlockModel_base.rotate$

size

size: number

Inherited from

AttachmentBlockModel_base.size

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:29

size$

size$: Signal<number>

Inherited from

AttachmentBlockModel_base.size$

sourceId?

optional sourceId: string

Inherited from

AttachmentBlockModel_base.sourceId

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:35

sourceId$

sourceId$: Signal<undefined | string>

Inherited from

AttachmentBlockModel_base.sourceId$

stash()

stash: (prop) => void

Parameters

Returns

void

Inherited from

AttachmentBlockModel_base.stash

Defined in

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

style?

optional style: EmbedCardStyle

Inherited from

AttachmentBlockModel_base.style

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:40

style$

style$: Signal<undefined | EmbedCardStyle>

Inherited from

AttachmentBlockModel_base.style$

text?

optional text: Text

Inherited from

AttachmentBlockModel_base.text

Defined in

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

type

type: string

MIME type

Inherited from

AttachmentBlockModel_base.type

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:33

type$

type$: Signal<string>

Inherited from

AttachmentBlockModel_base.type$

version

version: number

Inherited from

AttachmentBlockModel_base.version

Defined in

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

xywh

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

Inherited from

AttachmentBlockModel_base.xywh

Defined in

packages/affine/model/dist/blocks/attachment/attachment-model.d.ts:24

xywh$

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

Inherited from

AttachmentBlockModel_base.xywh$

yBlock

yBlock: YBlock

Inherited from

AttachmentBlockModel_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

AttachmentBlockModel_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

AttachmentBlockModel_base.container

Defined in

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

deserializedXYWH

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

AttachmentBlockModel_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

AttachmentBlockModel_base.doc

Defined in

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

elementBound

get elementBound(): Bound

Returns

Bound

Inherited from

AttachmentBlockModel_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

AttachmentBlockModel_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

AttachmentBlockModel_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

AttachmentBlockModel_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

AttachmentBlockModel_base.groups

Defined in

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

h

get h(): number

Returns

number

Inherited from

AttachmentBlockModel_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

AttachmentBlockModel_base.parent

Defined in

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

surface

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

AttachmentBlockModel_base.surface

Defined in

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

w

get w(): number

Returns

number

Inherited from

AttachmentBlockModel_base.w

Defined in

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

x

get x(): number

Returns

number

Inherited from

AttachmentBlockModel_base.x

Defined in

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

y

get y(): number

Returns

number

Inherited from

AttachmentBlockModel_base.y

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

AttachmentBlockModel_base.[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

AttachmentBlockModel_base.containsBound

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

AttachmentBlockModel_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

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

Implementation of

GfxElementGeometry.getLineIntersections

Inherited from

AttachmentBlockModel_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

Implementation of

GfxElementGeometry.getNearestPoint

Inherited from

AttachmentBlockModel_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

Implementation of

GfxElementGeometry.getRelativePointLocation

Inherited from

AttachmentBlockModel_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

Implementation of

GfxElementGeometry.includesPoint

Inherited from

AttachmentBlockModel_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

Implementation of

GfxElementGeometry.intersectsBound

Inherited from

AttachmentBlockModel_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

AttachmentBlockModel_base.lastChild

Defined in

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

Class: AttachmentBlockModel ​

Extends ​

Implements ​

Constructors ​

new AttachmentBlockModel() ​

Returns ​

Inherited from ​

Defined in ​

Properties ​

[modelLabel] ​

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 ​

embed ​

Inherited from ​

Defined in ​

embed$ ​

Inherited from ​

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 ​

name ​

Inherited from ​

Defined in ​

name$ ​

Inherited from ​

page ​

Deprecated ​

Inherited from ​

Defined in ​

pop() ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

propsUpdated ​

Type declaration ​

key ​

Inherited from ​

Defined in ​

role ​

Inherited from ​

Defined in ​

rotate ​

Inherited from ​

Defined in ​

rotate$ ​

Inherited from ​

size ​

Inherited from ​

Class: AttachmentBlockModel

Extends

Implements

Constructors

new AttachmentBlockModel()

Returns

Inherited from

Defined in

Properties

[modelLabel]

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

embed

Inherited from

Defined in

embed$

Inherited from

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

name

Inherited from

Defined in

name$

Inherited from

page

Deprecated

Inherited from

Defined in

pop()

Parameters

Returns

Inherited from

Defined in

propsUpdated

Type declaration

key

Inherited from

Defined in

role

Inherited from

Defined in

rotate

Inherited from

Defined in

rotate$

Inherited from

size

Inherited from