BlockSuite API Documentation / @blocksuite/blocks / EmbedYoutubeModel
Class: EmbedYoutubeModel
Extends
EmbedYoutubeModel_base
Constructors
new EmbedYoutubeModel()
new EmbedYoutubeModel():
EmbedYoutubeModel
Returns
Inherited from
EmbedYoutubeModel_base.constructor
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:18
Properties
[modelLabel]
[modelLabel]:
object
&EmbedYoutubeBlockUrlData
&GfxCompatibleProps
Type declaration
caption
caption:
null
|string
style
style:
EmbedCardStyle
url
url:
string
Inherited from
EmbedYoutubeModel_base.[modelLabel]
Defined in
packages/framework/store/dist/schema/base.d.ts:115
caption
caption:
null
|string
Inherited from
EmbedYoutubeModel_base.caption
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:21
caption$
caption$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.caption$
childMap
childMap:
ReadonlySignal
<Map
<string
,number
>>
Inherited from
EmbedYoutubeModel_base.childMap
Defined in
packages/framework/store/dist/schema/base.d.ts:108
connectable
connectable:
boolean
Inherited from
EmbedYoutubeModel_base.connectable
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:33
created
created:
Slot
<void
>
Inherited from
EmbedYoutubeModel_base.created
Defined in
packages/framework/store/dist/schema/base.d.ts:109
creator
creator:
null
|string
Inherited from
EmbedYoutubeModel_base.creator
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:7
creator$
creator$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.creator$
creatorImage
creatorImage:
null
|string
Inherited from
EmbedYoutubeModel_base.creatorImage
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:9
creatorImage$
creatorImage$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.creatorImage$
creatorUrl
creatorUrl:
null
|string
Inherited from
EmbedYoutubeModel_base.creatorUrl
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:8
creatorUrl$
creatorUrl$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.creatorUrl$
deleted
deleted:
Slot
<void
>
Inherited from
EmbedYoutubeModel_base.deleted
Defined in
packages/framework/store/dist/schema/base.d.ts:110
description
description:
null
|string
Inherited from
EmbedYoutubeModel_base.description
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:6
description$
description$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.description$
flavour
flavour:
string
Inherited from
EmbedYoutubeModel_base.flavour
Defined in
packages/framework/store/dist/schema/base.d.ts:111
id
id:
string
Inherited from
EmbedYoutubeModel_base.id
Defined in
packages/framework/store/dist/schema/base.d.ts:112
image
image:
null
|string
Inherited from
EmbedYoutubeModel_base.image
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:4
image$
image$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.image$
index
index:
string
Inherited from
EmbedYoutubeModel_base.index
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:13
index$
index$:
Signal
<string
>
Inherited from
EmbedYoutubeModel_base.index$
isEmpty
isEmpty:
ReadonlySignal
<boolean
>
Inherited from
EmbedYoutubeModel_base.isEmpty
Defined in
packages/framework/store/dist/schema/base.d.ts:113
keys
keys:
string
[]
Inherited from
EmbedYoutubeModel_base.keys
Defined in
packages/framework/store/dist/schema/base.d.ts:114
lockedBySelf?
optional
lockedBySelf:boolean
Inherited from
EmbedYoutubeModel_base.lockedBySelf
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:14
lockedBySelf$
lockedBySelf$:
Signal
<undefined
|boolean
>
Inherited from
EmbedYoutubeModel_base.lockedBySelf$
page
page:
Doc
Deprecated
use doc instead
Inherited from
EmbedYoutubeModel_base.page
Defined in
packages/framework/store/dist/schema/base.d.ts:104
pop()
pop: (
prop
) =>void
Parameters
prop
"url"
| "xywh"
| "index"
| "lockedBySelf"
| "title"
| "caption"
| "style"
| "image"
| "description"
| "videoId"
| "creator"
| "creatorUrl"
| "creatorImage"
Returns
void
Inherited from
EmbedYoutubeModel_base.pop
Defined in
packages/framework/store/dist/schema/base.d.ts:116
propsUpdated
propsUpdated:
Slot
<{key
:string
; }>
Inherited from
EmbedYoutubeModel_base.propsUpdated
Defined in
packages/framework/store/dist/schema/base.d.ts:117
role
role:
"root"
|"hub"
|"content"
Inherited from
EmbedYoutubeModel_base.role
Defined in
packages/framework/store/dist/schema/base.d.ts:120
rotate
rotate:
number
Inherited from
EmbedYoutubeModel_base.rotate
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:34
stash()
stash: (
prop
) =>void
Parameters
prop
"url"
| "xywh"
| "index"
| "lockedBySelf"
| "title"
| "caption"
| "style"
| "image"
| "description"
| "videoId"
| "creator"
| "creatorUrl"
| "creatorImage"
Returns
void
Inherited from
EmbedYoutubeModel_base.stash
Defined in
packages/framework/store/dist/schema/base.d.ts:121
style
style:
EmbedCardStyle
Inherited from
EmbedYoutubeModel_base.style
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:19
style$
style$:
Signal
<EmbedCardStyle
>
Inherited from
EmbedYoutubeModel_base.style$
text?
optional
text:Text
Inherited from
EmbedYoutubeModel_base.text
Defined in
packages/framework/store/dist/schema/base.d.ts:122
title
title:
null
|string
Inherited from
EmbedYoutubeModel_base.title
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:5
title$
title$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.title$
url
url:
string
Inherited from
EmbedYoutubeModel_base.url
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:20
url$
url$:
Signal
<string
>
Inherited from
EmbedYoutubeModel_base.url$
version
version:
number
Inherited from
EmbedYoutubeModel_base.version
Defined in
packages/framework/store/dist/schema/base.d.ts:123
videoId
videoId:
null
|string
Inherited from
EmbedYoutubeModel_base.videoId
Defined in
packages/affine/model/dist/blocks/embed/youtube/youtube-model.d.ts:3
videoId$
videoId$:
Signal
<null
|string
>
Inherited from
EmbedYoutubeModel_base.videoId$
xywh
xywh: `[${number},${number},${number},${number}]`
Inherited from
EmbedYoutubeModel_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
EmbedYoutubeModel_base.xywh$
yBlock
yBlock:
YBlock
Inherited from
EmbedYoutubeModel_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
EmbedYoutubeModel_base.children
Defined in
packages/framework/store/dist/schema/base.d.ts:125
deserializedXYWH
Get Signature
get deserializedXYWH():
XYWH
Returns
XYWH
Inherited from
EmbedYoutubeModel_base.deserializedXYWH
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:35
doc
Get Signature
get doc():
Doc
Returns
Set Signature
set doc(
doc
):void
Parameters
doc
Returns
void
Inherited from
EmbedYoutubeModel_base.doc
Defined in
packages/framework/store/dist/schema/base.d.ts:126
elementBound
Get Signature
get elementBound():
Bound
Returns
Bound
Inherited from
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.parent
Defined in
packages/framework/store/dist/schema/base.d.ts:128
surface
Get Signature
get surface():
null
|SurfaceBlockModel
Returns
null
| SurfaceBlockModel
Inherited from
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.y
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:46
Methods
[dispose]()
[dispose]():
void
Returns
void
Inherited from
EmbedYoutubeModel_base.[dispose]
Defined in
packages/framework/store/dist/schema/base.d.ts:133
containsBound()
containsBound(
bounds
):boolean
Parameters
bounds
Bound
Returns
boolean
Inherited from
EmbedYoutubeModel_base.containsBound
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:47
dispose()
dispose():
void
Returns
void
Inherited from
EmbedYoutubeModel_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
EmbedYoutubeModel_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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
__
Returns
boolean
Inherited from
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.isLocked
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:53
isLockedByAncestor()
isLockedByAncestor():
boolean
Returns
boolean
Inherited from
EmbedYoutubeModel_base.isLockedByAncestor
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:54
isLockedBySelf()
isLockedBySelf():
boolean
Returns
boolean
Inherited from
EmbedYoutubeModel_base.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
EmbedYoutubeModel_base.lastChild
Defined in
packages/framework/store/dist/schema/base.d.ts:132
lock()
lock():
void
Returns
void
Inherited from
EmbedYoutubeModel_base.lock
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:56
unlock()
unlock():
void
Returns
void
Inherited from
EmbedYoutubeModel_base.unlock
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:57