Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.arcgisservices

Interface TimeAware

All Known Implementing Classes:
ArcGISMapImageLayer, FeatureLayer, KmlLayer, RasterLayer, SubtypeFeatureLayer, WmsLayer
public interface TimeAware
An interface that is implemented by layers that support time. When time is enabled on a layer, data can be filtered/fetched based on a time-range.
Since:
100.3.0

  • Method Details

    • getFullTimeExtent

      TimeExtent getFullTimeExtent()
      Returns the full time extent of the object. Will be null if the object is not time aware.
      Returns:
      the time extent, or null if the object is not time aware
      Since:
      100.3.0

    • getTimeInterval

      TimeValue getTimeInterval()
      Returns the suggested time slider step size for this time aware object. Can be null if no time interval is suggested for this time aware object.
      Returns:
      the time interval, or null if there is no time interval
      Since:
      100.3.0

    • getTimeOffset

      TimeValue getTimeOffset()
      Returns the time offset applied to this object. The offset is subtracted from the time extent set on the owning GeoView. This allows for data from different periods of time to be compared.
      Returns:
      the time offset, or null if no offset has been set
      Since:
      100.3.0

    • isTimeFilteringEnabled

      boolean isTimeFilteringEnabled()
      Returns whether or not the object must use the time extent defined on the owning GeoView to filter its data.
      Returns:
      true if time filtering is enabled; otherwise false
      Since:
      100.3.0

    • setIsTimeFilteringEnabled

      void setIsTimeFilteringEnabled(boolean enabled)
      Enables or disables whether the object must use the time extent defined on the owning GeoView to filter its data.
      Parameters:
      enabled - true to enable time filtering; otherwise false
      Since:
      100.3.0

    • isTimeFilteringSupported

      boolean isTimeFilteringSupported()
      Returns whether or not the object supports filtering its contents by time values with the extent set on the owning GeoView.
      Returns:
      true if time filtering is supported; otherwise false
      Since:
      100.3.0

    • setTimeOffset

      void setTimeOffset(TimeValue timeOffset)
      Sets a time offset for this object. The time offset is subtracted from the time extent set on the owning GeoView. This allows for data from different periods of time to be compared. Can be null if there is no time offset.
      Parameters:
      timeOffset - the time offset, or null if there is no time offset
      Since:
      100.3.0

    • addFullTimeExtentChangedListener

      void addFullTimeExtentChangedListener(FullTimeExtentChangedListener listener)
      Adds a listener that will fire when there is a change to the full time extent.
      Parameters:
      listener - the listener to add
      Throws:
      IllegalArgumentException - if the listener is null
      Since:
      100.3.0

    • removeFullTimeExtentChangedListener

      boolean removeFullTimeExtentChangedListener(FullTimeExtentChangedListener listener)
      Removes a full time extent changed listener.
      Parameters:
      listener - the listener to remove
      Returns:
      true if the listener was removed, otherwise false
      Since:
      100.3.0