BlockSuite API Documentation / @blocksuite/block-std / CursorSelection

Class: CursorSelection

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:9

Extends

• BaseSelection

Constructors

new CursorSelection()

new CursorSelection(x, y): CursorSelection

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:18

Parameters

x

number

y

number

Returns

CursorSelection

Overrides

BaseSelection.constructor

Properties

blockId

readonly blockId: string

Defined in: packages/framework/store/dist/extension/selection/base.d.ts:8

Inherited from

BaseSelection.blockId

---

x

readonly x: number

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:14

---

y

readonly y: number

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:16

---

group

static group: string = 'gfx'

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:10

Overrides

BaseSelection.group

---

type

static type: string = 'cursor'

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:12

Overrides

BaseSelection.type

Accessors

group

Get Signature

get group(): string

Defined in: packages/framework/store/dist/extension/selection/base.d.ts:9

Returns

string

Inherited from

BaseSelection.group

---

type

Get Signature

get type(): string

Defined in: packages/framework/store/dist/extension/selection/base.d.ts:10

Returns

string

Inherited from

BaseSelection.type

Methods

equals()

equals(other): boolean

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:29

Parameters

other

BaseSelection

Returns

boolean

Overrides

BaseSelection.equals

---

is()

is<T>(type): this is T extends SelectionConstructor<U> ? U : never

Defined in: packages/framework/store/dist/extension/selection/base.d.ts:14

Type Parameters

T

T extends SelectionConstructor<BaseSelection>

Parameters

type

T

Returns

this is T extends SelectionConstructor<U> ? U : never

Inherited from

BaseSelection.is

---

toJSON()

toJSON(): Record<string, unknown>

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:36

Returns

Record<string, unknown>

Overrides

BaseSelection.toJSON

---

fromJSON()

static fromJSON(json): CursorSelection

Defined in: packages/framework/block-std/src/selection/variants/cursor.ts:24

Parameters

json

Record<string, unknown>

Returns

CursorSelection

Overrides

BaseSelection.fromJSON