A pure virtual interface implemented by classes that support time. More...
| Header: | #include <TimeAware.h> |
| Since: | Esri::ArcGISRuntime 100.3 |
| Inherited By: | Esri::ArcGISRuntime::ArcGISMapImageLayer, Esri::ArcGISRuntime::FeatureLayer, Esri::ArcGISRuntime::KmlLayer, Esri::ArcGISRuntime::RasterLayer, and Esri::ArcGISRuntime::WmsLayer |
This class was introduced in Esri::ArcGISRuntime 100.3.
Public Functions
| virtual | ~TimeAware() |
| virtual Esri::ArcGISRuntime::TimeExtent | fullTimeExtent() const = 0 |
| virtual bool | isSupportsTimeFiltering() const = 0 |
| virtual bool | isTimeFilteringEnabled() const = 0 |
| virtual void | setTimeFilteringEnabled(bool timeFilteringEnabled) = 0 |
| virtual void | setTimeOffset(const Esri::ArcGISRuntime::TimeValue &timeOffset) = 0 |
| virtual Esri::ArcGISRuntime::TimeValue | timeInterval() const = 0 |
| virtual Esri::ArcGISRuntime::TimeValue | timeOffset() const = 0 |
Protected Functions
Detailed Description
When time is enabled on layer, data can be filtered and fetched based on a time range.
All classes that implement TimeAware include the following signal.
void TimeAware::fullTimeExtentChanged()
Member Function Documentation
[protected] TimeAware::TimeAware ()
Constructor.
[virtual] TimeAware::~TimeAware ()
Destructor.
[pure virtual] Esri::ArcGISRuntime::TimeExtent TimeAware::fullTimeExtent () const
Returns the full time extent of the layer.
[pure virtual] bool TimeAware::isSupportsTimeFiltering () const
Returns whether the layer supports filtering its contents by time values.
[pure virtual] bool TimeAware::isTimeFilteringEnabled () const
Returns whether the layer participates in filtering based on the time extent of its geoview.
[pure virtual] void TimeAware::setTimeFilteringEnabled (bool timeFilteringEnabled )
Sets whether the layer uses the time range defined on the geoview to timeFilteringEnabled.
See also isTimeFilteringEnabled().
[pure virtual] void TimeAware::setTimeOffset (const Esri::ArcGISRuntime::TimeValue &timeOffset )
Sets the time offset of the layer to timeOffset.
The time offset is subtracted from the time extent set on the layer's geoview. This can be used to overlay data from different periods of time for comparison.
See also timeOffset().
[pure virtual] Esri::ArcGISRuntime::TimeValue TimeAware::timeInterval () const
Returns a time interval that represents the suggested step size for use when manipulating the time extent.
This information can be used to set the step size for a time slider control. Can return nullptr if no time interval is suggested.
[pure virtual] Esri::ArcGISRuntime::TimeValue TimeAware::timeOffset () const
Returns the applied time offset.
See also setTimeOffset().