Subgroup: Date
Class: QgsDateRange¶
-
class
qgis.core.
QgsDateRange
(begin: Union[QDate, datetime.date], end: Union[QDate, datetime.date], includeBeginning: bool = True, includeEnd: bool = True)¶ Bases:
sip.wrapper
Constructor for QgsTemporalRange. The
begin
andend
are specified, and optionally whether or not these bounds are included in the range.Note
in Python
begin
andend
must be provided.QgsDateRange(QgsDateRange)
QgsRange which stores a range of dates.
Invalid QDates as the beginning or end are permitted. In this case, the bound is considered to be infinite. E.g. QgsDateRange(QDate(),QDate(2017,1,1)) is treated as a range containing all dates before 2017-1-1. QgsDateRange(QDate(2017,1,1),QDate()) is treated as a range containing all dates after 2017-1-1.
New in version 3.0.
See also
Methods
begin
Returns the beginning of the range. contains
Returns true if this range contains another range. end
Returns the upper bound of the range. includeBeginning
Returns true if the beginning is inclusive, or false if the beginning is exclusive. includeEnd
Returns true if the end is inclusive, or false if the end is exclusive. isEmpty
Returns true if the range is empty, ie the beginning equals (or exceeds) the end and either of the bounds are exclusive. isInfinite
Returns true if the range consists of all possible values. isInstant
Returns true if the range consists only of a single instant. overlaps
Returns true if this range overlaps another range. Signals
Attributes
-
begin
(self) → QDate¶ Returns the beginning of the range.
See also
See also
-
contains
(self, other: QgsDateRange) → bool¶ Returns true if this range contains another range.
contains(self, element: Union[QDate, datetime.date]) -> bool Returns true if this range contains a specified
element
.
-
end
(self) → QDate¶ Returns the upper bound of the range.
See also
See also
-
includeBeginning
(self) → bool¶ Returns true if the beginning is inclusive, or false if the beginning is exclusive.
See also
See also
-
includeEnd
(self) → bool¶ Returns true if the end is inclusive, or false if the end is exclusive.
See also
See also
-
isEmpty
(self) → bool¶ Returns true if the range is empty, ie the beginning equals (or exceeds) the end and either of the bounds are exclusive. A range with both invalid beginning and end is considered infinite and not empty.
-
isInfinite
(self) → bool¶ Returns true if the range consists of all possible values.
See also
See also
-
isInstant
(self) → bool¶ Returns true if the range consists only of a single instant.
See also
See also
-
overlaps
(self, other: QgsDateRange) → bool¶ Returns true if this range overlaps another range.
-