BlockSuite API Documentation / @blocksuite/blocks / FrameBlockModel
Class: FrameBlockModel
Extends
EdgelessBlock
<FrameBlockProps
,this
>
Constructors
new FrameBlockModel(undefined)
new FrameBlockModel():
FrameBlockModel
Returns
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:99
Properties
[modelLabel]
[modelLabel]:
FrameBlockProps
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:101
background
background:
string
Inherited from
selectable<FrameBlockProps>(BlockModel).background
Source
packages/blocks/src/frame-block/frame-model.ts:13
childrenUpdated
childrenUpdated:
Slot
<void
>
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:120
connectable
connectable:
boolean
=true
Inherited from
Source
packages/blocks/src/root-block/edgeless/type.ts:77
created
created:
Slot
<void
>
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:115
deleted
deleted:
Slot
<void
>
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:116
flavour
flavour:
string
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:103
id
id:
string
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:109
index
index:
string
Inherited from
Source
packages/blocks/src/frame-block/frame-model.ts:15
keys
keys:
string
[]
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:111
page
page:
Doc
Deprecated
use doc instead
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:108
pop()
pop: (
prop
) =>void
Parameters
• prop: "background"
| "xywh"
| "index"
| "title"
Returns
void
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:113
propsUpdated
propsUpdated:
Slot
<object
>
Type declaration
key
key:
string
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:117
role
role:
"root"
|"hub"
|"content"
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:104
rotate
rotate:
number
=0
Inherited from
Source
packages/blocks/src/root-block/edgeless/type.ts:78
stash()
stash: (
prop
) =>void
Parameters
• prop: "background"
| "xywh"
| "index"
| "title"
Returns
void
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:112
text?
optional
text:Text
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:114
title
title:
Text
Inherited from
selectable<FrameBlockProps>(BlockModel).title
Source
packages/blocks/src/frame-block/frame-model.ts:12
version
version:
number
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:102
xywh
xywh:
[${number},${number},${number},${number}]
Inherited from
Source
packages/blocks/src/frame-block/frame-model.ts:14
yBlock
yBlock:
YBlock
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:110
PADDING
static
PADDING:number
[]
Source
packages/blocks/src/frame-block/frame-model.ts:38
Accessors
childMap
get
childMap():Map
<string
,number
>
Returns
Map
<string
, number
>
Source
packages/framework/store/dist/schema/base.d.ts:123
children
get
children():BlockModel
<object
>[]
Returns
BlockModel
<object
>[]
Source
packages/framework/store/dist/schema/base.d.ts:124
doc
get
doc():Doc
set
doc(doc
):void
Parameters
• doc: Doc
Returns
Source
packages/framework/store/dist/schema/base.d.ts:121
elementBound
get
elementBound():Bound
Returns
Source
packages/blocks/src/root-block/edgeless/type.ts:94
externalBound
get
externalBound():null
|Bound
Returns
null
| Bound
Source
packages/blocks/src/root-block/edgeless/type.ts:90
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}]
Source
packages/blocks/src/root-block/edgeless/type.ts:82
group
get
group():null
|GroupLikeModel
<BaseProps
>
Returns
null
| GroupLikeModel
<BaseProps
>
Source
packages/blocks/src/root-block/edgeless/type.ts:156
groups
get
groups():GroupLikeModel
<BaseProps
>[]
Returns
GroupLikeModel
<BaseProps
>[]
Source
packages/blocks/src/root-block/edgeless/type.ts:164
Methods
boxSelect()
boxSelect(
selectedBound
):boolean
Parameters
• selectedBound: Bound
Returns
boolean
Overrides
Source
packages/blocks/src/frame-block/frame-model.ts:68
containedByBounds()
containedByBounds(
bounds
):boolean
Parameters
• bounds: Bound
Returns
boolean
Inherited from
EdgelessBlock
.containedByBounds
Source
packages/blocks/src/root-block/edgeless/type.ts:104
dispose()
dispose():
void
Returns
void
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:128
firstChild()
firstChild():
null
|BlockModel
<object
>
Returns
null
| BlockModel
<object
>
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:126
getNearestPoint()
getNearestPoint(
point
):IVec
Parameters
• point: IVec
Returns
IVec
Inherited from
Source
packages/blocks/src/root-block/edgeless/type.ts:116
getRelativePointLocation()
getRelativePointLocation(
relativePoint
):PointLocation
Parameters
• relativePoint: IVec
Returns
PointLocation
Inherited from
EdgelessBlock
.getRelativePointLocation
Source
packages/blocks/src/root-block/edgeless/type.ts:133
hitTest()
hitTest(
x
,y
,_
,host
):boolean
Parameters
• x: number
• y: number
• _: HitTestOptions
• host: EditorHost
Returns
boolean
Overrides
Source
packages/blocks/src/frame-block/frame-model.ts:40
intersectWithLine()
intersectWithLine(
start
,end
):null
|PointLocation
[]
Parameters
• start: IVec
• end: IVec
Returns
null
| PointLocation
[]
Inherited from
EdgelessBlock
.intersectWithLine
Source
packages/blocks/src/root-block/edgeless/type.ts:124
isEmpty()
isEmpty():
boolean
Returns
boolean
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:125
lastChild()
lastChild():
null
|BlockModel
<object
>
Returns
null
| BlockModel
<object
>
Inherited from
Source
packages/framework/store/dist/schema/base.d.ts:127