BlockSuite API Documentation / @blocksuite/blocks / MindmapElementModel
Class: MindmapElementModel
Extends
SurfaceGroupLikeModel<MindmapElementProps>
Extended by
Constructors
new MindmapElementModel()
new MindmapElementModel(
options):MindmapElementModel
Parameters
options
id
string
model
onChange
(payload) => void
stashedStore
Map<unknown, unknown>
yMap
YMap<unknown>
Returns
Inherited from
SurfaceGroupLikeModel.constructor
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:61
Properties
_disposable
protected_disposable:DisposableGroup
Inherited from
SurfaceGroupLikeModel._disposable
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:24
_id
protected_id:string
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:25
_local
protected_local:Map<string|symbol,unknown>
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:26
_onChange()
protected_onChange: (payload) =>void
Parameters
payload
local
boolean
oldValues
Record<string, unknown>
props
Record<string, unknown>
Returns
void
Inherited from
SurfaceGroupLikeModel._onChange
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:27
_preserved
protected_preserved:Map<string,unknown>
Used to store a copy of data in the yMap.
Inherited from
SurfaceGroupLikeModel._preserved
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:35
_stashed
protected_stashed:Map<string,unknown>
Inherited from
SurfaceGroupLikeModel._stashed
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:36
[gfxGroupCompatibleSymbol]
[gfxGroupCompatibleSymbol]:
true
Inherited from
SurfaceGroupLikeModel.[gfxGroupCompatibleSymbol]
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:105
connectors
connectors:
Map<string,LocalConnectorElementModel>
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:67
extraConnectors
extraConnectors:
Map<string,LocalConnectorElementModel>
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:68
surface
surface:
SurfaceBlockModel
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:38
yMap
yMap:
YMap<unknown>
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:40
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[]
Inherited from
SurfaceGroupLikeModel.childElements
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:106
childIds
Get Signature
get childIds():
string[]
The ids of the children. Its role is to provide a unique way to access the children. You should update this field through setChildIds when the children are added or removed.
Returns
string[]
Inherited from
SurfaceGroupLikeModel.childIds
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:111
children
Overrides
SurfaceGroupLikeModel.children
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:140
connectable
Get Signature
get connectable():
boolean
Returns
boolean
Inherited from
SurfaceGroupLikeModel.connectable
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:41
descendantElements
Get Signature
get descendantElements():
GfxModel[]
Returns
GfxModel[]
Inherited from
SurfaceGroupLikeModel.descendantElements
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:112
deserializedXYWH
Get Signature
get deserializedXYWH():
XYWH
Returns
XYWH
Inherited from
SurfaceGroupLikeModel.deserializedXYWH
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:42
display
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:88
elementBound
Get Signature
get elementBound():
Bound
The bound of the element after rotation. The bound without rotation should be created by Bound.deserialize(this.xywh).
Returns
Bound
Inherited from
SurfaceGroupLikeModel.elementBound
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:47
externalBound
Get Signature
get externalBound():
null|Bound
Returns
null | Bound
Inherited from
SurfaceGroupLikeModel.externalBound
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:48
externalXYWH
In some cases, you need to draw something related to the element, but it does not belong to the element itself. And it is also interactive, you can select element by clicking on it. E.g. the title of the group element. In this case, we need to store this kind of external xywh in order to do hit test. This property should not be synced to the doc. This property should be updated every time it gets rendered.
Inherited from
SurfaceGroupLikeModel.externalXYWH
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:95
group
Get Signature
get group():
null|GfxGroupModel
Returns
null | GfxGroupModel
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:49
groups
Get Signature
get groups():
GfxGroupModel[]
Return the ancestor elements in order from the most recent to the earliest.
Returns
GfxGroupModel[]
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:53
h
Get Signature
get h():
number
Returns
number
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:54
id
Get Signature
get id():
string
Returns
string
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:55
index
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:96
isConnected
Get Signature
get isConnected():
boolean
Returns
boolean
Inherited from
SurfaceGroupLikeModel.isConnected
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:56
layoutType
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:141
lockedBySelf
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.
Inherited from
SurfaceGroupLikeModel.lockedBySelf
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:97
nodeMap
Get Signature
get nodeMap():
Map<string,MindmapNode>
Returns
Map<string, MindmapNode>
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:69
opacity
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:98
rotate
Get Signature
get rotate():
number
Returns
number
Set Signature
set rotate(
_):void
Parameters
_
number
Returns
void
Overrides
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:70
seed
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:99
style
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:142
styleGetter
Get Signature
get styleGetter():
MindmapStyleGetter
Returns
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:72
tree
Get Signature
get tree():
MindmapRoot
Returns
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:73
type
Get Signature
get type():
string
Returns
string
Overrides
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:74
w
Get Signature
get w():
number
Returns
number
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:58
x
Get Signature
get x():
number
Returns
number
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:59
xywh
Get Signature
get xywh(): `[${number},${number},${number},${number}]`
Returns
`[${number},${number},${number},${number}]`
Set Signature
set xywh(
_):void
Parameters
_
`[${number},${number},${number},${number}]`
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:113
y
Get Signature
get y():
number
Returns
number
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:60
Methods
_getXYWH()
protected_getXYWH():Bound
Returns
Bound
Overrides
SurfaceGroupLikeModel._getXYWH
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:78
addChild()
addChild(
_element):void
Parameters
_element
GfxModel
Returns
void
Deprecated
you should not call this method directly
Overrides
SurfaceGroupLikeModel.addChild
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:83
addConnector()
protectedaddConnector(from,to,layout,connectorStyle,extra?):LocalConnectorElementModel
Parameters
from
to
layout
connectorStyle
extra?
boolean
Returns
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:84
addNode()
addNode(
parent,sibling?,position?,props?):string
Parameters
parent
The parent node id of the new node. If it's null, the node will be the root node
null | string | MindmapNode
sibling?
string | number
position?
"before" | "after"
props?
Record<string, unknown>
Returns
string
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:85
buildTree()
buildTree():
void
Returns
void
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:90
containsBound()
containsBound(
bounds):boolean
Parameters
bounds
Bound
Returns
boolean
Inherited from
SurfaceGroupLikeModel.containsBound
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:73
getChildNodes()
getChildNodes(
id,subtree?):MindmapNode[]
Parameters
id
string
subtree?
The subtree of root, this only take effects when the layout type is BALANCED.
"left" | "right"
Returns
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:96
getConnector()
getConnector(
from,to):null|LocalConnectorElementModel
Parameters
from
to
Returns
null | LocalConnectorElementModel
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:97
getLayoutDir()
getLayoutDir(
node):LayoutType
Parameters
node
string | MindmapNode
Returns
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:98
getLineIntersections()
getLineIntersections(
start,end):null|PointLocation[]
Parameters
start
IVec
end
IVec
Returns
null | PointLocation[]
Inherited from
SurfaceGroupLikeModel.getLineIntersections
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:74
getNearestPoint()
getNearestPoint(
point):IVec
Parameters
point
IVec
Returns
IVec
Inherited from
SurfaceGroupLikeModel.getNearestPoint
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:75
getNode()
getNode(
id):null|MindmapNode
Parameters
id
string
Returns
null | MindmapNode
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:99
getParentNode()
getParentNode(
id):null|MindmapNode
Parameters
id
string
Returns
null | MindmapNode
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:100
getPath()
getPath(
element):number[]
Path is an array of indexes that represent the path from the root node to the target node. The first element of the array is always 0, which represents the root node.
Parameters
element
string | MindmapNode
Returns
number[]
Example
const path = mindmap.getPath('nodeId');
// [0, 1, 2]Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:113
getRelativePointLocation()
getRelativePointLocation(
relativePoint):PointLocation
Parameters
relativePoint
IVec
Returns
PointLocation
Inherited from
SurfaceGroupLikeModel.getRelativePointLocation
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:76
getSiblingNode()
getSiblingNode(
id,direction?,subtree?):null|MindmapNode
Parameters
id
string
direction?
"prev" | "next"
subtree?
The subtree of which that the sibling node belongs to, this is used when the layout type is BALANCED.
"left" | "right"
Returns
null | MindmapNode
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:114
hasChild()
hasChild(
element):boolean
The actual field that stores the children of the group. It should be a ymap decorated with @field.
Parameters
element
GfxModel
Returns
boolean
Inherited from
SurfaceGroupLikeModel.hasChild
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:121
hasDescendant()
hasDescendant(
element):boolean
Check if the group has the given descendant.
Parameters
element
GfxModel
Returns
boolean
Inherited from
SurfaceGroupLikeModel.hasDescendant
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:125
includesPoint()
includesPoint(
x,y,options):boolean
Parameters
x
number
y
number
options
PointTestOptions
Returns
boolean
Overrides
SurfaceGroupLikeModel.includesPoint
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:120
intersectsBound()
intersectsBound(
bound):boolean
Parameters
bound
Bound
Returns
boolean
Inherited from
SurfaceGroupLikeModel.intersectsBound
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:78
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
SurfaceGroupLikeModel.isLocked
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:79
isLockedByAncestor()
isLockedByAncestor():
boolean
Returns
boolean
Inherited from
SurfaceGroupLikeModel.isLockedByAncestor
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:80
isLockedBySelf()
isLockedBySelf():
boolean
Returns
boolean
Inherited from
SurfaceGroupLikeModel.isLockedBySelf
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:81
layout()
layout(
_tree?,_options?):void
Parameters
_tree?
_options?
applyStyle
boolean
calculateTreeBound
boolean
layoutType
stashed
boolean
Returns
void
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:121
lock()
lock():
void
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:82
moveTo()
moveTo(
targetXYWH):void
Parameters
targetXYWH
XYWH | `[${number},${number},${number},${number}]`
Returns
void
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:127
onCreated()
onCreated():
void
Returns
void
Overrides
SurfaceGroupLikeModel.onCreated
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:128
pop()
pop(
prop):void
Parameters
prop
string
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:84
removeChild()
removeChild(
element):void
Remove the child from the group
Parameters
element
GfxModel
Returns
void
Overrides
SurfaceGroupLikeModel.removeChild
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:129
requestBuildTree()
protectedrequestBuildTree():void
Returns
void
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:130
requestLayout()
requestLayout():
void
Returns
void
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:131
serialize()
serialize():
SerializedMindmapElement
Returns
Overrides
SurfaceGroupLikeModel.serialize
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:132
setChildIds()
setChildIds(
value,fromLocal):void
Set the new value of the childIds
Parameters
value
string[]
the new value of the childIds
fromLocal
boolean
if true, the change is happened in the local
Returns
void
Inherited from
SurfaceGroupLikeModel.setChildIds
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:135
stash()
stash(
prop):void
Parameters
prop
string
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:86
stashTree()
stashTree(
node):undefined| () =>void
Stash mind map node and its children's xywh property
Parameters
node
string | MindmapNode
Returns
undefined | () => void
a function that write back the stashed xywh into yjs
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:138
traverse()
traverse(
callback):void
Parameters
callback
(node, parent) => void
Returns
void
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:139
unlock()
unlock():
void
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:87
propsToY()
staticpropsToY(props):MindmapElementProps
Parameters
props
Record<string, unknown>
Returns
MindmapElementProps
Overrides
SurfaceGroupLikeModel.propsToY
Defined in
packages/affine/model/dist/elements/mindmap/mindmap.d.ts:75