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

Class: abstract BaseSelection

Contents

• Extended By
• Constructors
  • new BaseSelection(__namedParameters)
• Properties
  • path
  • group
  • type
• Accessors
  • blockId
  • group
  • type
• Methods
  • abstract equals()
  • is()
  • abstract toJSON()
  • fromJSON()

Extended By

• BlockSelection
• CursorSelection
• SurfaceSelection
• TextSelection

Constructors

new BaseSelection(__namedParameters)

new BaseSelection(__namedParameters): BaseSelection

Parameters

• __namedParameters: BaseSelectionOptions

Returns

BaseSelection

Source

block-std/src/selection/base.ts:18

Properties

path

readonly path: string[]

Source

block-std/src/selection/base.ts:16

---

group

static readonly group: string

Source

block-std/src/selection/base.ts:15

---

type

static readonly type: string

Source

block-std/src/selection/base.ts:14

Accessors

blockId

get blockId(): string

Returns

string

Source

block-std/src/selection/base.ts:22

---

group

get group(): string

Returns

string

Source

block-std/src/selection/base.ts:37

---

type

get type(): keyof Selection

Returns

keyof Selection

Source

block-std/src/selection/base.ts:32

Methods

abstract equals()

abstract equals(other): boolean

Parameters

• other: BaseSelection

Returns

boolean

Source

block-std/src/selection/base.ts:41

---

is()

is<T>(type): this is SelectionInstance[T]

Type parameters

• T extends keyof Selection

Parameters

• type: T

Returns

this is SelectionInstance[T]

Source

block-std/src/selection/base.ts:26

---

abstract toJSON()

abstract toJSON(): Record<string, unknown>

Returns

Record<string, unknown>

Source

block-std/src/selection/base.ts:43

---

fromJSON()

static fromJSON(_): BaseSelection

Parameters

• _: Record<string, unknown>

Returns

BaseSelection

Source

block-std/src/selection/base.ts:45

---

Generated using typedoc-plugin-markdown and TypeDoc