interface TimeAware

An interface that is implemented by layers that can support time. These layers are known as time-aware layers. Time-aware layers contain spatial datasets that include different information for the same location at different times. If the time-aware layer supports time filtering and is connected to time-enabled data source you can perform time-based operations, such as:

  • Filter data with a time extent applied to the GeoView.

  • Compare data over time by applying a time offset to the data in a layer.

  • Control which layers participate in time filtering.

  • Add time-based parameters to queries.

If you are displaying a time-aware layer in a map (or scene) using a view, data is displayed based on the geo view's specified time extent (GeoView.timeExtent).

A layer is time-aware if it has a "Time Info" entry in the service's ArcGIS REST Services Directory.



See also



Link copied to clipboard
abstract val fullTimeExtent: StateFlow<TimeExtent?>

The full time extent of the layer. If the layer, such as an ArcGISMapImageLayer, has sublayers with different time extents, fullTimeExtent is a union of its sublayer's time extents.

Link copied to clipboard

True if the layer filters data based on its GeoView.timeExtent, false otherwise. This is only applicable if the layer's TimeAware.supportsTimeFiltering value is true. If the GeoView.timeExtent value is null, no time filtering is applied and all content is rendered.

Link copied to clipboard

True if the layer supports filtering data based on its time values, false otherwise.

Link copied to clipboard
abstract val timeInterval: TimeValue?

The suggested time slider step size for this time aware layer. You can use this information to set the step size for a time slider control. The value is null if no time interval is suggested. The author of the layer's data typically configures this property if the data has been collected on a regular basis. For example, the daily position of a hurricane.

Link copied to clipboard
abstract var timeOffset: TimeValue?

The amount of time by which the temporal values of this layer's data points are offset when displaying it in a GeoView. The time offset is subtracted from the time extent set on the layer's GeoView. This is useful if you want to overlay data in multiple layers that lies within different temporal extents. For example, if you want to compare data in one layer for a certain year with data in the same layer from the subsequent year, you can create two layers that reference the same data's service endpoint but set the TimeValue in one of the layers to be one year.