SSpreadsheetHitResult class

Result of a spreadsheet hit-test: maps a viewport-local position to a grid cell and provides visibility context for edge-triggered auto-scroll.

Returned by SSpreadsheetState.hitTest.

Constructors

SSpreadsheetHitResult({int? rowIndex, double rowProgress = 0.0, int? columnIndex, double columnProgress = 0.0, bool isInDataArea = false, int totalRows = 0, int totalColumns = 0, bool isFirstVisibleRow = false, bool isLastVisibleRow = false, bool canScrollUp = false, bool canScrollDown = false, bool isFirstVisibleColumn = false, bool isLastVisibleColumn = false, bool canScrollLeft = false, bool canScrollRight = false})
const

Properties

canScrollDown bool
Whether there are more rows below the visible area.
final
canScrollLeft bool
Whether the user can scroll left (hOffset > minScrollExtent).
final
canScrollRight bool
Whether there are more columns to the right of the visible area.
final
canScrollUp bool
Whether the user can scroll upward (scrollOffset > minScrollExtent).
final
columnIndex int?
The body column index at the hit position, or null if the position is in the row-header or beyond the last column.
final
columnProgress double
Normalised progress within the hit column: 0.0 = left edge, 1.0 = right edge.
final
hashCode int
The hash code for this object.
no setterinherited
isFirstVisibleColumn bool
Whether the hit column is the first body column visible in the viewport.
final
isFirstVisibleRow bool
Whether the hit row is the first data row visible in the viewport.
final
isInDataArea bool
Whether this position maps to an actual data cell (both rowIndex and columnIndex are non-null).
final
isLastVisibleColumn bool
Whether the hit column is the last body column visible in the viewport.
final
isLastVisibleRow bool
Whether the hit row is the last data row visible in the viewport.
final
rowIndex int?
The data row index at the hit position, or null if the position is in the header, column-header, or beyond the last row.
final
rowProgress double
Normalised progress within the hit row: 0.0 = top edge, 1.0 = bottom edge.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
totalColumns int
Total number of body columns in the spreadsheet.
final
totalRows int
Total number of data rows in the spreadsheet.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited