BlockSuite API Documentation / @blocksuite/blocks / FrameBlockModel

Class: FrameBlockModel

Contents

• Extends
• Constructors
  • new FrameBlockModel(args)
• Properties
  • background
  • batch
  • childrenUpdated
  • connectable
  • created
  • deleted
  • elementBound
  • flavour
  • id
  • index
  • keys
  • page
  • pop
  • propsUpdated
  • role
  • rotate
  • stash
  • text?
  • title
  • xywh
  • yBlock
• Accessors
  • childMap
  • children
• Methods
  • boxSelect()
  • clone()
  • containedByBounds()
  • dispose()
  • firstChild()
  • getNearestPoint()
  • getRelativePointLocation()
  • hitTest()
  • intersectWithLine()
  • isEmpty()
  • lastChild()
  • lastItem()

Extends

• BaseBlockModel<FrameBlockProps, this> & IEdgelessElement

Constructors

new FrameBlockModel(args)

new FrameBlockModel(...args): FrameBlockModel

Parameters

• ...args: any[]

Returns

FrameBlockModel

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).constructor

Source

packages/global/dist/utils/types.d.ts:1

Properties

background

background: string

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).background

Source

packages/blocks/src/frame-block/frame-model.ts:18

---

batch

batch: string = FRAME_BATCH

Overrides

selectable<FrameBlockProps>( BaseBlockModel ).batch

Source

packages/blocks/src/frame-block/frame-model.ts:46

---

childrenUpdated

childrenUpdated: Slot<void>

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).childrenUpdated

Source

packages/store/dist/schema/base.d.ts:116

---

connectable

connectable: boolean

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).connectable

Source

packages/blocks/src/surface-block/elements/edgeless-element.ts:32

---

created

created: Slot<void>

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).created

Source

packages/store/dist/schema/base.d.ts:111

---

deleted

deleted: Slot<void>

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).deleted

Source

packages/store/dist/schema/base.d.ts:112

---

elementBound

elementBound: Bound

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).elementBound

Source

packages/blocks/src/surface-block/elements/edgeless-element.ts:35

---

flavour

flavour: FRAME

Overrides

selectable<FrameBlockProps>( BaseBlockModel ).flavour

Source

packages/blocks/src/frame-block/frame-model.ts:45

---

id

id: string

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).id

Source

packages/store/dist/schema/base.d.ts:105

---

index

index: string

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).index

Source

packages/blocks/src/frame-block/frame-model.ts:20

---

keys

keys: string[]

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).keys

Source

packages/store/dist/schema/base.d.ts:107

---

page

page: Page

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).page

Source

packages/store/dist/schema/base.d.ts:104

---

pop

pop: (prop) => void

Parameters

• prop: "title" | "background" | "index" | "xywh"

Returns

void

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).pop

Source

packages/store/dist/schema/base.d.ts:109

---

propsUpdated

propsUpdated: Slot<Object>

Type declaration

key

key: string

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).propsUpdated

Source

packages/store/dist/schema/base.d.ts:113

---

role

role: "root" | "hub" | "content"

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).role

Source

packages/store/dist/schema/base.d.ts:103

---

rotate

rotate: number

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).rotate

Source

packages/blocks/src/surface-block/elements/edgeless-element.ts:31

---

stash

stash: (prop) => void

Parameters

• prop: "title" | "background" | "index" | "xywh"

Returns

void

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).stash

Source

packages/store/dist/schema/base.d.ts:108

---

text?

text?: Text

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).text

Source

packages/store/dist/schema/base.d.ts:110

---

title

title: Text

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).title

Source

packages/blocks/src/frame-block/frame-model.ts:17

---

xywh

xywh: `[${number},${number},${number},${number}]`

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).xywh

Source

packages/blocks/src/frame-block/frame-model.ts:19

---

yBlock

yBlock: YBlock

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).yBlock

Source

packages/store/dist/schema/base.d.ts:106

Accessors

childMap

get childMap(): Map<string, number>

Returns

Map<string, number>

Source

packages/store/dist/schema/base.d.ts:117

---

children

get children(): BaseBlockModel<object>[]

Returns

BaseBlockModel<object>[]

Source

packages/store/dist/schema/base.d.ts:118

Methods

boxSelect()

boxSelect(seclectedBound): boolean

Parameters

• seclectedBound: Bound

Returns

boolean

Overrides

selectable<FrameBlockProps>( BaseBlockModel ).boxSelect

Source

packages/blocks/src/frame-block/frame-model.ts:61

---

clone()

clone(): FrameBlockModel

Returns

FrameBlockModel

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).clone

Source

packages/store/dist/schema/base.d.ts:124

---

containedByBounds()

containedByBounds(bounds): boolean

Parameters

• bounds: Bound

Returns

boolean

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).containedByBounds

Source

packages/blocks/src/surface-block/elements/edgeless-element.ts:36

---

dispose()

dispose(): void

Returns

void

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).dispose

Source

packages/store/dist/schema/base.d.ts:123

---

firstChild()

firstChild(): null | BaseBlockModel<object>

Returns

null | BaseBlockModel<object>

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).firstChild

Source

packages/store/dist/schema/base.d.ts:120

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

• point: IVec

Returns

IVec

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).getNearestPoint

Source

packages/blocks/src/surface-block/elements/edgeless-element.ts:37

---

getRelativePointLocation()

getRelativePointLocation(point): PointLocation

Parameters

• point: IVec

Returns

PointLocation

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).getRelativePointLocation

Source

packages/blocks/src/surface-block/elements/edgeless-element.ts:39

---

hitTest()

hitTest(x, y, _): boolean

Parameters

• x: number

• y: number

• _: HitTestOptions

Returns

boolean

Overrides

selectable<FrameBlockProps>( BaseBlockModel ).hitTest

Source

packages/blocks/src/frame-block/frame-model.ts:47

---

intersectWithLine()

intersectWithLine(start, end): null | PointLocation[]

Parameters

• start: IVec

• end: IVec

Returns

null | PointLocation[]

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).intersectWithLine

Source

packages/blocks/src/surface-block/elements/edgeless-element.ts:38

---

isEmpty()

isEmpty(): boolean

Returns

boolean

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).isEmpty

Source

packages/store/dist/schema/base.d.ts:119

---

lastChild()

lastChild(): null | BaseBlockModel<object>

Returns

null | BaseBlockModel<object>

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).lastChild

Source

packages/store/dist/schema/base.d.ts:121

---

lastItem()

lastItem(): null | BaseBlockModel<object>

Returns

null | BaseBlockModel<object>

Inherited from

selectable<FrameBlockProps>( BaseBlockModel ).lastItem

Source

packages/store/dist/schema/base.d.ts:122

---

Generated using typedoc-plugin-markdown and TypeDoc