Box

摘要

箱形图允许您通过其四分位数来显示和比较数值的分布与集中趋势。

了解有关 ArcGIS Pro 中的箱形图的详细信息

说明

创建图表对象时，必须使用参数名指定类构造函数的可选参数；这些可选参数不能通过参数位置指定。 有关如何使用关键字指定参数的示例，请参阅代码示例部分。

语法

 Box (y, {x}, {splitCategory}, {splitCategoryAsMeanLine}, {standardizeValues}, {showOutliers}, {rotated}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize})

参数	说明	数据类型
y	The fields to display as boxes. Specify a single field name or a list of field names.	String
x	The x-axis field is used to create multiple series box plots by setting the category. See the documentation on box plots for more information.	String
splitCategory	A second categorical field that adds a separate series or box for each unique value in the field.	String
splitCategoryAsMeanLine	Multiple-series box plots created with a split field can be displayed as mean lines or as side-by-side boxes. True displays split multiple series as mean lines. False displays multiple series as side-by-side boxes. (默认值为 False)	Boolean
standardizeValues	Box plots created from multiple fields are standardized by default. True displays standardized values. False displays nonstandardized values. (默认值为 True)	Boolean
showOutliers	Indicates whether outliers are shown as points extending beyond the whiskers. True displays outliers as points. False includes outliers in whiskers. (默认值为 False)	Boolean
rotated	Indicates whether boxes are viewed vertically or horizontally. Boxes are displayed vertically by default. True rotates boxes horizontally. False displays boxes vertically. (默认值为 False)	Boolean
title	Sets 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	Sets the description of the chart. The description text appears at the bottom of the chart view.	String
xTitle	Sets the title for the x-axis of the chart.	String
yTitle	Sets the title for the y-axis of the chart.	String
dataSource	Sets the data source of the chart. When a chart is exported using the exportToSVG method or displayed in an ArcGIS Notebook, the data source is read and rendered on the chart. Valid data sources include paths to datasets, including local datasets, UNC paths, and service URLs, and arcpy.mp Layer objects.	Object
displaySize [displaySize,...]	Sets 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, where the first item is the width of the chart and the second item is the height of the chart.	List

属性

属性	说明	数据类型
dataSource (可读写)	设置图表的数据源。 当通过 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebook 中时，将读取数据源并将其呈现在图表上。 有效的数据源包括数据集的路径，包括本地数据集、UNC 路径和服务 URL，以及 arcpy.mp Layer 对象。	Object
description (可读写)	设置图表描述。 该描述文本会显示于图表视图底部。	String
displaySize (可读写)	当使用 exportToSVG 方法导出图表的大小或将其显示在 ArcGIS Notebook 中时，需要对其进行设置。 该值必须指定为两个项目的列表，其中第一个项目是图表的宽度，第二个项目是图表的高度。	List
legend (可读写)	设置图表图例的属性。 visible - 指示是否在图表视图中显示图例。 True 将显示图例。 False 将隐藏图例。 title - 针对图例显示的标题。	Object
rotated (可读写)	指示以垂直方式还是水平方式显示图表。 默认情况下，图表将垂直显示。 True 将水平旋转图表。 False 将垂直显示图表。	Boolean
showOutliers (可读写)	指示是否将异常值显示为超出须线范围的点。 True 将异常值显示为点。 False 将异常值包括在须线内。	Boolean
splitCategory (可读写)	第二个类别字段，将为字段中每一个唯一值添加单独的系列或箱形。	String
splitCategoryAsMeanLine (可读写)	使用分割字段创建的多系列箱形图可以显示为平均线图或并排箱形图。 True 将分割的多个系列显示为平均线图。 False 将分割的多个系列显示为并排箱形图。	Boolean
standardizeValues (可读写)	默认对根据多个字段创建的箱形图进行标准化。 True 将显示标准化值。 False 将显示非标准化值。	Boolean
title (可读写)	设置图表的标题。 标题文本显示于图表视图顶部，并用作内容窗格中按绘制顺序列出选项卡 的标注。	String
type (只读)	用于指示图表类型的字符串值。	String
x (可读写)	用于通过设置类别来创建多个系列箱形图的字段名称。 有关详细信息，请参阅有关箱形图的文档。	String
xAxis (可读写)	设置 x 轴的属性。 field - 用于通过设置类别来创建多个系列箱形图的字段名称。 logarithmic - Box 类不支持此属性。 maximum - 最大轴边界。 minimum - 最小轴边界。 sort - 此轴采用的排序方法。 ASC 为升序排序，DESC 为降序排序。 title - 图表中所显示的轴的标注。	Object
y (可读写)	要显示为方框的一个或多个字段。 必须指定一个字段名或一个字段名称列表。	String
yAxis (可读写)	设置 y 轴的属性。 field - 要显示为方框的一个或多个字段。 必须指定一个字段名或一个字段名称列表。 logarithmic - Box 类不支持此属性。 maximum - 最大轴边界。 minimum - 最小轴边界。 sort - 此轴采用的排序方法。 MEAN_ASC 或 MEAN_DESC 用于按平均值排序箱子。 MEDIAN_ASC 或 MEDIAN_DESC 用于按中值排序箱子。 title - 图表中所显示的轴的标注。	Object

方法概述

方法	说明
addToLayer (layer_or_layerfile)	将图表对象添加到图层或独立表中。
exportToSVG (path, width, height)	将图表导出为 SVG 格式。
updateChart ()	更新图表属性可以同步对象与之前添加到图层的图表之间的更改。

方法

addToLayer (layer_or_layerfile)

参数	说明	数据类型
layer_or_layerfile	The chart will be added to the target object. The layer_or_layerfile argument can be a Layer or a Table object.	Object

定义图表属性后的最后一步通常是使用 addToLayer 方法将图表对象添加到图层或表中。

将图表添加到现有图层。

import arcpy

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

aprx = arcpy.mp.ArcGISProject('current')
censusLayer = aprx.listMaps()[0].listLayers('Census Block Groups')[0]

# Set data source of chart object to a layer within current project
chart.dataSource = censusLayer

# Save the chart to file with dimensions width=500, height=500
chart.exportToSVG('populationByState.svg', 500, 500)

将具有要素服务数据源的图表导出到 .svg 文件中。

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 方法将图表属性更改同步到图层中。

chart.addToLayer(myLayer)

# Further modification is necessary
chart.description = "Data from the U.S. Census Bureau"
chart.updateChart()

代码示例

可以使用 .csv 文件来创建箱形图，然后将该箱形图导出至 .svg 文件。

import arcpy
chart = arcpy.charts.Box(y=["pct_diabetes", "pct_asthma", "pct_heart"], 
                         splitCategory="State", 
                         dataSource="chronic_health_conditions.csv")
chart.title = "Distribution of Chronic Health Conditions by State"
chart.exportToSVG("box.svg", width=700, height=600)