Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BasicSelectionModel

A basic selection model implementation.

Notes

This selection model is sufficient for most use cases where structural knowledge of the data source is not required.

Hierarchy

Index

Type aliases

Static ClearMode

ClearMode: "all" | "current" | "none"

A type alias for the clear mode.

Static CursorMoveDirection

CursorMoveDirection: "up" | "down" | "left" | "right" | "none"

A type alias for the cursor move direction.

Static SelectArgs

SelectArgs: object

A type alias for the select args.

Type declaration

Static Selection

Selection: object

A type alias for a selection in a selection model.

Type declaration

Static SelectionMode

SelectionMode: "row" | "column" | "cell"

A type alias for the selection mode.

Constructors

constructor

Properties

Private _cursorColumn

_cursorColumn: number = -1

Private _cursorRectIndex

_cursorRectIndex: number = -1

Private _cursorRow

_cursorRow: number = -1

Private _selections

_selections: Selection[] = []

dataModel

dataModel: DataModel

The data model associated with the selection model.

Accessors

changed

  • get changed(): ISignal<this, void>

cursorColumn

  • get cursorColumn(): number

cursorRow

  • get cursorRow(): number

isEmpty

  • get isEmpty(): boolean

selectionMode

Methods

clear

  • clear(): void

currentSelection

Protected emitChanged

  • emitChanged(): void

isCellSelected

  • isCellSelected(row: number, column: number): boolean
  • Test whether any selection intersects a cell.

    Parameters

    • row: number

      The row index of interest.

    • column: number

      The column index of interest.

    Returns boolean

    Whether any selection intersects the cell.

    Notes

    This method may be reimplemented in a subclass.

isColumnSelected

  • isColumnSelected(index: number): boolean

isRowSelected

  • isRowSelected(index: number): boolean

moveCursorWithinSelections

Protected onDataModelChanged

select

selections

Generated using TypeDoc