abstractEntireAxisSelection

Selection of an entire axis in the spreadsheet

Hierarchy

• EntireSelection
  • EntireAxisSelection
    • EntireColumnsSelection
    • EntireRowsSelection

Index

Constructors

• constructor

Properties

• end
• start

Methods

• has
• hasEntireColumn
• hasEntireRow
• normalizeTo
• size
• toRange

Constructors

constructor

• new EntireAxisSelection(start: number, end: number): EntireAxisSelection

• Overrides EntireSelection.constructor

  @throws

  InvalidIndexError

  ---

  Parameters

  • start: number

    row index where the selection starts, integer

  • end: number

    row index where the selection ends, integer

  Returns EntireAxisSelection

Properties

readonlyend

end: number

Selection end index, integer

readonlystart

start: number

Selection start index, integer

Methods

abstracthas

• has(data: Matrix<unknown>, point: Point): boolean

• Inherited from EntireSelection.has

  Determines whether the given point is within the selection

  ---

  Parameters

  • data: Matrix<unknown>

  • point: Point

  Returns boolean

abstracthasEntireColumn

• hasEntireColumn(column: number): boolean

• Inherited from EntireSelection.hasEntireColumn

  Determines whether the given column is entirely selected in given selection

  ---

  Parameters

  • column: number

  Returns boolean

abstracthasEntireRow

• hasEntireRow(row: number): boolean

• Inherited from EntireSelection.hasEntireRow

  Determines whether the given row is entirely selected in given selection

  ---

  Parameters

  • row: number

  Returns boolean

abstractnormalizeTo

• normalizeTo(data: Matrix<unknown>): EntireAxisSelection

• Inherited from EntireSelection.normalizeTo

  Normalize the selection according to the given data

  ---

  Parameters

  • data: Matrix<unknown>

  Returns EntireAxisSelection

abstractsize

• size(data: Matrix<unknown>): number

• Inherited from EntireSelection.size

  Get the number of selected points according to given data

  ---

  Parameters

  • data: Matrix<unknown>

  Returns number

abstracttoRange

• toRange(data: Matrix<unknown>): null | PointRange

• Inherited from EntireSelection.toRange

  Get concrete range of the selection in the given data

  ---

  Parameters

  • data: Matrix<unknown>

  Returns null | PointRange