Resumen
The Pie class creates pie charts. Pie charts group data into slices to visualize part-to-whole relationships.
Debate
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.
Sintaxis
Pie ({categoryField}, {numberFields}, {splitCategory}, {miniChartsPerRow}, {showPreviewChart}, {groupingPercent}, {donutSize}, {sort}, {showDataLabels}, {dataLabelsDisplay}, {title}, {description}, {dataSource}, {displaySize})
Parámetro | Explicación | Tipo de datos |
categoryField | The field name of the category variable. | String |
numberFields | The field names for the numeric field or fields. Provide a single field name or a list of field names. | String |
splitCategory | A categorical field that adds a separate series for each unique value in the field. | String |
miniChartsPerRow | The number of minicharts that will be shown per row. The number of rows will be determined by the total number of series divided by the miniChartsPerRow value. | Integer |
showPreviewChart | Specifies whether the preview chart will be displayed for grid charts.
(El valor predeterminado es False) | Boolean |
groupingPercent | The percentage threshold for grouping smaller slices into a single Other category. Provide an integer between 0 and 100 that represents the maximum percentage value for determining which slices are grouped into the Other category. | Integer |
donutSize | The size of the hole when displaying a pie chart as a donut. Provide an integer between 0 and 100 that represents the size of the hole as a percentage relative to the total size of the pie. | Integer |
sort | Specifies the sort order for the slices in the chart.
| String |
showDataLabels | Specifies whether data labels will be displayed.
| Boolean |
dataLabelsDisplay | Specifies the format that will be used for the data labels.
| 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 |
dataSource | 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 |
displaySize [displaySize,...] | 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 |
Propiedades
Propiedad | Explicación | Tipo de datos |
categoryField (Lectura y escritura) | The field name of the category variable. | String |
dataLabelsDisplay (Lectura y escritura) | Specifies the format that will be used for the data labels.
| String |
dataSource (Lectura y escritura) | 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 (Lectura y escritura) | The description of the chart. The description text appears at the bottom of the chart view. | String |
displaySize (Lectura y escritura) | 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 |
donutSize (Lectura y escritura) | The size of the hole when displaying a pie chart as a donut. Provide an integer between 0 and 100 that represents the size of the hole as a percentage relative to the total size of the pie. | Integer |
groupingPercent (Lectura y escritura) | The percentage threshold for grouping smaller slices into a single Other category. Provide an integer between 0 and 100 that represents the maximum percentage value for determining which slices are grouped into the Other category. | Integer |
legend (Lectura y escritura) | The properties of the chart legend.
| Object |
miniChartsPerRow (Lectura y escritura) | The number of minicharts that will be shown per row. The number of rows will be determined by the total number of series divided by the miniChartsPerRow value. | Integer |
numberFields (Lectura y escritura) | The field name or names for the numeric field or fields. Provide a single field name or a list of field names. | String |
showDataLabels (Lectura y escritura) | Specifies whether data labels will be displayed.
| Boolean |
showPreviewChart (Lectura y escritura) | Specifies whether the preview chart will be displayed for grid charts.
| Boolean |
sort (Lectura y escritura) | Specifies the sort order for the slices in the chart.
| String |
splitCategory (Lectura y escritura) | A categorical field that adds a separate series for each unique value in the field. | String |
theme (Lectura y escritura) | The name of the theme that will be applied to the chart. | String |
title (Lectura y escritura) | The title of the chart. The title text appears at the top of the chart view and is used as the label in the Contents pane on the List By Drawing Order tab . | String |
type (Sólo lectura) | The string value indicating the chart type. | String |
Descripción general del método
Método | Explicación |
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étodos
addToLayer (layer_or_layerfile)
Parámetro | Explicación | Tipo de datos |
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)
Parámetro | Explicación | Tipo de datos |
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 Pro. 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()
Muestra de código
Create a pie chart from a layer and export the chart to an .svg file.
import arcpy
activemap = arcpy.mp.ArcGISProject("current").activeMap
lyr = activemap.listLayers("nyc_noise_complaints")[0]
chart = arcpy.charts.Pie(categoryField="Complaint_Type", title="Noise Complaints by Type", dataSource=lyr)
chart.exportToSVG('pie.svg', width=1000, height=800)