Class NotebookRange

A notebook range represents an ordered pair of two cell indices. It is guaranteed that start is less than or equal to end.

Implements

NotebookRange

Index

Constructors

Properties

end isEmpty start

Methods

with isNotebookRange

Constructors

constructor

new NotebookRange(start: number, end: number): NotebookRange
Parameters
- start: number
- end: number
Returns NotebookRange
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1334

Properties

`Readonly`end

end: number

The exclusive end index of this range (zero-based).

`Readonly`isEmpty

isEmpty: boolean

true if start and end are equal.

`Readonly`start

start: number

The zero-based start index of this range.

Methods

with

with(change: { end?: number; start?: number }): NotebookRange
Derive a new range for this range.
Parameters
- change: { end?: number; start?: number }
  An object that describes a change to this range.
Returns NotebookRange
A range that reflects the given change. Will return this range if the change is not changing anything.
Implementation of NotebookRange.with
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1318

`Static`isNotebookRange

isNotebookRange(thing: unknown): thing is NotebookRange
Parameters
- thing: unknown
Returns thing is NotebookRange
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1303