BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/store / Page

Class: Page ​

Contents ​

Extends ​

Constructors ​

new Page(__namedParameters) ​

new Page(__namedParameters): Page

Parameters ​

• __namedParameters: PageOptions

Returns ​

Page

Overrides ​

@blocksuite/store.Space.constructor

Source ​

packages/store/src/workspace/page.ts:86

Properties ​

_blockTree ​

private readonly _blockTree: BlockTree

Source ​

packages/store/src/workspace/page.ts:41

_docLoaded ​

private _docLoaded: boolean = false

Indicate whether the underlying subdoc has been loaded.

Source ​

packages/store/src/workspace/page.ts:45

_history ​

private _history: UndoManager

Source ​

packages/store/src/workspace/page.ts:42

_idGenerator ​

private readonly _idGenerator: IdGenerator

Source ​

packages/store/src/workspace/page.ts:40

_ready ​

private _ready: boolean = false

Indicate whether the block tree is ready

Source ​

packages/store/src/workspace/page.ts:47

_root ​

private _root: null | BaseBlockModel<object> = null

Source ​

packages/store/src/workspace/page.ts:43

_shouldTransact ​

private _shouldTransact: boolean = true

Source ​

packages/store/src/workspace/page.ts:48

_workspace ​

private readonly _workspace: Workspace

Source ​

packages/store/src/workspace/page.ts:39

_yBlocks ​

protected readonly _yBlocks: Map<YBlock>

Inherited from ​

@blocksuite/store.Space._yBlocks

Source ​

packages/store/src/workspace/space.ts:29

_ySpaceDoc ​

protected readonly _ySpaceDoc: Doc

Used for convenient access to the underlying Yjs map, can be used interchangeably with ySpace

Inherited from ​

@blocksuite/store.Space._ySpaceDoc

Source ​

packages/store/src/workspace/space.ts:28

awarenessStore ​

readonly awarenessStore: AwarenessStore<BlockSuiteFlags>

Inherited from ​

@blocksuite/store.Space.awarenessStore

Source ​

packages/store/src/workspace/space.ts:18

id ​

readonly id: string

Inherited from ​

@blocksuite/store.Space.id

Source ​

packages/store/src/workspace/space.ts:16

rootDoc ​

readonly rootDoc: BlockSuiteDoc

Inherited from ​

@blocksuite/store.Space.rootDoc

Source ​

packages/store/src/workspace/space.ts:17

slots ​

readonly slots: Object

Type declaration ​

blockUpdated ​

blockUpdated: Slot<Object | Object | Object>

historyUpdated ​

historyUpdated: Slot<void>

ready ​

ready: Slot<void>

This fires when the block tree is initialized via API call or underlying existing ydoc binary. Note that this is different with the doc.loaded field, since loaded only indicates that the ydoc is loaded, not the block tree.

rootAdded ​

rootAdded: Slot<BaseBlockModel<object>>

This fires when the root block is added via API call or has just been initialized from existing ydoc. useful for internal block UI components to start subscribing following up events. Note that at this moment, the whole block tree may not be fully initialized yet.

rootDeleted ​

rootDeleted: Slot<string | string[]>

Source ​

packages/store/src/workspace/page.ts:50

Accessors ​

Text ​

get Text(): typeof Text

Returns ​

typeof Text

Source ​

packages/store/src/workspace/page.ts:152

blob ​

get blob(): BlobManager

Returns ​

BlobManager

Source ​

packages/store/src/workspace/page.ts:126

canRedo ​

get canRedo(): boolean

Returns ​

boolean

Source ​

packages/store/src/workspace/page.ts:145

canUndo ​

get canUndo(): boolean

Returns ​

boolean

Source ​

packages/store/src/workspace/page.ts:138

history ​

get history(): UndoManager

Returns ​

UndoManager

Source ​

packages/store/src/workspace/page.ts:110

isEmpty ​

get isEmpty(): boolean

Returns ​

boolean

Source ​

packages/store/src/workspace/page.ts:134

loaded ​

