BlockSuite API Documentation / @blocksuite/blocks / PageService

Class: PageService

Extends

• BlockService<PageBlockModel>

Contents

• Constructors
  • new PageService
• Properties
  • _embedBlockRegistry
  • _exportOptions
  • _fileDropOptions
  • disposables
  • exportManager
  • fileDropManager
  • flavour
  • fontLoader
  • std
• Accessors
  • page
  • selectedBlocks
  • selectedModels
  • selectionManager
  • uiEventDispatcher
  • viewportElement
  • workspace
• Methods
  • bindHotKey
  • dispose
  • getEmbedBlockOptions
  • handleEvent
  • loadFonts
  • mounted
  • registerEmbedBlockOptions
  • unmounted

Constructors

new PageService(options)

new PageService(options): PageService

Parameters

• options: BlockServiceOptions

Returns

PageService

Inherited from

@blocksuite/block-std.BlockService.constructor

Source

packages/block-std/dist/service/index.d.ts:13

Properties

_embedBlockRegistry

private _embedBlockRegistry: Set<EmbedOptions>

Source

packages/blocks/src/page-block/page-service.ts:67

---

_exportOptions

private _exportOptions: Object

Type declaration

imageProxyEndpoint

imageProxyEndpoint: string = DEFAULT_IMAGE_PROXY_ENDPOINT

Source

packages/blocks/src/page-block/page-service.ts:53

---

_fileDropOptions

private _fileDropOptions: FileDropOptions

Source

packages/blocks/src/page-block/page-service.ts:49

---

disposables

readonly disposables: DisposableGroup

Inherited from

@blocksuite/block-std.BlockService.disposables

Source

packages/block-std/dist/service/index.d.ts:12

---

exportManager

exportManager: ExportManager

Source

packages/blocks/src/page-block/page-service.ts:47

---

fileDropManager

fileDropManager: FileDropManager

Source

packages/blocks/src/page-block/page-service.ts:46

---

flavour

readonly flavour: string

Inherited from

@blocksuite/block-std.BlockService.flavour

Source

packages/block-std/dist/service/index.d.ts:11

---

fontLoader

readonly fontLoader: FontLoader

Source

packages/blocks/src/page-block/page-service.ts:44

---

std

readonly std: BlockStdScope

Inherited from

@blocksuite/block-std.BlockService.std

Source

packages/block-std/dist/service/index.d.ts:10

Accessors

page

get page(): Page

Returns

Page

Source

packages/block-std/dist/service/index.d.ts:15

---

selectedBlocks

get selectedBlocks(): BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Returns

BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Source

packages/blocks/src/page-block/page-service.ts:160

---

selectedModels

get selectedModels(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

packages/blocks/src/page-block/page-service.ts:179

---

selectionManager

get selectionManager(): SelectionManager

Returns

SelectionManager

Source

packages/block-std/dist/service/index.d.ts:16

---

uiEventDispatcher

get uiEventDispatcher(): UIEventDispatcher

Returns

UIEventDispatcher

Source

packages/block-std/dist/service/index.d.ts:17

---

viewportElement

get viewportElement(): HTMLElement

Returns

HTMLElement

Source

packages/blocks/src/page-block/page-service.ts:57

---

workspace

get workspace(): Workspace

Returns

Workspace

Source

packages/block-std/dist/service/index.d.ts:14

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

• keymap: Record<string, UIEventHandler>

• options?: Object

• options.global?: boolean

Returns

void

Inherited from

@blocksuite/block-std.BlockService.bindHotKey

Source

packages/block-std/dist/service/index.d.ts:24

---

dispose()

dispose(): void

Returns

void

Inherited from

@blocksuite/block-std.BlockService.dispose

Source

packages/block-std/dist/service/index.d.ts:18

---

getEmbedBlockOptions()

getEmbedBlockOptions(url): null | EmbedOptions

Parameters

• url: string

Returns

null | EmbedOptions

Source

packages/blocks/src/page-block/page-service.ts:73

---

handleEvent()

handleEvent(name, fn, options?): void

Parameters

• name: "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "blur" | "focus" | "drop" | "contextMenu" | "wheel"

• fn: UIEventHandler

• options?: Object

• options.global?: boolean

Returns

void

Inherited from

@blocksuite/block-std.BlockService.handleEvent

Source

packages/block-std/dist/service/index.d.ts:21

---

loadFonts()

loadFonts(): void

Returns

void

Source

packages/blocks/src/page-block/page-service.ts:183

---

mounted()

mounted(): void

Returns

void

Overrides

@blocksuite/block-std.BlockService.mounted

Source

packages/blocks/src/page-block/page-service.ts:82

---

registerEmbedBlockOptions()

registerEmbedBlockOptions(options): void

Parameters

• options: EmbedOptions

Returns

void

Source

packages/blocks/src/page-block/page-service.ts:69

---

unmounted()

unmounted(): void

Returns

void

Inherited from

@blocksuite/block-std.BlockService.unmounted

Source

packages/block-std/dist/service/index.d.ts:20

---

Generated using typedoc-plugin-markdown and TypeDoc