Range class

A range represents an ordered pair of two positions. It is guaranteed that {@link Range.startstart}.isBeforeOrEqual({@link Range.endend})

Range objects are immutable. Use the {@link Range.withwith}, {@link Range.intersectionintersection}, or {@link Range.unionunion} methods to derive new ranges from an existing range.

Implementers
Available extensions
Annotations
  • @JS()
  • @staticInterop

Constructors

Range.$1()
factory
Range.$2(Position start, Position end)
factory
Range.$3(num startLine, num startCharacter, num endLine, num endCharacter)
factory

Properties

end → Position

Available on Range, provided by the Range$Typings extension

The end position. It is after or equal to {@link Range.startstart}.
no setter
hashCode → int
The hash code for this object.
no setterinherited
isEmpty ↔ bool

Available on Range, provided by the Range$Typings extension

true if start and end are equal.
getter/setter pair
isSingleLine ↔ bool

Available on Range, provided by the Range$Typings extension

true if start.line and end.line are equal.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
start → Position

Available on Range, provided by the Range$Typings extension

The start position. It is before or equal to {@link Range.endend}.
no setter
with$ → ({Range Function(IInline2 change) $1, Range Function([Position? start, Position? end]) $2})

Available on Range, provided by the Range$Typings extension

Overload accessor: $1, $2
no setter

Methods

contains(Object positionOrRange) → bool

Available on Range, provided by the Range$Typings extension

Check if a position or a range is contained in this range.
intersection(Range range) → Range?

Available on Range, provided by the Range$Typings extension

Intersect range with this range and returns a new range or undefined if the ranges have no overlap.
isEqual(Range other) → bool

Available on Range, provided by the Range$Typings extension

Check if other equals this range.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
union(Range other) → Range

Available on Range, provided by the Range$Typings extension

Compute the union of other with this range.

Operators

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