get loaded(): boolean

Returns ​

boolean

Source ​

packages/store/src/workspace/space.ts:49

meta ​

get meta(): PageMeta

Returns ​

PageMeta

Source ​

packages/store/src/workspace/page.ts:122

readonly ​

get readonly(): boolean

Returns ​

boolean

Source ​

packages/store/src/workspace/page.ts:102

ready ​

get ready(): boolean

Returns ​

boolean

Source ​

packages/store/src/workspace/page.ts:106

root ​

get root(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Source ​

packages/store/src/workspace/page.ts:130

schema ​

get schema(): Schema

Returns ​

Schema

Source ​

packages/store/src/workspace/page.ts:118

spaceDoc ​

get spaceDoc(): Doc

Returns ​

Doc

Source ​

packages/store/src/workspace/space.ts:53

workspace ​

get workspace(): Workspace

Returns ​

Workspace

Source ​

packages/store/src/workspace/page.ts:114

yBlocks ​

get yBlocks(): Map<State[keyof State]>

Returns ​

Map<State[keyof State]>

Source ​

packages/store/src/workspace/space.ts:45

Methods ​

_getYBlock() ​

private _getYBlock(id): null | YBlock

Parameters ​

• id: string

Returns ​

null | YBlock

Source ​

packages/store/src/workspace/page.ts:680

_handleVersion() ​

private _handleVersion(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:781

_handleYBlockAdd() ​

private _handleYBlockAdd(id): void

Parameters ​

• id: string

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:690

_handleYBlockDelete() ​

private _handleYBlockDelete(id): void

Parameters ​

• id: string

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:739

_handleYEvent() ​

private _handleYEvent(event): void

Parameters ​

• event: YEvent<Text | Array<unknown> | YBlock>

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:756

_handleYEvents() ​

private _handleYEvents(events): void

Parameters ​

• events: YEvent<Text | YBlock>[]

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:775

_historyObserver() ​

private _historyObserver(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:686

_initYBlocks() ​

private _initYBlocks(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:667

addBlock() ​

addBlock(flavour, blockProps, parent?, parentIndex?): string

Parameters ​

• flavour: string

• blockProps: Partial<BlockSysProps & Object & Omit<BlockProps, "flavour">>= {}

• parent?: null | string | BaseBlockModel<object>

• parentIndex?: number

Returns ​

string

Source ​

packages/store/src/workspace/page.ts:327

addBlocks() ​

addBlocks(blocks, parent?, parentIndex?): string[]

Parameters ​

• blocks: Object[]

• parent?: null | string | BaseBlockModel<object>

• parentIndex?: number

Returns ​

string[]

Source ​

packages/store/src/workspace/page.ts:304

addSiblingBlocks() ​

addSiblingBlocks(targetModel, props, place): string[]

Parameters ​

• targetModel: BaseBlockModel<object>

• props: Partial<BlockProps>[]

• place: "after" | "before"= 'after'

Returns ​

string[]

Source ​

packages/store/src/workspace/page.ts:522

captureSync() ​

captureSync(): void

Capture current operations to undo stack synchronously.

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:186

clear() ​

clear(): void

Returns ​

void

Inherited from ​

@blocksuite/store.Space.clear

Source ​

packages/store/src/workspace/space.ts:86

deleteBlock() ​

deleteBlock(model, options): void

Parameters ​

• model: BaseBlockModel<object>

• options: Object= undefined

• options.bringChildrenTo?: BaseBlockModel<object>

• options.deleteChildren?: boolean

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:554

destroy() ​

destroy(): void

Returns ​

void

Inherited from ​

@blocksuite/store.Space.destroy

Source ​

packages/store/src/workspace/space.ts:80

dispose() ​

dispose(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:655

generateBlockId() ​

generateBlockId(): string

Returns ​

string

Source ​

packages/store/src/workspace/page.ts:194

getBlockByFlavour() ​

getBlockByFlavour(blockFlavour): BaseBlockModel<object>[]

Parameters ​

• blockFlavour: string | string[]

Returns ​

BaseBlockModel<object>[]

Source ​

packages/store/src/workspace/page.ts:204

getBlockById() ​

getBlockById<Model>(id): null | Model

Type parameters ​

• Model extends BaseBlockModel<object> = BaseBlockModel<object>

Parameters ​

• id: string

Returns ​

null | Model

Source ​

packages/store/src/workspace/page.ts:198

getInitialPropsByFlavour() ​

getInitialPropsByFlavour(flavour): Record<string, any>

Parameters ​

• flavour: string

Returns ​

Record<string, any>

Source ​

packages/store/src/workspace/page.ts:298

getNextSibling() ​

getNextSibling(block): null | BaseBlockModel<object>

Parameters ​

• block: BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Source ​

packages/store/src/workspace/page.ts:266

getNextSiblings() ​

getNextSiblings(block): BaseBlockModel<object>[]

Parameters ​

• block: BaseBlockModel<object>

Returns ​

BaseBlockModel<object>[]

Source ​

packages/store/src/workspace/page.ts:280

getParent() ​

getParent(target): null | BaseBlockModel<object>

Parameters ​

• target: string | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Source ​

packages/store/src/workspace/page.ts:213

getPreviousSibling() ​

getPreviousSibling(block): null | BaseBlockModel<object>

Parameters ​

• block: BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Source ​

packages/store/src/workspace/page.ts:238

getPreviousSiblings() ​

getPreviousSiblings(block): BaseBlockModel<object>[]

Parameters ​

• block: BaseBlockModel<object>

Returns ​

BaseBlockModel<object>[]

Source ​

packages/store/src/workspace/page.ts:252

getSchemaByFlavour() ​

getSchemaByFlavour(flavour): undefined | Object

Parameters ​

• flavour: string

Returns ​

undefined | Object

Source ​

packages/store/src/workspace/page.ts:294

load() ​

load(initFn?): Promise<Page>

Parameters ​

• initFn?: () => void

Returns ​

Promise<Page>

Overrides ​

@blocksuite/store.Space.load

Source ​

packages/store/src/workspace/page.ts:793

moveBlocks() ​

moveBlocks(blocksToMove, newParent, targetSibling, shouldInsertBeforeSibling): void

Parameters ​

• blocksToMove: BaseBlockModel<object>[]

• newParent: BaseBlockModel<object>

• targetSibling: null | BaseBlockModel<object>= null

• shouldInsertBeforeSibling: boolean= true

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:378

redo() ​

redo(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:177

remove() ​

remove(): void

Returns ​

void

Inherited from ​

@blocksuite/store.Space.remove

Source ​

packages/store/src/workspace/space.ts:75

resetHistory() ​

resetHistory(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:190

transact() ​

transact(fn, shouldTransact): void

If shouldTransact is false, the transaction will not be push to the history stack.

Parameters ​

• fn: () => void

• shouldTransact: boolean= undefined

Returns ​

void

Overrides ​

@blocksuite/store.Space.transact

Source ​

packages/store/src/workspace/page.ts:162

trySyncFromExistingDoc() ​

trySyncFromExistingDoc(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:632

undo() ​

undo(): void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:169

updateBlock() ​

updateBlock(model, props) ​

updateBlock<T>(model, props): void

Type parameters ​

• T extends Partial<BlockProps>

Parameters ​

• model: BaseBlockModel<object>

• props: T

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:470

updateBlock(model, callback) ​

updateBlock(model, callback): void

Parameters ​

• model: BaseBlockModel<object>

• callback: () => void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:474

waitForLoaded() ​

waitForLoaded(): Promise<void>

Returns ​

Promise<void>

Deprecated ​

use page.load() instead

Source ​

packages/store/src/workspace/page.ts:809

withoutTransact() ​

withoutTransact(callback): void

Parameters ​

• callback: () => void

Returns ​

void

Source ​

packages/store/src/workspace/page.ts:156

Generated using typedoc-plugin-markdown and TypeDoc

Copyright © 2022-present Toeverything