BlockSuite API Documentation / @blocksuite/affine-model / EmbedGithubModel
Class: EmbedGithubModel
Defined in: packages/affine/model/src/blocks/embed/github/github-model.ts:33
Extends
GfxBlockElementModel
<object
&EmbedGithubBlockUrlData
&GfxCompatibleProps
,this
>
Constructors
new EmbedGithubModel()
new EmbedGithubModel():
EmbedGithubModel
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:42
Returns
EmbedGithubModel
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).constructor
Properties
_props
_props:
SignaledProps
<object
&EmbedGithubBlockUrlData
&GfxCompatibleProps
>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:33
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel )._props
[modelLabel]
[modelLabel]:
object
&EmbedGithubBlockUrlData
&GfxCompatibleProps
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:24
Type declaration
caption
caption:
null
|string
githubId
githubId:
string
githubType
githubType:
"issue"
|"pr"
owner
owner:
string
repo
repo:
string
style
style:
EmbedCardStyle
url
url:
string
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).[modelLabel]
childMap
childMap:
ReadonlySignal
<Map
<string
,number
>>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:17
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).childMap
connectable
connectable:
boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:34
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).connectable
created
created:
Subject
<void
>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:18
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).created
deleted
deleted:
Subject
<void
>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:19
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).deleted
id
id:
string
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:20
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).id
keys
keys:
string
[]
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:23
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).keys
pop()
pop: (
prop
) =>void
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:25
Parameters
prop
"description"
| "url"
| "title"
| "status"
| "xywh"
| "index"
| "lockedBySelf"
| "style"
| "caption"
| "image"
| "statusReason"
| "createdAt"
| "assignees"
| "owner"
| "repo"
| "githubType"
| "githubId"
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).pop
propsUpdated
propsUpdated:
Subject
<{key
:string
; }>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:26
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).propsUpdated
responseExtension
responseExtension: [
number
,number
]
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:59
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
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).responseExtension
rotate
rotate:
number
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:60
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).rotate
schema
schema:
object
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:21
model
model:
object
model.children?
optional
model.children:string
[]
model.flavour
model.flavour:
string
model.isFlatData?
optional
model.isFlatData:boolean
model.parent?
optional
model.parent:string
[]
model.props()?
optional
model.props: (args_0
, ...args
) =>Record
<string
,any
>
Parameters
args_0
args
...unknown
[]
Returns
Record
<string
, any
>
model.role
model.role:
"root"
|"hub"
|"content"
model.toModel()?
optional
model.toModel: (...args
) =>BlockModel
<object
>
Parameters
args
...unknown
[]
Returns
BlockModel
<object
>
transformer()?
optional
transformer: (args_0
, ...args
) =>BaseBlockTransformer
<object
>
Parameters
args_0
Map
<string
, unknown
>
args
...unknown
[]
Returns
BaseBlockTransformer
<object
>
version
version:
number
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).schema
stash()
stash: (
prop
) =>void
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:29
Parameters
prop
"description"
| "url"
| "title"
| "status"
| "xywh"
| "index"
| "lockedBySelf"
| "style"
| "caption"
| "image"
| "statusReason"
| "createdAt"
| "assignees"
| "owner"
| "repo"
| "githubType"
| "githubId"
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).stash
yBlock
yBlock:
YBlock
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:32
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).yBlock
Accessors
children
Get Signature
get children():
BlockModel
<object
>[]
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:37
Returns
BlockModel
<object
>[]
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).children
deserializedXYWH
Get Signature
get deserializedXYWH():
XYWH
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:61
Returns
XYWH
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).deserializedXYWH
doc
Get Signature
get doc():
Store
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:38
Returns
Set Signature
set doc(
doc
):void
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:39
Parameters
doc
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).doc
elementBound
Get Signature
get elementBound():
Bound
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:62
The bound of the element without considering the response extension.
Returns
Bound
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).elementBound
externalBound
Get Signature
get externalBound():
null
|Bound
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:63
Returns
null
| Bound
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).externalBound
externalXYWH
Get Signature
get externalXYWH():
undefined
|`[${number},${number},${number},${number}]`
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:64
Returns
undefined
| `[${number},${number},${number},${number}]`
Set Signature
set externalXYWH(
xywh
):void
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:65
Parameters
xywh
undefined
| `[${number},${number},${number},${number}]`
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).externalXYWH
flavour
Get Signature
get flavour():
string
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:35
Returns
string
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).flavour
group
Get Signature
get group():
null
|GfxGroupModel
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:66
Returns
null
| GfxGroupModel
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).group
groups
Get Signature
get groups():
GfxGroupModel
[]
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:67
Returns
GfxGroupModel
[]
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).groups
h
Get Signature
get h():
number
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:68
Returns
number
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).h
index
Get Signature
get index():
string
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:38
Returns
string
Set Signature
set index(
index
):void
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:40
Parameters
index
string
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).index
index$
Get Signature
get index$():
Signal
<Props
["index"
]>
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:39
Returns
Signal
<Props
["index"
]>
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).index$
lockedBySelf
Get Signature
get lockedBySelf():
undefined
|boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:41
Indicates whether the current block is explicitly locked by self. For checking the lock status of the element, use isLocked
instead. For (un)locking the element, use (un)lock
instead.
Returns
undefined
| boolean
Set Signature
set lockedBySelf(
lockedBySelf
):void
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:43
Indicates whether the current block is explicitly locked by self. For checking the lock status of the element, use isLocked
instead. For (un)locking the element, use (un)lock
instead.
Parameters
lockedBySelf
undefined
| boolean
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).lockedBySelf
lockedBySelf$
Get Signature
get lockedBySelf$():
Signal
<Props
["lockedBySelf"
]>
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:42
Returns
Signal
<Props
["lockedBySelf"
]>
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).lockedBySelf$
parent
Get Signature
get parent():
null
|BlockModel
<object
>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:40
Returns
null
| BlockModel
<object
>
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).parent
props
Get Signature
get props():
SignaledProps
<Props
>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:34
Returns
SignaledProps
<Props
>
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).props
responseBound
Get Signature
get responseBound():
Bound
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:69
The bound of the element considering the response extension.
Returns
Bound
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).responseBound
role
Get Signature
get role():
"root"
|"hub"
|"content"
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:41
Returns
"root"
| "hub"
| "content"
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).role
surface
Get Signature
get surface():
null
|SurfaceBlockModel
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:70
Returns
null
| SurfaceBlockModel
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).surface
text
Get Signature
get text():
undefined
|Text
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:30
Returns
undefined
| Text
Set Signature
set text(
text
):void
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:31
Parameters
text
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).text
version
Get Signature
get version():
number
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:36
Returns
number
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).version
w
Get Signature
get w():
number
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:71
Returns
number
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).w
x
Get Signature
get x():
number
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:72
Returns
number
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).x
xywh
Get Signature
get xywh():
`[${number},${number},${number},${number}]`
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:35
Returns
`[${number},${number},${number},${number}]`
Set Signature
set xywh(
xywh
):void
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:37
Parameters
xywh
`[${number},${number},${number},${number}]`
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).xywh
xywh$
Get Signature
get xywh$():
Signal
<Props
["xywh"
]>
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:36
Returns
Signal
<Props
["xywh"
]>
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).xywh$
y
Get Signature
get y():
number
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:73
Returns
number
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).y
Methods
[dispose]()
[dispose]():
void
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:46
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).[dispose]
containsBound()
containsBound(
bounds
):boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:74
Parameters
bounds
Bound
Returns
boolean
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).containsBound
dispose()
dispose():
void
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:43
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).dispose
firstChild()
firstChild():
null
|BlockModel
<object
>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:44
Returns
null
| BlockModel
<object
>
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).firstChild
getLineIntersections()
getLineIntersections(
start
,end
):null
|PointLocation
[]
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:75
Parameters
start
IVec
end
IVec
Returns
null
| PointLocation
[]
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).getLineIntersections
getNearestPoint()
getNearestPoint(
point
):IVec
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:76
Parameters
point
IVec
Returns
IVec
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).getNearestPoint
getRelativePointLocation()
getRelativePointLocation(
relativePoint
):PointLocation
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:77
Parameters
relativePoint
IVec
Returns
PointLocation
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).getRelativePointLocation
includesPoint()
includesPoint(
x
,y
,opt
,__
):boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:78
Parameters
x
number
y
number
opt
PointTestOptions
__
Returns
boolean
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).includesPoint
intersectsBound()
intersectsBound(
bound
):boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:79
Parameters
bound
Bound
Returns
boolean
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).intersectsBound
isEmpty()
isEmpty():
boolean
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:22
Returns
boolean
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).isEmpty
isLocked()
isLocked():
boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:80
Check if the element is locked. It will check the lock status of the element and its ancestors.
Returns
boolean
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).isLocked
isLockedByAncestor()
isLockedByAncestor():
boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:81
Returns
boolean
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).isLockedByAncestor
isLockedBySelf()
isLockedBySelf():
boolean
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:82
Returns
boolean
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).isLockedBySelf
lastChild()
lastChild():
null
|BlockModel
<object
>
Defined in: packages/framework/store/dist/model/block/block-model.d.ts:45
Returns
null
| BlockModel
<object
>
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).lastChild
lock()
lock():
void
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:83
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).lock
unlock()
unlock():
void
Defined in: packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:84
Returns
void
Inherited from
defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).unlock