Skip to content

API > @blocksuite/block-std > SurfaceSelection

Class: SurfaceSelection ​

Extends ​

Constructors ​

constructor ​

new SurfaceSelection(elements, editing): SurfaceSelection

Parameters ​

ParameterType
elementsstring[]
editingboolean

Returns ​

SurfaceSelection

Overrides ​

BaseSelection.constructor

Defined In ​

block-std/src/selection/variants/surface.ts:17

Properties ​

editing ​

readonly editing: boolean

Defined In ​

block-std/src/selection/variants/surface.ts:15


elements ​

readonly elements: string[]

Defined In ​

block-std/src/selection/variants/surface.ts:14


path ​

readonly path: string[]

Defined In ​

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

Inherited from ​

BaseSelection.path


group ​

static group: string = 'edgeless'

Defined In ​

block-std/src/selection/variants/surface.ts:12

Overrides ​

BaseSelection.group


type ​

static type: string = 'surface'

Defined In ​

block-std/src/selection/variants/surface.ts:11

Overrides ​

BaseSelection.type

Accessors ​

blockId ​

get blockId(): string

Defined In ​

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

Inherited from ​

BaseSelection.blockId


group ​

get group(): string

Defined In ​

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

Inherited from ​

BaseSelection.group


type ​

get type(): keyof Selection

Defined In ​

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

Inherited from ​

BaseSelection.type

Methods ​

equals ​

equals(other): boolean

Parameters ​

ParameterType
otherBaseSelection

Returns ​

boolean

Overrides ​

BaseSelection.equals

Defined In ​

block-std/src/selection/variants/surface.ts:27


is ​

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

Type parameters ​

Parameter
T extends keyof Selection

Parameters ​

ParameterType
typeT

Returns ​

this is SelectionInstance[T]

Inherited from ​

BaseSelection.is

Defined In ​

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


isEmpty ​

isEmpty(): boolean

Returns ​

boolean

Defined In ​

block-std/src/selection/variants/surface.ts:23


toJSON ​

toJSON(): Record< string, unknown >

Returns ​

Record< string, unknown >

Overrides ​

BaseSelection.toJSON

Defined In ​

block-std/src/selection/variants/surface.ts:40


fromJSON ​

static fromJSON(json): SurfaceSelection

Parameters ​

ParameterType
jsonRecord< string, unknown > | {editing: boolean; elements: string[];}

Returns ​

SurfaceSelection

Overrides ​

BaseSelection.fromJSON

Defined In ​

block-std/src/selection/variants/surface.ts:49