BlockSuite API Documentation / @blocksuite/blocks / SurfaceService

Class: SurfaceService

Contents

• Extends
• Constructors
  • new SurfaceService(options)
• Properties
  • TemplateJob
  • disposables
  • flavour
  • slots
  • std
• Accessors
  • currentTool
  • page
  • selectionManager
  • uiEventDispatcher
  • workspace
• Methods
  • _getSurfaceView()
  • bindHotKey()
  • dispose()
  • handleEvent()
  • mounted()
  • setNavigatorMode()
  • unmounted()

Extends

• BlockService<SurfaceBlockModel>

Constructors

new SurfaceService(options)

new SurfaceService(options): SurfaceService

Parameters

• options: BlockServiceOptions

Returns

SurfaceService

Inherited from

@blocksuite/block-std.BlockService.constructor

Source

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

Properties

TemplateJob

TemplateJob: typeof TemplateJob = TemplateJob

Source

packages/blocks/src/surface-block/surface-service.ts:12

---

disposables

readonly disposables: DisposableGroup

Inherited from

@blocksuite/block-std.BlockService.disposables

Source

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

---

flavour

readonly flavour: string

Inherited from

@blocksuite/block-std.BlockService.flavour

Source

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

---

slots

slots: Object

Type declaration

edgelessToolUpdated

edgelessToolUpdated: Slot<EdgelessTool>

Source

packages/blocks/src/surface-block/surface-service.ts:13

---

std

readonly std: BlockStdScope

Inherited from

@blocksuite/block-std.BlockService.std

Source

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

Accessors

currentTool

get currentTool(): null | EdgelessTool

Returns

null | EdgelessTool

Source

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

---

page

get page(): Page

Returns

Page

Source

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

---

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

---

workspace

get workspace(): Workspace

Returns

Workspace

Source

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

Methods

_getSurfaceView()

private _getSurfaceView(): SurfaceBlockComponent

Returns

SurfaceBlockComponent

Source

packages/blocks/src/surface-block/surface-service.ts:17

---

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

---

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

---

mounted()

mounted(): void

Returns

void

Inherited from

@blocksuite/block-std.BlockService.mounted

Source

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

---

setNavigatorMode()

setNavigatorMode(on, mode?): void

Parameters

• on: boolean

• mode?: NavigatorMode

Returns

void

Source

packages/blocks/src/surface-block/surface-service.ts:34

---

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