BlockSuite API Documentation / @blocksuite/affine-block-root / EdgelessRootService

Class: EdgelessRootService

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:48

Deprecated

BlockService is deprecated. You should reconsider where to put your feature.

BlockService is a legacy extension that is used to provide services to the block. In the previous version of BlockSuite, block service provides a way to extend the block. However, in the new version, we recommend using the new extension system.

Extends

• RootService

Implements

• SurfaceContext

Constructors

new EdgelessRootService()

new EdgelessRootService(std, flavourProvider): EdgelessRootService

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:130

Parameters

std

BlockStdScope

flavourProvider

flavour

string

Returns

EdgelessRootService

Overrides

RootService.constructor

Properties

disposables

readonly disposables: DisposableGroup

Defined in: packages/framework/block-std/dist/extension/service.d.ts:20

Inherited from

RootService.disposables

---

elementRenderers

elementRenderers: Record<string, ElementRenderer>

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:53

Implementation of

SurfaceContext.elementRenderers

---

flavour

readonly flavour: string

Defined in: packages/framework/block-std/dist/extension/service.d.ts:21

Inherited from

RootService.flavour

---

flavourProvider

readonly flavourProvider: object

Defined in: packages/framework/block-std/dist/extension/service.d.ts:16

flavour

flavour: string

Inherited from

RootService.flavourProvider

---

specSlots

readonly specSlots: BlockSpecSlots<BlockService>

Defined in: packages/framework/block-std/dist/extension/service.d.ts:22

Inherited from

RootService.specSlots

---

std

readonly std: BlockStdScope

Defined in: packages/framework/block-std/dist/extension/service.d.ts:15

Inherited from

RootService.std

---

TemplateJob

TemplateJob: typeof TemplateJob

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:55

---

flavour

readonly static flavour: "affine:page" = RootBlockSchema.model.flavour

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:49

Overrides

RootService.flavour

Accessors

blocks

Get Signature

get blocks(): GfxBlockElementModel<GfxCompatibleProps>[]

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:57

Returns

GfxBlockElementModel<GfxCompatibleProps>[]

---

collection

Get Signature

get collection(): Workspace

Defined in: packages/framework/block-std/dist/extension/service.d.ts:23

Returns

Workspace

Inherited from

RootService.collection

---

crud

Get Signature

get crud(): EdgelessCRUDExtension

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:126

Returns

EdgelessCRUDExtension

---

doc

Get Signature

get doc(): Store

Defined in: packages/framework/block-std/dist/extension/service.d.ts:24

Returns

Store

Inherited from

RootService.doc

---

edgelessElements

Get Signature

get edgelessElements(): GfxModel[]

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:64

sorted edgeless elements

Returns

GfxModel[]

---

elements

Get Signature

get elements(): SurfaceElementModel<BaseElementProps>[]

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:73

sorted canvas elements

Returns

SurfaceElementModel<BaseElementProps>[]

---

frame

Get Signature

get frame(): EdgelessFrameManager

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:77

Returns

EdgelessFrameManager

---

frames

Get Signature

get frames(): FrameBlockModel[]

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:86

Get all sorted frames by presentation orderer, the legacy frame that uses index as presentation order will be put at the beginning of the array.

Returns

FrameBlockModel[]

---

gfx

Get Signature

get gfx(): GfxController

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:90

Returns

GfxController

---

host

Get Signature

get host(): EditorHost

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:94

Returns

EditorHost

Implementation of

SurfaceContext.host

Overrides

RootService.host

---

layer

Get Signature

get layer(): LayerManager

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:98

Returns

LayerManager

---

locked

Get Signature

get locked(): boolean

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:102

Returns

boolean

Set Signature

set locked(locked): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:106

Parameters

locked

boolean

Returns

void

---

selectedBlocks

Get Signature

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

Defined in: packages/affine/blocks/block-root/src/root-service.ts:16

Returns

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

Inherited from

RootService.selectedBlocks

---

selectedModels

Get Signature

get selectedModels(): BlockModel<object>[]

Defined in: packages/affine/blocks/block-root/src/root-service.ts:34

Returns

BlockModel<object>[]

