Summary
The TimeBinningProperties class contains properties for configuring time binning used for temporal charts.
Syntax
TimeBinningProperties (intervalSize, intervalUnits, timeAggregationType, trimIncompleteInterval, referenceTime)
Parameter | Explanation | Data Type |
intervalSize | The span of time that is binned or aggregated together. This value must be used in conjunction with the intervalUnits value. | Integer |
intervalUnits | Specifies the time unit that corresponds to the intervalSize value.
| String |
timeAggregationType | Specifies the time interval alignment type.
| String |
trimIncompleteInterval | Specifies whether incomplete time intervals at the start or end of the data span (depending on the timeAggregationType value) are removed (trimmed) from the chart. Incomplete intervals on a chart can cause misleading results in which the period in question is underreported or overreported due to a different amount of time in the interval.
| Boolean |
referenceTime | Specifies the time that binning is initiated. | DateTime |
Properties
Property | Explanation | Data Type |
intervalSize (Read and Write) | The span of time that is binned or aggregated together. This property must be used in conjunction with the intervalUnits property. | Integer |
intervalUnits (Read and Write) | Specifies the time unit that corresponds to the intervalSize property value.
| String |
referenceTime (Read and Write) | Specifies the time that binning is initiated. | DateTime |
timeAggregationType (Read and Write) | Specifies the time interval alignment type.
| String |
trimIncompleteInterval (Read and Write) | Specifies whether incomplete time intervals at the start or end of the data span (depending on the timeAggregationType value) are removed (trimmed) from the chart. Incomplete intervals on a chart can cause misleading results in which the period in question is underreported or overreported due to a different amount of time in the interval.
| Boolean |
Code sample
Use TimeBinningProperties to create a temporal bar chart.
import arcpy
url = r"https://services1.arcgis.com/hLJbHVT9ZrDIzK0I/arcgis/rest/services/CrimesChiTheft/FeatureServer/0"
bins = arcpy.charts.TimeBinningProperties(intervalSize=1, intervalUnits='MONTHS')
bar = arcpy.charts.Bar(x="datetime", aggregation="count", title="Incidents by Month",
timeBinningProperties=bins, dataSource=url)
bar.exportToSVG('temporal_bar.svg', width=800, height=600)