BlockSuite API Documentation / @blocksuite/blocks / BlocksUtils

Variable: BlocksUtils

const BlocksUtils: Object

Type declaration

Point

Point: typeof Point

deserializeXYWH

deserializeXYWH: (xywh) => XYWH

Parameters

• xywh: string

Returns

XYWH

isCanvasElement

isCanvasElement: (selectable) => selectable is CanvasElement

Parameters

• selectable: null | EdgelessElement

Returns

selectable is CanvasElement

matchFlavours

matchFlavours: <Key>(model, expected) => model is BlockModels[Key[number]]

Type parameters

• Key extends keyof BlockModels[]

Parameters

• model: null | BaseBlockModel<object>

• expected: Key

Returns

model is BlockModels[Key[number]]

mindMap

mindMap: Object

mindMap.drawInEdgeless

mindMap.drawInEdgeless: (surfaceElement, mindMap) => void = drawMindMap

Parameters

• surfaceElement: SurfaceBlockComponent

• mindMap: TreeNode

Returns

void

mindMap.layout

mindMap.layout: Object

mindMap.layout.bottom

mindMap.layout.bottom: Layout = bottomLayout

mindMap.layout.left

mindMap.layout.left: Layout = leftLayout

mindMap.layout.leftRight

mindMap.layout.leftRight: Layout = leftRightLayout

mindMap.layout.right

mindMap.layout.right: Layout = rightLayout

mindMap.layout.top

mindMap.layout.top: Layout = topLayout

mindMap.layout.topBottom

mindMap.layout.topBottom: Layout = topBottomLayout

splitElements

splitElements: (elements) => Object

Parameters

• elements: EdgelessElement[]

Returns

Object

frames

frames: FrameBlockModel[]

images

images: ImageBlockModel[]

notes

notes: NoteBlockModel[]

shapes

shapes: CanvasElement[]

Source

packages/blocks/src/index.ts:98

---

Generated using typedoc-plugin-markdown and TypeDoc