BlockSuite API Documentation / @blocksuite/affine-block-surface / SurfaceBlockModel

Class: SurfaceBlockModel

Defined in: packages/affine/blocks/block-surface/src/surface-model.ts:44

Extends

• SurfaceBlockModel

Constructors

new SurfaceBlockModel()

new SurfaceBlockModel(): SurfaceBlockModel

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:76

Returns

SurfaceBlockModel

Inherited from

BaseSurfaceModel.constructor

Properties

_decoratorState

protected _decoratorState: object

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:36

creating

creating: boolean

deriving

deriving: boolean

skipField

skipField: boolean

Inherited from

BaseSurfaceModel._decoratorState

---

_elementCtorMap

protected _elementCtorMap: Record<string, Constructor<SurfaceElementModel<BaseElementProps>, [object]>>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:41

Inherited from

BaseSurfaceModel._elementCtorMap

---

_elementModels

protected _elementModels: Map<string, { model: SurfaceElementModel; mount: () => void; unmount: () => void; }>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:42

Inherited from

BaseSurfaceModel._elementModels

---

_elementTypeMap

protected _elementTypeMap: Map<string, SurfaceElementModel<BaseElementProps>[]>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:47

Inherited from

BaseSurfaceModel._elementTypeMap

---

_groupLikeModels

protected _groupLikeModels: Map<string, GfxGroupModel>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:48

Inherited from

BaseSurfaceModel._groupLikeModels

---

_middlewares

protected _middlewares: SurfaceMiddleware[]

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:49

Inherited from

BaseSurfaceModel._middlewares

---

_props

_props: SignaledProps<SurfaceBlockProps>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:33

Inherited from

BaseSurfaceModel._props

---

_surfaceBlockModel

protected _surfaceBlockModel: boolean

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:50

Inherited from

BaseSurfaceModel._surfaceBlockModel

---

[modelLabel]

[modelLabel]: SurfaceBlockProps

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:24

Inherited from

BaseSurfaceModel.[modelLabel]

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:17

Inherited from

BaseSurfaceModel.childMap

---

created

created: Subject<void>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:18

Inherited from

BaseSurfaceModel.created

---

deleted

deleted: Subject<void>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:19

Inherited from

BaseSurfaceModel.deleted

---

elementAdded

elementAdded: Subject<{ id: string; local: boolean; }>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:52

Inherited from

BaseSurfaceModel.elementAdded

---

elementRemoved

elementRemoved: Subject<{ id: string; local: boolean; model: SurfaceElementModel; type: string; }>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:56

Inherited from

BaseSurfaceModel.elementRemoved

---

elementUpdated

elementUpdated: Subject<ElementUpdatedData>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:62

Inherited from

BaseSurfaceModel.elementUpdated

---

id

id: string

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:20

Inherited from

BaseSurfaceModel.id

---

keys

keys: string[]

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:23

Inherited from

BaseSurfaceModel.keys

---

localElementAdded

localElementAdded: Subject<GfxLocalElementModel>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:63

Inherited from

BaseSurfaceModel.localElementAdded

---

localElementDeleted

localElementDeleted: Subject<GfxLocalElementModel>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:64

Inherited from

BaseSurfaceModel.localElementDeleted

---

localElements

protected localElements: Set<GfxLocalElementModel>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:51

Inherited from

BaseSurfaceModel.localElements

---

localElementUpdated

localElementUpdated: Subject<{ model: GfxLocalElementModel; oldValues: Record<string, unknown>; props: Record<string, unknown>; }>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:65

Inherited from

BaseSurfaceModel.localElementUpdated

---

pop()

pop: (prop) => void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:25

Parameters

prop

"elements"

Returns

void

Inherited from

BaseSurfaceModel.pop

---

propsUpdated

propsUpdated: Subject<{ key: string; }>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:26

Inherited from

BaseSurfaceModel.propsUpdated