Inherited from

RootService.selectedModels

---

selection

Get Signature

get selection(): GfxSelectionManager

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:110

Returns

GfxSelectionManager

Implementation of

SurfaceContext.selection

---

selectionManager

Get Signature

get selectionManager(): StoreSelectionExtension

Defined in: packages/framework/block-std/dist/extension/service.d.ts:26

Returns

StoreSelectionExtension

Inherited from

RootService.selectionManager

---

surface

Get Signature

get surface(): SurfaceBlockModel

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:114

Returns

SurfaceBlockModel

---

uiEventDispatcher

Get Signature

get uiEventDispatcher(): UIEventDispatcher

Defined in: packages/framework/block-std/dist/extension/service.d.ts:27

Returns

UIEventDispatcher

Inherited from

RootService.uiEventDispatcher

---

viewport

Get Signature

get viewport(): Viewport

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:118

Returns

Viewport

Implementation of

SurfaceContext.viewport

---

viewportElement

Get Signature

get viewportElement(): null | HTMLElement

Defined in: packages/affine/blocks/block-root/src/root-service.ts:38

Returns

null | HTMLElement

Inherited from

RootService.viewportElement

---

zoom

Get Signature

get zoom(): number

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:122

Returns

number

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Defined in: packages/framework/block-std/dist/extension/service.d.ts:32

Parameters

keymap

Record<string, UIEventHandler>

options?

global

boolean

Returns

void

Inherited from

RootService.bindHotKey

---

createGroup()

createGroup(elements): undefined | string

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:169

Parameters

elements

string[] | GfxModel[]

Returns

undefined | string

---

createGroupFromSelected()

createGroupFromSelected(): undefined | string

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:192

Create a group from selected elements, if the selected elements are in the same group

Returns

undefined | string

the id of the created group

---

createTemplateJob()

createTemplateJob(type, center?): TemplateJob

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:233

Parameters

type

"template" | "sticker"

center?

x

number

y

number

Returns

TemplateJob

---

dispose()

dispose(): void

Defined in: packages/framework/block-std/dist/extension/service.d.ts:35

Returns

void

Inherited from

RootService.dispose

---

generateIndex()

generateIndex(): string

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:273

Returns

string

---

getConnectors()

getConnectors(element): ConnectorElementModel[]

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:277

Parameters

element

string | GfxModel

Returns

ConnectorElementModel[]

---

handleEvent()

handleEvent(name, fn, options?): void

Defined in: packages/framework/block-std/dist/extension/service.d.ts:36

Parameters

name

"click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "nativeDragOver" | "nativeDragLeave" | "beforeInput" | "blur" | "focus" | "contextMenu" | "wheel"

fn

UIEventHandler

options?

global

boolean

Returns

void

Inherited from

RootService.handleEvent

---

mounted()

mounted(): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:283

Returns

void

Overrides

RootService.mounted

---

pickElementInGroup()

pickElementInGroup(x, y, options?): null | GfxModel

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:294

This method is used to pick element in group, if the picked element is in a group, we will pick the group instead. If that picked group is currently selected, then we will pick the element itself.

Parameters

x

number

y

number

options?

PointTestOptions

Returns

null | GfxModel

---

removeElement()

removeElement(id): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:302

Parameters

id

string | GfxModel

Returns

void

---

reorderElement()

reorderElement(element, direction): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:323

Parameters

element

GfxModel

direction

ReorderingDirection

Returns

void

---

setZoomByAction()

setZoomByAction(action): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:336

Parameters

action

"reset" | "fit" | "out" | "in"

Returns

void

---

setZoomByStep()

setZoomByStep(step): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:352

Parameters

step

number

Returns

void

---

ungroup()

ungroup(group): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:356

Parameters

group

GroupElementModel

Returns

void

---

unmounted()

unmounted(): void

Defined in: packages/affine/blocks/block-root/src/edgeless/edgeless-root-service.ts:396

Returns

void

Overrides

RootService.unmounted

---

setup()

static setup(di): void

Defined in: packages/framework/block-std/dist/extension/service.d.ts:31

Parameters

di

Container

Returns

void

Inherited from

RootService.setup