Abstract Class: EntireAxisSelection

Defined in: src/selection.ts:131

Selection of an entire axis in the spreadsheet

Extends

• EntireSelection

Extended by

• EntireColumnsSelection
• EntireRowsSelection

Constructors

Constructor

new EntireAxisSelection(start, end): EntireAxisSelection

Defined in: src/selection.ts:142

Parameters

start

number

row index where the selection starts, integer

end

number

row index where the selection ends, integer

Returns

EntireAxisSelection

Throws

InvalidIndexError

Overrides

EntireSelection.constructor

Properties

end

readonly end: number

Defined in: src/selection.ts:135

Selection end index, integer

---

start

readonly start: number

Defined in: src/selection.ts:133

Selection start index, integer

Methods

equals()

equals(selection): boolean

Defined in: src/selection.ts:154

Determines whether the given selection is equal to this selection

Parameters

selection

Selection

Returns

boolean

Overrides

EntireSelection.equals

---

has()

abstract has(data, point): boolean

Defined in: src/selection.ts:23

Determines whether the given point is within the selection

Parameters

data

Matrix<unknown>

point

Point

Returns

boolean

Inherited from

EntireSelection.has

---

hasEntireColumn()

abstract hasEntireColumn(column): boolean

Defined in: src/selection.ts:17

Determines whether the given column is entirely selected in given selection

Parameters

column

number

Returns

boolean

Inherited from

EntireSelection.hasEntireColumn

---

hasEntireRow()

abstract hasEntireRow(row): boolean

Defined in: src/selection.ts:14

Determines whether the given row is entirely selected in given selection

Parameters

row

number

Returns

boolean

Inherited from

EntireSelection.hasEntireRow

---

normalizeTo()

abstract normalizeTo(data): this

Defined in: src/selection.ts:11

Normalize the selection according to the given data

Parameters

data

Matrix<unknown>

Returns

this

Inherited from

EntireSelection.normalizeTo

---

size()

abstract size(data): number

Defined in: src/selection.ts:20

Get the number of selected points according to given data

Parameters

data

Matrix<unknown>

Returns

number

Inherited from

EntireSelection.size

---

toRange()

abstract toRange(data): PointRange | null

Defined in: src/selection.ts:8

Get concrete range of the selection in the given data

Parameters

data

Matrix<unknown>

Returns

PointRange | null

Inherited from

EntireSelection.toRange