Histogram

摘要

Histogram 类可创建直方图。 通过测量某些值在数据集中显示的频数，直方图直观地概述了连续型数字变量的分布。

了解有关 ArcGIS Pro 中的直方图的详细信息

说明

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

语法

 Histogram (x, {splitCategory}, {miniChartsPerRow}, {showPreviewChart}, {binCount}, {showMean}, {showMedian}, {showStandardDeviation}, {showComparisonDistribution}, {dataTransformationType}, {dataTransformationParameters}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize})

参数	说明	数据类型
x	The field name for the x-axis variable. The field must be a numeric field.	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. True—The preview chart will be displayed. False—The preview chart will not be displayed. (默认值为 False)	Boolean
binCount	The number of bins to display in the histogram.	Integer
showMean	Specifies whether the mean statistical line is visible in the histogram. True—The mean line is visible in the histogram. False—The mean line is not visible in the histogram.	Boolean
showMedian	Specifies whether the median statistical line is visible in the histogram. True—The median line is visible in the histogram. False—The median line is not visible in the histogram.	Boolean
showStandardDeviation	Specifies whether the standard deviation lines are visible in the histogram. True—The standard deviation lines are visible in the histogram. False—The standard deviation lines are not visible in the histogram.	Boolean
showComparisonDistribution	Specifies whether the normal distribution comparison line is visible in the histogram. True—The comparison line is visible in the histogram. False—The comparison line is not visible in the histogram.	Boolean
dataTransformationType	Specifies the data transformation type. none—No transformation is applied. logarithmic—A logarithmic transformation is applied. squareRoot—A square root transformation is applied. inverse—An inverse transformation is applied. boxCox—A box-cox transformation is applied.	String
dataTransformationParameters	The data transformation parameters for the Box-Cox transformation. This parameter accepts a two-item list in which the first item is the power parameter and the second item is the shift parameter.	List
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
yTitle	The title of the 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 an ArcGIS Notebook, the data source will be read and rendered on the chart. Valid data sources include the following: Paths to datasets, including local datasets, UNC paths, and service URLs Arrow table objects Layer or Table objects	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

属性

属性	说明	数据类型
binCount (可读写)	要显示在直方图中的条柱数。	Integer
dataSource (可读写)	图表的数据源。 当通过 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebook 中时，将读取数据源并将其呈现在图表上。 其中包括以下有效数据源： 数据集的路径（包括本地数据集、UNC 路径和服务 URL） Arrow 表对象 Layer 或 Table 对象	Object
dataTransformationType (可读写)	指定数据变换类型。 none—不应用变换。 logarithmic—应用对数变换。 squareRoot—应用平方根变换。 inverse—应用逆变换。 boxCox—应用 Box-Cox 变换。	String
description (可读写)	图表的描述。 该描述文本会显示于图表视图底部。	String
displaySize (可读写)	当使用 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebook 中时，图表的大小。 该值必须指定为两个项目的列表，其中第一个项目是图表的宽度，第二个项目是图表的高度。	List
legend (可读写)	图表图例的属性。 alignment - 指定图例的对齐。 对齐选项为 left、bottom、top 和 right。 title - 图例的标题。 visible - 指定是否在图表视图中显示图例。 True 显示图例，False 隐藏图例。	Object
miniChartsPerRow (可读写)	每行显示的迷你图表的数量。 行数将由系列总数除以 miniChartsPerRow 值确定。	Integer
showComparisonDistribution (可读写)	指定是否在直方图中显示正态分布比较线。 True—直方图中的比较线可见。 False—直方图中的比较线不可见。	Boolean
showMean (可读写)	指定是否在直方图中显示平均统计线。 True—平均线图在直方图中可见。 False—平均线图在直方图中不可见。	Boolean
showMedian (可读写)	指定是否在直方图中显示中位统计线。 True—中值线在直方图中可见。 False—中值线在直方图中不可见。	Boolean
showPreviewChart (可读写)	指定是否在格网图表中显示预览图表。 True—将显示预览图表。 False—不会显示预览图表。	Boolean
showStandardDeviation (可读写)	指定是否在直方图中显示标准差线。 True—标准差线在直方图中可见。 False—标准差线在直方图中不可见。	Boolean
splitCategory (可读写)	类别字段，将为字段中每一个唯一值添加单独的系列。	String
theme (可读写)	将应用于图表的主题的名称。	String
title (可读写)	图表的标题。 标题文本显示于图表视图顶部，并用作内容窗格中按绘制顺序列出选项卡 的标注。	String
type (只读)	用于指示图表类型的字符串值。	String
x (可读写)	x 轴变量的字段名称。 该字段必须为数值字段。	String
xAxis (可读写)	设置 x 轴的属性； addGuide - 使用 Guide 对象向轴添加一条参考线。 field - x 轴变量的字段名称。 该字段必须为数值字段。 logarithmic - Histogram 类不支持此属性。 maximum - 最大轴边界。 minimum - 最小轴边界。 sort - Histogram 类不支持此属性。 title - 图表中所显示的轴的标注。	Object
yAxis (可读写)	设置 y 轴的属性： addGuide - 使用 Guide 对象向轴添加一条参考线。 field - Histogram 类不支持此属性。 logarithmic - Histogram 类不支持此属性。 maximum - 最大轴边界。 minimum - 最小轴边界。 sort - Histogram 类不支持此属性。 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 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

chart = arcpy.charts.Histogram("price", binCount=20, showMedian=True)																											
chart.dataSource = "airbnb_listings"
chart.title = "Distribution of AirBnB Listing Price"
chart.exportToSVG("histogram.svg", width=1000, height=800)