Synthèse
The Combo class creates combo charts. Combo charts combine bar and line series in one chart, with optional dual y-axes.
Discussion
When creating this object, optional arguments for the class constructor must be specified using the argument name; they cannot be specified by argument position. See the Code sample section for an example of how to specify arguments using keywords.
Syntaxe
Combo (x, {seriesLeft}, {seriesRight}, {timeBinningProperties}, {nullPolicy}, {title}, {description}, {xTitle}, {yTitleLeft}, {yTitleRight}, {dataSource}, {displaySize}, {theme})
Paramètre | Explication | Type de données |
x | The field name for the x-axis variable. The field must be a string or a date field. | String |
seriesLeft [seriesLeft,...] | Sets the series for the left y-axis using a list of Series objects. | List |
seriesRight [seriesRight,...] | Sets the series for the right y-axis using a list of Series objects. | List |
timeBinningProperties | A TimeBinningProperties object that will be applied to temporal combo charts. | Object |
nullPolicy | Specifies how summarized bins returning a null value will be displayed for temporal combo charts.
| String |
title |
The title of the chart. The title text appears at the top of the chart view and is used as the label for the chart in the Contents pane. | String |
description | The description of the chart. The description text appears at the bottom of the chart view. | String |
xTitle | The title of the x-axis of the chart. | String |
yTitleLeft | The title of the left y-axis of the chart. | String |
yTitleRight | The title of the right y-axis of the chart. | String |
dataSource | The data source of the chart. When a chart is exported using the exportToSVG method or displayed in ArcGIS Notebooks, the data source will be read and rendered on the chart. Valid data sources include the following: | Object |
displaySize [displaySize,...] | The size of the chart when exported using the exportToSVG method or displayed in ArcGIS Notebooks. The value must be specified as a two-item list in which the first item is the width of the chart and the second item is the height of the chart. | List |
theme | Specifies the theme that will be applied to the chart.
| String |
Propriétés
Propriété | Explication | Type de données |
dataSource (Lecture et écriture) | The data source of the chart. When a chart is exported using the exportToSVG method or displayed in an ArcGIS notebook, the data source will be read and rendered on the chart. Valid data sources include the following: | Object |
description (Lecture et écriture) | The description of the chart. The description text appears at the bottom of the chart view. | String |
displaySize (Lecture et écriture) | The size of the chart when exported using the exportToSVG method or displayed in an ArcGIS notebook. The value must be specified as a two-item list in which the first item is the width of the chart and the second item is the height of the chart. | List |
MISSING_PROPNAME (Lecture et écriture) | List | |
legend (Lecture et écriture) | The properties of the chart legend.
| Object |
nullPolicy (Lecture et écriture) | Specifies how summarized bins returning a null value will be displayed for temporal combo charts.
| String |
timeBinningProperties (Lecture et écriture) | A TimeBinningProperties object that will be applied to temporal combo charts. | Object |
type (Lecture seule) | The string value indicating the chart type. | String |
theme (Lecture et écriture) | The name of the theme that will be applied to the chart. | String |
seriesLeft (Lecture et écriture) | Sets the series for the left y-axis using a list of Series objects. | List |
seriesRight (Lecture et écriture) | Sets the series for the right y-axis using a list of Series objects. | List |
x (Lecture et écriture) | The field name for the x-axis variable. The field must be a string or a date field. | String |
xAxis (Lecture et écriture) | Specifies the properties of the x-axis.
| Object |
yAxisLeft (Lecture et écriture) | Specifies the properties of the y-axis.
| Object |
yAxisRight (Lecture et écriture) | Specifies the properties of the y-axis.
| Object |
Vue d’ensemble des méthodes
Méthode | Explication |
addToLayer (layer_or_layerfile) | The addToLayer method adds the chart object to a layer or table view. |
exportToSVG (path, width, height) | The exportToSVG method exports the chart to SVG format. |
updateChart () | The updateChart method updates chart properties to sync changes between the object and the chart previously added to a layer. |
Méthodes
addToLayer (layer_or_layerfile)
Paramètre | Explication | Type de données |
layer_or_layerfile | The chart will be added to the target object. This argument can be a Layer or Table object. | Object |
Adding the chart object to a layer or table using the addToLayer method is often the final step after defining chart properties.
Add a chart to an existing layer.
import arcpy
# Insert creation of chart object here
...
aprx = arcpy.mp.ArcGISProject("current")
map = aprx.listMaps()[0]
censusLayer = map.listLayers('Census Block Groups')[0]
# Add chart object to a layer
chart.addToLayer(censusLayer)
exportToSVG (path, width, height)
Paramètre | Explication | Type de données |
path | The path where the chart will be exported in SVG format. | String |
width | The width of the output graphic. | Integer |
height | The height of the output graphic. | Integer |
In some cases, you may want to save the chart as a graphic that can be shared and viewed outside of ArcGIS AllSource. Exporting to the SVG graphic format is beneficial, as the chart elements and text are stored as vector elements that can be independently modified in vector graphics software. An SVG graphic can also be resized to any scale without pixelation or loss in quality.
Export a chart that has a project layer data source to an .svg file.
import arcpy
# Insert creation of chart object here
...
aprx = arcpy.mp.ArcGISProject('current')
censusLayer = aprx.listMaps()[0].listLayers('Census Block Groups')[0]
# Set data source of chart object to a layer in current project
chart.dataSource = censusLayer
# Save the chart to file with dimensions width=500, height=500
chart.exportToSVG('populationByState.svg', 500, 500)
Export a chart that has a feature service data source to an .svg file.
import arcpy
# Insert creation of chart object here
...
featureServiceURL = r'https://services1.arcgis.com/hLJbHVT9ZrDIzK0I/arcgis/rest/services/CrimesChiTheft/FeatureServer/0'
# Set data source of chart object to a feature service URL
chart.dataSource = featureServiceURL
# Save the chart to file with dimensions width=800, height=600
chart.exportToSVG('theftsPerBeat.svg', 800, 600)
updateChart ()
Adding the chart object to a layer using the addToLayer method is often the final step after defining chart properties.
You can also modify the properties of the original chart instead of starting with a new chart. You can then use the updateChart method to synchronize any changes into the chart that was added to the layer. This allows the changes you make to be presented in the Chart properties pane and chart view.
Use the updateChart method to synchronize chart property changes into a layer.
import arcpy
# Insert creation of chart object here
...
chart.addToLayer(myLayer)
# Further modification is necessary
chart.description = "Data from the U.S. Census Bureau"
chart.updateChart()
Exemple de code
Create a combo chart by configuring Series objects, and export the chart to an .svg file.
import arcpy
seriesLeft = [arcpy.charts.Series(y="", aggregation="count", seriesType="bar")]
seriesRight = [arcpy.charts.Series(y="prcp", aggregation="mean", seriesType="line")]
chart = arcpy.charts.Combo(x="day_for_trips", seriesLeft=seriesLeft, seriesRight=seriesRight,
title="Bike Trips and Precipitation",
yTitleLeft="Total Rides", yTitleRight="Average Precipitation",
dataSource="BikeTripData")
chart.exportToSVG("combo.svg", width=900, height=500)
Vous avez un commentaire à formuler concernant cette rubrique ?