BlockSuite API Documentation / @blocksuite/affine-model / FrameBlockModel
Class: FrameBlockModel
Extends
Implements
GfxElementGeometryGfxGroupCompatibleInterface
Constructors
new FrameBlockModel()
new FrameBlockModel():
FrameBlockModel
Returns
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).constructor
Defined in
packages/framework/store/dist/schema/base.d.ts:129
Properties
[gfxGroupCompatibleSymbol]
[gfxGroupCompatibleSymbol]:
true
Implementation of
GfxGroupCompatibleInterface.[gfxGroupCompatibleSymbol]
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:56
[modelLabel]
[modelLabel]:
FrameBlockProps
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).[modelLabel]
Defined in
packages/framework/store/dist/schema/base.d.ts:115
background
background:
Color
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).background
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:25
background$
background$:
Signal<Color>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).background$
childElementIds?
optionalchildElementIds:Record<string,boolean>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).childElementIds
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:26
childElementIds$
childElementIds$:
Signal<undefined|Record<string,boolean>>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).childElementIds$
childMap
childMap:
ReadonlySignal<Map<string,number>>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).childMap
Defined in
packages/framework/store/dist/schema/base.d.ts:108
connectable
connectable:
boolean
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).connectable
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:33
created
created:
Slot<void>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).created
Defined in
packages/framework/store/dist/schema/base.d.ts:109
deleted
deleted:
Slot<void>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).deleted
Defined in
packages/framework/store/dist/schema/base.d.ts:110
flavour
flavour:
string
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).flavour
Defined in
packages/framework/store/dist/schema/base.d.ts:111
id
id:
string
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).id
Defined in
packages/framework/store/dist/schema/base.d.ts:112
index
index:
string
Implementation of
GfxGroupCompatibleInterface.index
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).index
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:13
index$
index$:
Signal<string>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).index$
isEmpty
isEmpty:
ReadonlySignal<boolean>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).isEmpty
Defined in
packages/framework/store/dist/schema/base.d.ts:113
keys
keys:
string[]
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).keys
Defined in
packages/framework/store/dist/schema/base.d.ts:114
lockedBySelf?
optionallockedBySelf:boolean
Implementation of
GfxGroupCompatibleInterface.lockedBySelf
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).lockedBySelf
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:14
lockedBySelf$
lockedBySelf$:
Signal<undefined|boolean>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).lockedBySelf$
page
page:
Doc
Deprecated
use doc instead
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).page
Defined in
packages/framework/store/dist/schema/base.d.ts:104
pop()
pop: (
prop) =>void
Parameters
prop
"xywh" | "index" | "lockedBySelf" | "title" | "background" | "childElementIds" | "presentationIndex"
Returns
void
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).pop
Defined in
packages/framework/store/dist/schema/base.d.ts:116
presentationIndex?
optionalpresentationIndex:string
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).presentationIndex
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:27
presentationIndex$
presentationIndex$:
Signal<undefined|string>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).presentationIndex$
propsUpdated
propsUpdated:
Slot<{key:string; }>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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.
Implementation of
GfxGroupCompatibleInterface.responseExtension
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).responseExtension
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:49
role
role:
"root"|"hub"|"content"
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).role
Defined in
packages/framework/store/dist/schema/base.d.ts:120
rotate
rotate:
number
Implementation of
GfxGroupCompatibleInterface.rotate
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).rotate
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:50
stash()
stash: (
prop) =>void
Parameters
prop
"xywh" | "index" | "lockedBySelf" | "title" | "background" | "childElementIds" | "presentationIndex"
Returns
void
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).stash
Defined in
packages/framework/store/dist/schema/base.d.ts:121
text?
optionaltext:Text
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).text
Defined in
packages/framework/store/dist/schema/base.d.ts:122
title
title:
Text
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).title
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:24
title$
title$:
Signal<Text>
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).title$
version
version:
number
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).version
Defined in
packages/framework/store/dist/schema/base.d.ts:123
xywh
xywh: `[${number},${number},${number},${number}]`
Implementation of
GfxGroupCompatibleInterface.xywh
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
GfxCompatible<FrameBlockProps>(BlockModel).xywh$
yBlock
yBlock:
YBlock
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).yBlock
Defined in
packages/framework/store/dist/schema/base.d.ts:124
Accessors
childElements
Get Signature
get childElements():
GfxModel[]
All child element models of this container. Note that the childElements may not contains all the children in childIds, because some children may not be loaded.
Returns
GfxModel[]
Implementation of
GfxGroupCompatibleInterface.childElements
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:58
childIds
Get Signature
get childIds():
string[]
All child ids of this container.
Returns
string[]
Implementation of
GfxGroupCompatibleInterface.childIds
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:74
children
Get Signature
get children():
BlockModel<object,SignaledProps<object>>[]
Returns
BlockModel<object, SignaledProps<object>>[]
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).children
Defined in
packages/framework/store/dist/schema/base.d.ts:125
descendantElements
Get Signature
get descendantElements():
GfxModel[]
Returns
GfxModel[]
Implementation of
GfxGroupCompatibleInterface.descendantElements
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:78
deserializedXYWH
Get Signature
get deserializedXYWH():
XYWH
Returns
XYWH
Implementation of
GfxGroupCompatibleInterface.deserializedXYWH
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).deserializedXYWH
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:51
doc
Get Signature
get doc():
Doc
Returns
Set Signature
set doc(
doc):void
Parameters
doc
Returns
void
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
Implementation of
GfxGroupCompatibleInterface.elementBound
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
GfxCompatible<FrameBlockProps>(BlockModel).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
GfxCompatible<FrameBlockProps>(BlockModel).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
Implementation of
GfxGroupCompatibleInterface.group
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).group
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:56
groups
Get Signature
get groups():
GfxGroupModel[]
Returns
GfxGroupModel[]
Implementation of
GfxGroupCompatibleInterface.groups
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).groups
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:57
h
Get Signature
get h():
number
Returns
number
Implementation of
GfxGroupCompatibleInterface.h
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
GfxCompatible<FrameBlockProps>(BlockModel).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
Implementation of
GfxGroupCompatibleInterface.responseBound
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
GfxCompatible<FrameBlockProps>(BlockModel).surface
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:60
w
Get Signature
get w():
number
Returns
number
Implementation of
GfxGroupCompatibleInterface.w
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).w
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:61
x
Get Signature
get x():
number
Returns
number
Implementation of
GfxGroupCompatibleInterface.x
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).x
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:62
y
Get Signature
get y():
number
Returns
number
Implementation of
GfxGroupCompatibleInterface.y
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).y
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:63
Methods
[dispose]()
[dispose]():
void
Returns
void
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).[dispose]
Defined in
packages/framework/store/dist/schema/base.d.ts:133
addChild()
addChild(
element):void
Parameters
element
GfxModel
Returns
void
Implementation of
GfxGroupCompatibleInterface.addChild
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:82
addChildren()
addChildren(
elements):void
Parameters
elements
GfxModel[]
Returns
void
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:90
containsBound()
containsBound(
bound):boolean
Parameters
bound
Bound
Returns
boolean
Implementation of
GfxElementGeometry.containsBound
Overrides
GfxCompatible<FrameBlockProps>(BlockModel).containsBound
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:109
dispose()
dispose():
void
Returns
void
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
GfxCompatible<FrameBlockProps>(BlockModel).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[]
Implementation of
GfxElementGeometry.getLineIntersections
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
Implementation of
GfxElementGeometry.getNearestPoint
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
Implementation of
GfxElementGeometry.getRelativePointLocation
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).getRelativePointLocation
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:67
hasChild()
hasChild(
element):boolean
Parameters
element
GfxModel
Returns
boolean
Implementation of
GfxGroupCompatibleInterface.hasChild
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:113
hasDescendant()
hasDescendant(
element):boolean
Parameters
element
GfxModel
Returns
boolean
Implementation of
GfxGroupCompatibleInterface.hasDescendant
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:117
includesPoint()
includesPoint(
x,y,_):boolean
Parameters
x
number
y
number
_
PointTestOptions
Returns
boolean
Implementation of
GfxElementGeometry.includesPoint
Overrides
GfxCompatible<FrameBlockProps>(BlockModel).includesPoint
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:121
intersectsBound()
intersectsBound(
selectedBound):boolean
Parameters
selectedBound
Bound
Returns
boolean
Implementation of
GfxElementGeometry.intersectsBound
Overrides
GfxCompatible<FrameBlockProps>(BlockModel).intersectsBound
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:126
isLocked()
isLocked():
boolean
Check if the element is locked. It will check the lock status of the element and its ancestors.
Returns
boolean
Implementation of
GfxGroupCompatibleInterface.isLocked
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).isLocked
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:70
isLockedByAncestor()
isLockedByAncestor():
boolean
Returns
boolean
Implementation of
GfxGroupCompatibleInterface.isLockedByAncestor
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).isLockedByAncestor
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:71
isLockedBySelf()
isLockedBySelf():
boolean
Returns
boolean
Implementation of
GfxGroupCompatibleInterface.isLockedBySelf
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).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
GfxCompatible<FrameBlockProps>(BlockModel).lastChild
Defined in
packages/framework/store/dist/schema/base.d.ts:132
lock()
lock():
void
Returns
void
Implementation of
GfxGroupCompatibleInterface.lock
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).lock
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:73
removeChild()
removeChild(
element):void
Parameters
element
GfxModel
Returns
void
Implementation of
GfxGroupCompatibleInterface.removeChild
Defined in
packages/affine/model/src/blocks/frame/frame-model.ts:133
unlock()
unlock():
void
Returns
void
Implementation of
GfxGroupCompatibleInterface.unlock
Inherited from
GfxCompatible<FrameBlockProps>(BlockModel).unlock
Defined in
packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:74