YearRange class

A single year. Special-cased to have titles like "This year" or "Last year".

Implemented types

Constructors

YearRange(Date start, int _ago, [RangeTitle _titleFunction = _defaultTitle])
YearRange.yearsAgo(dynamic clock, dynamic ago, [RangeTitle titleFunction = _defaultTitle])

Properties

ago int
Number of years ago relative to the current date.
no setter
end Date
no setteroverride
hashCode int
The hash code for this object.
no setteroverride
isAllTime bool
true if this date range represents all available history.
no setteroverride
isPredefined bool
Whether the date range is predefined by the application.
no setteroverride
next DatepickerDateRange
A date range which begins immediately after this one ends, and has either the same length or similar semantics (such as "the next month").
no setteroverride
prev DatepickerDateRange
A date range which ends immediately before this one starts, and has either the same length or similar semantics (such as "the previous year").
no setteroverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
start Date
no setteroverride
title String
E.g. "Last 7 days", "This month", "Custom", etc.
no setteroverride

Methods

asPlainRange() DateRange
Returns this range as a plain DateRange. This is needed because DateRange's equality is strict on types.
override
clamp({Date? min, Date? max}) DatepickerDateRange?
Clamps the current date range to the given min and max dates. Returns null if this range has no overlap with the given date range.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toProtoBuf() DatepickerDateRange
Convert this date range into the protocol buffer format defined in date_range.proto.
override
toString() String
A string representation of this object.
override
unclamped() DatepickerDateRange
Reverses the effect of one call to clamp() (assuming clamp() didn't return null). If clamp() succeeds, range.clamp(...).unclamped() == range.
override

Operators

operator ==(Object o) bool
The equality operator.
override