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

Class: EmbedYoutubeModel

Extends

• EdgelessBlockModel<object & EmbedYoutubeBlockUrlData & GfxCompatibleProps, this>

Constructors

new EmbedYoutubeModel()

new EmbedYoutubeModel(): EmbedYoutubeModel

Returns

EmbedYoutubeModel

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).constructor

Defined in

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

Properties

[modelLabel]

[modelLabel]: object & EmbedYoutubeBlockUrlData & GfxCompatibleProps

Type declaration

caption

caption: null | string

style

style: EmbedCardStyle

url

url: string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).[modelLabel]

Defined in

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

---

caption

caption: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).caption

Defined in

packages/affine/model/src/blocks/embed/youtube/youtube-model.ts:22

---

caption$

caption$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).caption$

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).childMap

Defined in

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

---

connectable

connectable: boolean

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).connectable

Defined in

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

---

created

created: Slot<void>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).created

Defined in

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

---

creator

creator: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).creator

Defined in

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

---

creator$

creator$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).creator$

---

creatorImage

creatorImage: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).creatorImage

Defined in

packages/affine/model/src/blocks/embed/youtube/youtube-model.ts:14

---

creatorImage$

creatorImage$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).creatorImage$

---

creatorUrl

creatorUrl: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).creatorUrl

Defined in

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

---

creatorUrl$

creatorUrl$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).creatorUrl$

---

deleted

deleted: Slot<void>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).deleted

Defined in

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

---

description

description: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).description

Defined in

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

---

description$

description$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).description$

---

flavour

flavour: string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).flavour

Defined in

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

---

id

id: string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).id

Defined in

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

---

image

image: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).image

Defined in

packages/affine/model/src/blocks/embed/youtube/youtube-model.ts:9

---

image$

image$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).image$

---

index

index: string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).index

Defined in

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

---

index$

index$: Signal<string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).index$

---

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).isEmpty

Defined in

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

---

keys

keys: string[]

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).keys

Defined in

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

---

page

page: Doc

Deprecated

use doc instead

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).page

Defined in

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

---

pop()

pop: (prop) => void

Parameters

• prop: "xywh" | "index" | "description" | "caption" | "style" | "image" | "title" | "url" | "videoId" | "creator" | "creatorUrl" | "creatorImage"

Returns

void

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( BlockModel ).propsUpdated

Defined in

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

---

role

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

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).role

Defined in

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

---

rotate

rotate: number

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).rotate

Defined in

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

---

stash()

stash: (prop) => void

Parameters

• prop: "xywh" | "index" | "description" | "caption" | "style" | "image" | "title" | "url" | "videoId" | "creator" | "creatorUrl" | "creatorImage"

Returns

void

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).stash

Defined in

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

---

style

style: EmbedCardStyle

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).style

Defined in

packages/affine/model/src/blocks/embed/youtube/youtube-model.ts:20

---

style$

style$: Signal<EmbedCardStyle>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).style$

---

text?

optional text: Text

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).text

Defined in

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

---

title

title: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).title

Defined in

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

---

title$

title$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).title$

---

url

url: string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).url

Defined in

packages/affine/model/src/blocks/embed/youtube/youtube-model.ts:21

---

url$

url$: Signal<string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).url$

---

version

version: number

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).version

Defined in

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

---

videoId

videoId: null | string

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).videoId

Defined in

packages/affine/model/src/blocks/embed/youtube/youtube-model.ts:8

---

videoId$

videoId$: Signal<null | string>

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).videoId$

---

xywh

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

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).xywh

Defined in

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

---

xywh$

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

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( BlockModel ).xywh$

---

yBlock

yBlock: YBlock

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( BlockModel ).doc

Defined in

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

---

elementBound

get elementBound(): Bound

Returns

Bound

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( BlockModel ).parent

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

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

Defined in

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

---

dispose()

dispose(): void

Returns

void

Inherited from

defineEmbedModel<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( 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<EmbedYoutubeBlockProps>( BlockModel ).lastChild

Defined in

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