Box

摘要

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

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

说明

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

语法

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

参数	说明	数据类型
y	要显示为箱形的字段。 提供一个字段名或一个字段名称列表。	String
x	x 轴字段用于通过设置类别来创建多系列箱形图。 有关详细信息，请参阅箱形图。	String
splitCategory	第二个类别字段，将为字段中每一个唯一值添加单独的系列或箱形。	String
splitCategoryAsMeanLine	指定使用分割字段创建的多系列箱形图显示为平均线图，还是并排箱形图。 True—Display split multiple-series box plots as mean lines. False—Display multiple-series box plots as side-by-side boxes. (默认值为 False)	Boolean
standardizeValues	指定是否对根据多个字段创建的箱形图进行标准化。 True—Display standardized values. False—Display nonstandardized values. (默认值为 True)	Boolean
showOutliers	指定是否将异常值显示为超出须线范围的点。 True—Display outliers as points. False—Include outliers in whiskers. (默认值为 False)	Boolean
rotated	指定将以垂直方式还是水平方式显示箱形。 True—The chart is rotated so that boxes will be displayed horizontally. False—Boxes will be displayed vertically. (默认值为 False)	Boolean
title	图表的标题。 标题文本显示在图表视图的顶部，并在内容窗格中用作图表的标注。	String
description	图表的描述。 该描述文本会显示于图表视图底部。	String
xTitle	图表 x 轴的标题。	String
yTitle	图表 y 轴的标题。	String
dataSource	图表的数据源。 当通过 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebooks 中时，将读取数据源并将其呈现在图表上。 其中包括以下有效数据源： 数据集的路径（包括本地数据集、UNC 路径和服务 URL） Apache Arrow 表对象 Layer 或 Table 对象	Object
displaySize [displaySize,...]	当使用 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebooks 中时，图表的大小。 该值必须指定为两个项目的列表，其中第一个项目是图表的宽度，第二个项目是图表的高度。	List
theme	指定将应用于图表的主题。 Light—The Light theme will be applied. Medium—The Medium theme will be applied. Dark—The Dark theme will be applied.	String

属性

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

方法概述

方法	说明
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 AllSource 外部共享和查看的图形。 导出为 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()

代码示例

可以使用 .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)