---

schema

schema: object

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:21

model

model: object

model.children?

optional model.children: string[]

model.flavour

model.flavour: string

model.isFlatData?

optional model.isFlatData: boolean

model.parent?

optional model.parent: string[]

model.props()?

optional model.props: (args_0, ...args) => Record<string, any>

Parameters

args_0

InternalPrimitives

args

...unknown[]

Returns

Record<string, any>

model.role

model.role: "root" | "hub" | "content"

model.toModel()?

optional model.toModel: (...args) => BlockModel<object>

Parameters

args

...unknown[]

Returns

BlockModel<object>

transformer()?

optional transformer: (args_0, ...args) => BaseBlockTransformer<object>

Parameters

args_0

Map<string, unknown>

args

...unknown[]

Returns

BaseBlockTransformer<object>

version

version: number

Inherited from

BaseSurfaceModel.schema

---

stash()

stash: (prop) => void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:29

Parameters

prop

"elements"

Returns

void

Inherited from

BaseSurfaceModel.stash

---

yBlock

yBlock: YBlock

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:32

Inherited from

BaseSurfaceModel.yBlock

Accessors

children

Get Signature

get children(): BlockModel<object>[]

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:37

Returns

BlockModel<object>[]

Inherited from

BaseSurfaceModel.children

---

doc

Get Signature

get doc(): Store

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:38

Returns

Store

Set Signature

set doc(doc): void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:39

Parameters

doc

Store

Returns

void

Inherited from

BaseSurfaceModel.doc

---

elementModels

Get Signature

get elementModels(): SurfaceElementModel<BaseElementProps>[]

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:71

Returns

SurfaceElementModel<BaseElementProps>[]

Inherited from

BaseSurfaceModel.elementModels

---

elements

Get Signature

get elements(): Boxed<YMap<YMap<unknown>>>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:72

Returns

Boxed<YMap<YMap<unknown>>>

Inherited from

BaseSurfaceModel.elements

---

flavour

Get Signature

get flavour(): string

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:35

Returns

string

Inherited from

BaseSurfaceModel.flavour

---

localElementModels

Get Signature

get localElementModels(): Set<GfxLocalElementModel>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:73

Returns

Set<GfxLocalElementModel>

Inherited from

BaseSurfaceModel.localElementModels

---

parent

Get Signature

get parent(): null | BlockModel<object>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:40

Returns

null | BlockModel<object>

Inherited from

BaseSurfaceModel.parent

---

props

Get Signature

get props(): SignaledProps<Props>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:34

Returns

SignaledProps<Props>

Inherited from

BaseSurfaceModel.props

---

registeredElementTypes

Get Signature

get registeredElementTypes(): string[]

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:74

Returns

string[]

Inherited from

BaseSurfaceModel.registeredElementTypes

---

role

Get Signature

get role(): "root" | "hub" | "content"

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:41

Returns

"root" | "hub" | "content"

Inherited from

BaseSurfaceModel.role

---

text

Get Signature

get text(): undefined | Text

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:30

Returns

undefined | Text

Set Signature

set text(text): void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:31

Parameters

text

Text

Returns

void

Inherited from

BaseSurfaceModel.text

---

version

Get Signature

get version(): number

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:36

Returns

number

Inherited from

BaseSurfaceModel.version

Methods

_extendElement()

protected _extendElement(ctorMap): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:83

Parameters

ctorMap

Record<string, Constructor<SurfaceElementModel<BaseElementProps>, [object]>>

Returns

void

Inherited from

BaseSurfaceModel._extendElement

---

_init()

_init(): void

Defined in: packages/affine/blocks/block-surface/src/surface-model.ts:47

Returns

void

Overrides

BaseSurfaceModel._init

---

[dispose]()

[dispose](): void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:46

Returns

void

Inherited from

BaseSurfaceModel.[dispose]

---

addElement()

addElement<T>(props): string

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:96

