A1Range class

Implemented types

Constructors

A1Range.fromA1s(A1 fromA1, A1 toA1, {Object? tag, A1? anchor})
Creates a range from two supplied A1s for from and to ensures 'from' is less than or equal to 'to' the fromA1 will be used as the anchor in the range
factory
A1Range.fromCoordinates(int? fromColumn, int? fromRow, int? toColumn, int? toRow, {Object? tag, A1? anchor})
Creates a range from fromColumn, fromRow, toColumn, toRow
factory
A1Range.fromPartials(A1Partial from, A1Partial to, {Object? tag, A1? anchor})
Creates a range from two supplied A1Partials for from and to ensures 'from' is less than or equal to 'to' when not all if the from is an A1 is will be treated as the anchor
factory

Properties

anchor A1?
optional anchor a1
final
area double
Area of this range, for items unbounded ranges, returns double.infinity
no setter
bottom int
the to.row or maximum integer for the system
no setter
bottomBorder A1Range
Select the bottom border strip for this range
no setter
columnSpan int
the number of columns between the start and end of this range uses the maximum integer of the system for unbound columns starting at 0, this will always be greater than or equal to 1
no setter
from A1Partial
range from A1Partial
latefinal
goDown A1Range
adjust range down relative to anchor
no setter
goLeft A1Range
adjust range left relative to anchor
no setter
goRight A1Range
adjust range right relative to anchor
no setter
goUp A1Range
adjust range up relative to anchor
no setter
hashCode int
Returns a hash code for a numerical value.
no setteroverride
height int
height based on assume full rows are maxInt
no setter
horizontalBorders A1Range?
Return range excluding the last row (assumes bottom borders) or null if there are no internal horizontal borders
no setter
left int
the from.column or 0
no setter
leftBorder A1Range
Select the left border strip for this range
no setter
the to.column or maximum integer for the system
no setter
rightBorder A1Range
Select the right border strip for this range
no setter
rowSpan int
the number of rows between the start and end of this range uses the maximum integer of the system for unbound rows starting at 0, this will always be greater than or equal to 1
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tag Object?
optional tag for this range, used when associating formatting
final
to A1Partial
range to A1Partial
latefinal
top int
the from.row or 0
no setter
topBorder A1Range
Select the top border strip for this range
no setter
verticalBorders A1Range?
Return range excluding the last column (assumes right borders) or null if there are no internal vertical borders
no setter
width int
width based on assume full columns are maxInt
no setter

Methods

compareTo(A1Range other) int
Compare the area of two A1Ranges this and other to determine which is bigger Returns a negative number if this is less than other, zero if they are equal, and a positive number if this is greater than other.
override
contains(A1 a1) bool
Does this A1Range contain this A1
copyWith({A1Partial? from, A1Partial? to, A1? anchor, Object? tag}) A1Range
copy with different attributes
hasColumn(int column) bool
is the column in this range
hasCorner(A1 a1) bool
Does this A1Range have this A1 at one of its corners.
hasRow(int row) bool
is the row in this range
intersect(A1Range other) A1Range?
Return the A1Range or null where this and other intersect updates the tag as this.tag, other.tag
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
overlaps(A1Range other) bool
Check if this A1Range overlaps the other A1Range
overlayRanges(List<A1Range> ranges) List<A1Range>
Overlay A1Range on top of each other, merging intersects and substracting to create non-overlapping A1Ranges The tags for ranges are maintained or staged in a list with the early item in the list considered overlayed on the latter
subtract(A1Range other) List<A1Range>
Return the A1Ranges that is left after subtracting the other A1Range. Maintains the tag
toString() String
Print the range in the form A1:B2, A1:B, A1, A, or ''
override

Operators

operator ==(Object other) bool
Test whether this A1 is equal to other.
override

Static Properties

all A1Range
All range
final

Static Methods

overlayRange(List<A1Range> ranges, A1Range range) List<A1Range>
Special case of overlayRanges where we are overlaying an A1Range on a list of A1Ranges
parse(String input) A1Range
Parses a string containing an A1Range literal into an A1Range.
tryParse(String input) A1Range?
Parses a string containing an A1Range literal into an A1Range.