说明
创建此对象时,必须使用参数名指定类构造函数的可选参数;这些可选参数不能通过参数位置指定。 有关如何使用关键字指定参数的示例,请参阅代码示例部分。
语法
Pie ({categoryField}, {numberFields}, {splitCategory}, {miniChartsPerRow}, {showPreviewChart}, {groupingPercent}, {donutSize}, {sort}, {showDataLabels}, {dataLabelsDisplay}, {title}, {description}, {dataSource}, {displaySize})
参数 | 说明 | 数据类型 |
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.
(默认值为 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 |
属性
属性 | 说明 | 数据类型 |
categoryField (可读写) | 类别变量的字段名称。 | String |
dataLabelsDisplay (可读写) | 指定将用于数据标注的格式。
| String |
dataSource (可读写) | 图表的数据源。 当通过 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebook 中时,将读取数据源并将其呈现在图表上。 其中包括以下有效数据源: | Object |
description (可读写) | 图表的描述。 该描述文本会显示于图表视图底部。 | String |
displaySize (可读写) | 当使用 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebook 中时,图表的大小。 该值必须指定为两个项目的列表,其中第一个项目是图表的宽度,第二个项目是图表的高度。 | List |
donutSize (可读写) | 将饼图显示为圆环时的孔大小。 提供的值为介于 0 和 100 之间的整数,用于将孔大小表示为相对于饼图总大小的百分比。 | Integer |
groupingPercent (可读写) | 用于将较小的扇区分组为单一 Other 类别的百分比阈值。 提供的值为介于 0 和 100 之间的整数,表示用于确定分组到 Other 类别中的扇区的最大百分比值。 | Integer |
legend (可读写) | 图表图例的属性。
| Object |
miniChartsPerRow (可读写) | 每行显示的迷你图表的数量。 行数将由系列总数除以 miniChartsPerRow 值确定。 | Integer |
numberFields (可读写) | 一个或多个数值字段的字段名称。 提供一个字段名或一个字段名称列表。 | String |
showDataLabels (可读写) | 指定是否将显示数据标注。
| Boolean |
showPreviewChart (可读写) | 指定是否在格网图表中显示预览图表。
| Boolean |
sort (可读写) | 指定饼图中扇区的排序顺序。
| String |
splitCategory (可读写) | 类别字段,将为字段中每一个唯一值添加单独的系列。 | String |
theme (可读写) | 将应用于图表的主题的名称。 | String |
title (可读写) | 图表的标题。 标题文本显示于图表视图顶部,并用作内容窗格中按绘制顺序列出选项卡 的标注。 | String |
type (只读) | 用于指示图表类型的字符串值。 | String |
方法概述
方法 | 说明 |
addToLayer (layer_or_layerfile) | addToLayer 方法可将图表对象添加到图层或表视图。 |
exportToSVG (path, width, height) | exportToSVG 方法可将图表导出为 SVG 格式。 |
updateChart () | 该 updateChart 方法可更新图表属性,以同步对象与之前添加到图层的图表之间的更改。 |
方法
addToLayer (layer_or_layerfile)
参数 | 说明 | 数据类型 |
layer_or_layerfile | The chart will be added to the target object. This argument can be a Layer or Table object. | Object |
使用 addToLayer 方法将图表对象添加到图层或表通常是定义图表属性之后的最终步骤。
将图表添加到现有图层。
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)
参数 | 说明 | 数据类型 |
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 |
在某些情况下,您可能希望将图表另存为可在 ArcGIS Pro 外部共享和查看的图形。 导出为 SVG 图形格式是有好处的,因为图表元素和文本将存储为可在矢量图形软件中进行独立修改的矢量元素。 SVG 图形也可以调整为任何比例,而不会出现像素化或质量下降的情况。
将具有工程图层数据源的图表导出到 .svg 文件中。
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)
将具有要素服务数据源的图表导出到 .svg 文件中。
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 ()
使用 addToLayer 方法将图表对象添加到图层通常是定义图表属性之后的最终步骤。
您也可以修改原始图表的属性,而不是从头开始创建新图表。 然后,您可以使用 updateChart 方法将所有更改同步到已添加到该图层的图表中。 由此可在图表属性窗格和图表视图中显示所做的更改。
可以使用 updateChart 方法将图表属性更改同步到图层中。
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()
代码示例
基于图层创建饼图并将该图表导出为 .svg 文件。
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)