BlockSuite

Appearance

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

Class: EmbedHtmlModel ​

Extends ​

Constructors ​

new EmbedHtmlModel() ​

new EmbedHtmlModel(): EmbedHtmlModel

Returns ​

EmbedHtmlModel

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).constructor

Defined in ​

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

Properties ​

[modelLabel] ​

[modelLabel]: EmbedHtmlBlockProps & GfxCompatibleProps

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).[modelLabel]

Defined in ​

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

caption ​

caption: null | string

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).caption

Defined in ​

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

caption$ ​

caption$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).caption$

childMap ​

childMap: ReadonlySignal<Map<string, number>>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).childMap

Defined in ​

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

connectable ​

connectable: boolean

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).connectable

Defined in ​

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

created ​

created: Slot<void>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).created

Defined in ​

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

deleted ​

deleted: Slot<void>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).deleted

Defined in ​

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

design? ​

optional design: string

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).design

Defined in ​

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

design$ ​

design$: Signal<undefined | string>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).design$

flavour ​

flavour: string

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).flavour

Defined in ​

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

html? ​

optional html: string

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).html

Defined in ​

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

html$ ​

html$: Signal<undefined | string>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).html$

id ​

id: string

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).id

Defined in ​

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

index ​

index: string

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).index

Defined in ​

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

index$ ​

index$: Signal<string>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).index$

isEmpty ​

isEmpty: ReadonlySignal<boolean>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).isEmpty

Defined in ​

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

keys ​

keys: string[]

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).keys

Defined in ​

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

lockedBySelf? ​

optional lockedBySelf: boolean

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( 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<EmbedHtmlBlockProps>( BlockModel ).lockedBySelf$

page ​

page: Doc

Deprecated ​

use doc instead

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).page

Defined in ​

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

pop() ​

pop: (prop) => void

Parameters ​

prop ​

"xywh" | "index" | "lockedBySelf" | "html" | "caption" | "style" | "design"

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).pop

Defined in ​

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

propsUpdated ​

propsUpdated: Slot<{ key: string; }>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).propsUpdated

Defined in ​

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

role ​

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

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).role

Defined in ​

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

rotate ​

rotate: number

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).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" | "html" | "caption" | "style" | "design"

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).stash

Defined in ​

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

style ​

style: EmbedCardStyle

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).style

Defined in ​

packages/affine/model/src/blocks/embed/html/html-model.ts:10

style$ ​

style$: Signal<EmbedCardStyle>

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).style$

text? ​

optional text: Text

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).text

Defined in ​

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

version ​

version: number

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).version

Defined in ​

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

xywh ​

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

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( 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<EmbedHtmlBlockProps>( BlockModel ).xywh$

yBlock ​

yBlock: YBlock

Inherited from ​

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

Defined in ​

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

deserializedXYWH ​

Get Signature ​

get deserializedXYWH(): XYWH

Returns ​

XYWH

Inherited from ​

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

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).doc

Defined in ​

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

elementBound ​

Get Signature ​

get elementBound(): Bound

Returns ​

Bound

Inherited from ​

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

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

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

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

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

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

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).parent

Defined in ​

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

surface ​

Get Signature ​

get surface(): null | SurfaceBlockModel

Returns ​

null | SurfaceBlockModel

Inherited from ​

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

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

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

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).y

Defined in ​

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

Methods ​

[dispose]() ​

[dispose](): void

Returns ​

void

Inherited from ​

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

Defined in ​

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

dispose() ​

dispose(): void

Returns ​

void

Inherited from ​

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

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

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

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

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

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).isLocked

Defined in ​

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

isLockedByAncestor() ​

isLockedByAncestor(): boolean

Returns ​

boolean

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).isLockedByAncestor

Defined in ​

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

isLockedBySelf() ​

isLockedBySelf(): boolean

Returns ​

boolean

Inherited from ​

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

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).lastChild

Defined in ​

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

lock() ​

lock(): void

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).lock

Defined in ​

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

unlock() ​

unlock(): void

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedHtmlBlockProps>( BlockModel ).unlock

Defined in ​

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

Copyright © 2022-present Toeverything