BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / EmbedHtmlModel

Class: EmbedHtmlModel ​

Extends ​

  • EmbedHtmlModel_base

Constructors ​

new EmbedHtmlModel() ​

new EmbedHtmlModel(): EmbedHtmlModel

Returns ​

EmbedHtmlModel

Inherited from ​

EmbedHtmlModel_base.constructor

Defined in ​

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

Properties ​

[modelLabel] ​

[modelLabel]: EmbedHtmlBlockProps & GfxCompatibleProps

Inherited from ​

EmbedHtmlModel_base.[modelLabel]

Defined in ​

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

caption ​

caption: null | string

Inherited from ​

EmbedHtmlModel_base.caption

Defined in ​

packages/affine/model/dist/blocks/embed/html/html-model.d.ts:5

caption$ ​

caption$: Signal<null | string>

Inherited from ​

EmbedHtmlModel_base.caption$

childMap ​

childMap: ReadonlySignal<Map<string, number>>

Inherited from ​

EmbedHtmlModel_base.childMap

Defined in ​

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

connectable ​

connectable: boolean

Inherited from ​

EmbedHtmlModel_base.connectable

Defined in ​

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

created ​

created: Slot<void>

Inherited from ​

EmbedHtmlModel_base.created

Defined in ​

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

deleted ​

deleted: Slot<void>

Inherited from ​

EmbedHtmlModel_base.deleted

Defined in ​

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

design? ​

optional design: string

Inherited from ​

EmbedHtmlModel_base.design

Defined in ​

packages/affine/model/dist/blocks/embed/html/html-model.d.ts:7

design$ ​

design$: Signal<undefined | string>

Inherited from ​

EmbedHtmlModel_base.design$

flavour ​

flavour: string

Inherited from ​

EmbedHtmlModel_base.flavour

Defined in ​

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

html? ​

optional html: string

Inherited from ​

EmbedHtmlModel_base.html

Defined in ​

packages/affine/model/dist/blocks/embed/html/html-model.d.ts:6

html$ ​

html$: Signal<undefined | string>

Inherited from ​

EmbedHtmlModel_base.html$

id ​

id: string

Inherited from ​

EmbedHtmlModel_base.id

Defined in ​

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

index ​

index: string

Inherited from ​

EmbedHtmlModel_base.index

Defined in ​

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

index$ ​

index$: Signal<string>

Inherited from ​

EmbedHtmlModel_base.index$

isEmpty ​

isEmpty: ReadonlySignal<boolean>

Inherited from ​

EmbedHtmlModel_base.isEmpty

Defined in ​

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

keys ​

keys: string[]

Inherited from ​

EmbedHtmlModel_base.keys

Defined in ​

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

lockedBySelf? ​

optional lockedBySelf: boolean

Inherited from ​

EmbedHtmlModel_base.lockedBySelf

Defined in ​

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

lockedBySelf$ ​

lockedBySelf$: Signal<undefined | boolean>

Inherited from ​

EmbedHtmlModel_base.lockedBySelf$

page ​

page: Doc

Deprecated ​

use doc instead

Inherited from ​

EmbedHtmlModel_base.page

Defined in ​

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

pop() ​

pop: (prop) => void

Parameters ​

prop ​

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

Returns ​

void

Inherited from ​

EmbedHtmlModel_base.pop

Defined in ​

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

propsUpdated ​

propsUpdated: Slot<{ key: string; }>

Inherited from ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.responseExtension

Defined in ​

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

role ​

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

Inherited from ​

EmbedHtmlModel_base.role

Defined in ​

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

rotate ​

rotate: number

Inherited from ​

EmbedHtmlModel_base.rotate

Defined in ​

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

stash() ​

stash: (prop) => void

Parameters ​

prop ​

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

Returns ​

void

Inherited from ​

EmbedHtmlModel_base.stash

Defined in ​

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

style ​

style: EmbedCardStyle

Inherited from ​

EmbedHtmlModel_base.style

Defined in ​

packages/affine/model/dist/blocks/embed/html/html-model.d.ts:4

style$ ​

style$: Signal<EmbedCardStyle>

Inherited from ​

EmbedHtmlModel_base.style$

text? ​

optional text: Text

Inherited from ​

EmbedHtmlModel_base.text

Defined in ​

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

version ​

version: number

Inherited from ​

EmbedHtmlModel_base.version

Defined in ​

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

xywh ​

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

Inherited from ​

EmbedHtmlModel_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 ​

EmbedHtmlModel_base.xywh$

yBlock ​

yBlock: YBlock

Inherited from ​

EmbedHtmlModel_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 ​

EmbedHtmlModel_base.children

Defined in ​

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

deserializedXYWH ​

Get Signature ​

get deserializedXYWH(): XYWH

Returns ​

XYWH

Inherited from ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.y

Defined in ​

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

Methods ​

[dispose]() ​

[dispose](): void

Returns ​

void

Inherited from ​

EmbedHtmlModel_base.[dispose]

Defined in ​

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

containsBound() ​

containsBound(bounds): boolean

Parameters ​

bounds ​

Bound

Returns ​

boolean

Inherited from ​

EmbedHtmlModel_base.containsBound

Defined in ​

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

dispose() ​

dispose(): void

Returns ​

void

Inherited from ​

EmbedHtmlModel_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 ​

EmbedHtmlModel_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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.isLocked

Defined in ​

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

isLockedByAncestor() ​

isLockedByAncestor(): boolean

Returns ​

boolean

Inherited from ​

EmbedHtmlModel_base.isLockedByAncestor

Defined in ​

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

isLockedBySelf() ​

isLockedBySelf(): boolean

Returns ​

boolean

Inherited from ​

EmbedHtmlModel_base.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 ​

EmbedHtmlModel_base.lastChild

Defined in ​

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

lock() ​

lock(): void

Returns ​

void

Inherited from ​

EmbedHtmlModel_base.lock

Defined in ​

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

unlock() ​

unlock(): void

Returns ​

void

Inherited from ​

EmbedHtmlModel_base.unlock

Defined in ​

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

Copyright © 2022-present Toeverything