BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / SurfaceBlockModel

Class: SurfaceBlockModel ​

Contents ​

Extends ​

Constructors ​

new SurfaceBlockModel(undefined) ​

new SurfaceBlockModel(): SurfaceBlockModel

Returns ​

SurfaceBlockModel

Overrides ​

@blocksuite/store.BaseBlockModel.constructor

Source ​

packages/blocks/src/surface-block/surface-model.ts:179

Properties ​

_connectorToElements ​

private _connectorToElements: Map<string, string[]>

Source ​

packages/blocks/src/surface-block/surface-model.ts:163

_disposables ​

private _disposables: () => void[] = []

Source ​

packages/blocks/src/surface-block/surface-model.ts:160

_elementModels ​

private _elementModels: Map<string, Object>

Source ​

packages/blocks/src/surface-block/surface-model.ts:156

_elementToConnector ​

private _elementToConnector: Map<string, string[]>

Source ​

packages/blocks/src/surface-block/surface-model.ts:164

_elementToGroup ​

private _elementToGroup: Map<string, string>

Source ​

packages/blocks/src/surface-block/surface-model.ts:162

_groupToElements ​

private _groupToElements: Map<string, string[]>

Source ​

packages/blocks/src/surface-block/surface-model.ts:161

childrenUpdated ​

childrenUpdated: Slot<void>

Inherited from ​

@blocksuite/store.BaseBlockModel.childrenUpdated

Source ​

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

created ​

created: Slot<void>

Inherited from ​

@blocksuite/store.BaseBlockModel.created

Source ​

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

deleted ​

deleted: Slot<void>

Inherited from ​

@blocksuite/store.BaseBlockModel.deleted

Source ​

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

elementAdded ​

elementAdded: Slot<Object>

Type declaration ​

id ​

id: string

Source ​

packages/blocks/src/surface-block/surface-model.ts:170

elementRemoved ​

elementRemoved: Slot<Object>

Type declaration ​

id ​

id: string

type ​

type: string

Source ​

packages/blocks/src/surface-block/surface-model.ts:171

elementUpdated ​

elementUpdated: Slot<Object>

Type declaration ​

id ​

id: string

props ​

props: Record<string, Object>

Source ​

packages/blocks/src/surface-block/surface-model.ts:166

elements ​

elements: Boxed<Map<Map<unknown>>>

Inherited from ​

BaseBlockModel.elements

Source ​

packages/blocks/src/surface-block/surface-model.ts:26

flavour ​

flavour: string

Inherited from ​

@blocksuite/store.BaseBlockModel.flavour

Source ​

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

id ​

id: string

Inherited from ​

@blocksuite/store.BaseBlockModel.id

Source ​

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

keys ​

keys: string[]

Inherited from ​

@blocksuite/store.BaseBlockModel.keys

Source ​

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

page ​

page: Page

Inherited from ​

@blocksuite/store.BaseBlockModel.page

Source ​

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

pop ​

pop: (prop) => void

Parameters ​

• prop: "elements"

Returns ​

void

Inherited from ​

@blocksuite/store.BaseBlockModel.pop

Source ​

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

propsUpdated ​

propsUpdated: Slot<Object>

Type declaration ​

key ​

key: string

Inherited from ​

@blocksuite/store.BaseBlockModel.propsUpdated

Source ​

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

role ​

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

Inherited from ​

@blocksuite/store.BaseBlockModel.role

Source ​

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

stash ​

stash: (prop) => void

Parameters ​

• prop: "elements"

Returns ​

void

Inherited from ​

@blocksuite/store.BaseBlockModel.stash

Source ​

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

text? ​

text?: Text

Inherited from ​

@blocksuite/store.BaseBlockModel.text

Source ​

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

yBlock ​

yBlock: YBlock

Inherited from ​

@blocksuite/store.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

elementModels ​

get elementModels(): ElementModel<BaseProps>[]

Returns ​

ElementModel<BaseProps>[]

Source ​

packages/blocks/src/surface-block/surface-model.ts:173

Methods ​

_init() ​

private _init(): void

Returns ​

void

Source ​

packages/blocks/src/surface-block/surface-model.ts:184

_initConnector() ​

private _initConnector(): void

Returns ​

void

Source ​

packages/blocks/src/surface-block/surface-model.ts:310

_initElementModels() ​

private _initElementModels(): void

Returns ​

void

Source ​

packages/blocks/src/surface-block/surface-model.ts:190

_initGroup() ​

private _initGroup(): void

Returns ​

void

Source ​

packages/blocks/src/surface-block/surface-model.ts:242

addElement() ​

addElement(props): string

Parameters ​

• props: Record<string, unknown>

Returns ​

string

Source ​

packages/blocks/src/surface-block/surface-model.ts:427

clone() ​

clone(): SurfaceBlockModel

Returns ​

SurfaceBlockModel

Inherited from ​

@blocksuite/store.BaseBlockModel.clone

Source ​

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

dispose() ​

dispose(): void

Returns ​

void

Overrides ​

@blocksuite/store.BaseBlockModel.dispose

Source ​

packages/blocks/src/surface-block/surface-model.ts:396

firstChild() ​

firstChild(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Inherited from ​

@blocksuite/store.BaseBlockModel.firstChild

Source ​

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

getConnectors() ​

getConnectors(id): ElementModel<BaseProps>[]

Parameters ​

• id: string

Returns ​

ElementModel<BaseProps>[]

Source ​

packages/blocks/src/surface-block/surface-model.ts:409

getElementById() ​

getElementById(id): null | ElementModel<BaseProps>

Parameters ​

• id: string

Returns ​

null | ElementModel<BaseProps>

Source ​

packages/blocks/src/surface-block/surface-model.ts:423

getGroup() ​

getGroup(id): null | GroupElementModel

Parameters ​

• id: string

Returns ​

null | GroupElementModel

Source ​

packages/blocks/src/surface-block/surface-model.ts:415

isEmpty() ​

isEmpty(): boolean

Returns ​

boolean

Inherited from ​

@blocksuite/store.BaseBlockModel.isEmpty

Source ​

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

lastChild() ​

lastChild(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Inherited from ​

@blocksuite/store.BaseBlockModel.lastChild

Source ​

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

lastItem() ​

lastItem(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Inherited from ​

@blocksuite/store.BaseBlockModel.lastItem

Source ​

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

removeElement() ​

removeElement(id): void

Parameters ​

• id: string

Returns ​

void

Source ​

packages/blocks/src/surface-block/surface-model.ts:449

updateElement() ​

updateElement(id, props): void

Parameters ​

• id: string

• props: Record<string, unknown>

Returns ​

void

Source ​

packages/blocks/src/surface-block/surface-model.ts:459

Generated using typedoc-plugin-markdown and TypeDoc

Copyright © 2022-present Toeverything