Type Parameters

T

T extends object = Record<string, unknown>

Parameters

props

Partial<T> & object

Returns

string

Inherited from

BaseSurfaceModel.addElement

---

addLocalElement()

addLocalElement(elem): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:99

Parameters

elem

GfxLocalElementModel

Returns

void

Inherited from

BaseSurfaceModel.addLocalElement

---

applyMiddlewares()

applyMiddlewares(middlewares): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:100

Parameters

middlewares

SurfaceMiddleware[]

Returns

void

Inherited from

BaseSurfaceModel.applyMiddlewares

---

deleteElement()

deleteElement(id): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:101

Parameters

id

string

Returns

void

Inherited from

BaseSurfaceModel.deleteElement

---

deleteLocalElement()

deleteLocalElement(elem): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:102

Parameters

elem

GfxLocalElementModel

Returns

void

Inherited from

BaseSurfaceModel.deleteLocalElement

---

dispose()

dispose(): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:103

Returns

void

Inherited from

BaseSurfaceModel.dispose

---

firstChild()

firstChild(): null | BlockModel<object>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:44

Returns

null | BlockModel<object>

Inherited from

BaseSurfaceModel.firstChild

---

getConnectors()

getConnectors(id): ConnectorElementModel[]

Defined in: packages/affine/blocks/block-surface/src/surface-model.ts:55

Parameters

id

string

Returns

ConnectorElementModel[]

---

getConstructor()

getConstructor(type): Constructor<SurfaceElementModel<BaseElementProps>, [object]>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:85

Parameters

type

string

Returns

Constructor<SurfaceElementModel<BaseElementProps>, [object]>

Inherited from

BaseSurfaceModel.getConstructor

---

getElementById()

getElementById(id): null | SurfaceElementModel<BaseElementProps>

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:104

Parameters

id

string

Returns

null | SurfaceElementModel<BaseElementProps>

Inherited from

BaseSurfaceModel.getElementById

---

getElementsByType()

getElementsByType<K>(type): SurfaceElementModelMap[K][]

Defined in: packages/affine/blocks/block-surface/src/surface-model.ts:65

Type Parameters

K

K extends keyof SurfaceElementModelMap

Parameters

type

K

Returns

SurfaceElementModelMap[K][]

Overrides

BaseSurfaceModel.getElementsByType

---

getGroup()

getGroup(elem): null | GfxGroupModel

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:106

Parameters

elem

string | GfxModel

Returns

null | GfxGroupModel

Inherited from

BaseSurfaceModel.getGroup

---

getGroups()

getGroups(id): GfxGroupModel[]

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:107

Parameters

id

string

Returns

GfxGroupModel[]

Inherited from

BaseSurfaceModel.getGroups

---

hasElementById()

hasElementById(id): boolean

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:108

Parameters

id

string

Returns

boolean

Inherited from

BaseSurfaceModel.hasElementById

---

isEmpty()

isEmpty(): boolean

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:75

Returns

boolean

Inherited from

BaseSurfaceModel.isEmpty

---

isGroup()

Call Signature

isGroup(element): element is GfxModel & GfxGroupCompatibleInterface

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:109

Parameters

element

GfxModel

Returns

element is GfxModel & GfxGroupCompatibleInterface

Inherited from

BaseSurfaceModel.isGroup

Call Signature

isGroup(id): boolean

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:110

Parameters

id

string

Returns

boolean

Inherited from

BaseSurfaceModel.isGroup

---

lastChild()

lastChild(): null | BlockModel<object>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:45

Returns

null | BlockModel<object>

Inherited from

BaseSurfaceModel.lastChild

---

updateElement()

updateElement<T>(id, props): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/surface-model.d.ts:111

Type Parameters

T

T extends object = Record<string, unknown>

Parameters

id

string

props

Partial<T>

Returns

void

Inherited from

BaseSurfaceModel.updateElement