返回顶部

Bar

在本主题中

  1. 摘要
  2. 说明
  3. 语法
  4. 属性
  5. 方法概述
  6. 方法
  7. 代码示例

摘要

Bar 类可创建条形图。 条形图使用比例条柱长度来表示值以对分类数据进行汇总和比较。

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

说明

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

语法

Bar (x, {y}, {aggregation}, {splitCategory}, {multiSeriesDisplay}, {miniChartsPerRow}, {showPreviewChart}, {showMovingAverage}, {movingAveragePeriod}, {timeBinningProperties}, {rotated}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize})
参数说明数据类型
x

The field name for the x-axis variable. The field must be a category or a date field. If an empty string is specified, the chart will match the layer symbology.

String
y

The field names for the numeric fields. Provide a single field name or a list of field names.

String
aggregation

Specifies the statistical calculation that will be applied to values that occur at the same value along the x-axis.

  • <None>—Each value will be plotted on the chart regardless of overlap or recurring values.
  • COUNT—The total number of records will be identified and applied.
  • SUM—The sum of all values will be calculated and applied.
  • MEAN—The mean of all values will be calculated and applied.
  • MEDIAN—The median of all values will be identified and applied.
  • MIN—The minimum value will be identified and applied.
  • MAX—The maximum value will be identified and applied.
String
splitCategory

A second categorical field that adds a separate series or bar for each unique value in the field.

String
multiSeriesDisplay

Specifies the display type for a bar chart with multiple series.

  • sideBySide—The series will be displayed side by side.
  • stacked—The series will be displayed stacked.
  • stacked100—The series will be displayed 100 percent stacked.
  • grid—The series will be displayed as a grid of miniplots.
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
showMovingAverage

Specifies whether the moving average line will be displayed for temporal bar charts.

  • True—The moving average line will be displayed.
  • False—The moving average line will be hidden.

(默认值为 False)

Boolean
movingAveragePeriod

The size of the moving average period.

Integer
timeBinningProperties

The time binning properties from the TimeBinningProperties class.

Object
rotated

Specifies whether bars will be displayed vertically or horizontally.

  • True—Bars will be displayed horizontally.
  • False—Bars will be displayed vertically.

(默认值为 False)

Boolean
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

属性

属性说明数据类型
aggregation
(可读写)

指定统计计算适用于沿 x 轴出现相同值的值。

  • <None>—每个值都会在图表中绘制，无论值是否重叠或循环。
  • COUNT—将识别并应用总记录数。
  • SUM—将计算并应用所有值的总和。
  • MEAN—将计算并应用所有值的平均值。
  • MEDIAN—将识别并应用所有值的中值。
  • MIN—将识别并应用最小值。
  • MAX—将识别并应用最大值。
String
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
miniChartsPerRow
(可读写)

每行显示的迷你图表的数量。 行数将由系列总数除以 miniChartsPerRow 值确定。

Integer
movingAveragePeriod
(可读写)

移动平均时间段大小。

Integer
multiSeriesDisplay
(可读写)

指定具有多个系列的条形图的显示类型。

  • sideBySide—系列将并排显示。
  • stacked—系列将堆叠显示。
  • stacked100—系列将按 100% 堆叠显示。
  • grid—系列将显示为迷你图格网。
String
nullCategoryColor
(可读写)

空类别条的十六进制颜色值。

String
nullCategoryLabel
(可读写)

空类别条的 x 轴标注。

String
rotated
(可读写)

指定将以垂直方式还是水平方式显示图表。

  • True—将以水平方式显示图表。
  • False—将以垂直方式显示图表。
Boolean
showMovingAverage
(可读写)

指定是否针对时间条形图显示移动平均线。

  • True—将显示移动平均线。
  • False—将隐藏移动平均线。
Boolean
showNullCategory
(可读写)

指定空值是否按附加条进行汇总。

  • True—显示空类别条。
  • False—空类别条已隐藏。
Boolean
showPreviewChart
(可读写)

指定是否在格网图表中显示预览图表。

  • True—将显示预览图表。
  • False—不会显示预览图表。
Boolean
splitCategory
(可读写)

第二个类别字段，将为字段中每一个唯一值添加单独的系列或条柱。

String
title
(可读写)

图表的标题。 标题文本显示于图表视图顶部，并用作内容窗格中按绘制顺序列出选项卡 按绘制顺序列出 的标注。

String
timeBinningProperties
(可读写)

来自 TimeBinningProperties 类的时间分箱属性。

Object
type
(只读)

用于指示图表类型的字符串值。

String
theme
(可读写)

将应用于图表的主题的名称。

String
x
(可读写)

x 轴变量的字段名称。 该字段必须为类别或日期字段。 如果指定空字符串，图表将与图层符号匹配。

String
xAxis
(可读写)

设置 x 轴的属性。

  • field - x 轴变量的字段名称。 该字段必须为类别或日期字段。
  • logarithmic - Bar 类不支持此属性。
  • maximum - 最大轴边界。
  • minimum - 最小轴边界。
  • sort - 指定应用于此轴的排序方法。 ASC 为升序排序，DESC 为降序排序。 可通过分配有序的类别名称列表指定自定义排序顺序。
  • title - 图表中所显示的轴的标注。
  • useAdaptiveBounds - 指定格网图表是带自适应还是固定轴边界显示。 True 显示带自适应边界的轴。 False 显示带固定边界的轴。
Object
y
(可读写)

一个或多个数值字段的字段名称。 此属性必须指定单一字段名或字段名称列表。

String
yAxis
(可读写)

设置 y 轴的属性。

  • addGuide - 使用 Guide 对象向轴添加一条参考线。
  • field - 一个或多个数值字段的字段名称。 此属性必须指定单一字段名或字段名称列表。
  • logarithmic - Bar 类不支持此属性。
  • maximum - 最大轴边界。
  • minimum - 最小轴边界。
  • sort - 指定应用于此轴的排序方法。 ASC 为升序排序，DESC 为降序排序。
  • title - 图表中所显示的轴的标注。
  • useAdaptiveBounds - 指定格网图表是带自适应还是固定轴边界显示。 True 显示带自适应边界的轴。 False 显示带固定边界的轴。
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

url = r"https://services1.arcgis.com/hLJbHVT9ZrDIzK0I/arcgis/rest/services/CrimesChiTheft/FeatureServer/0"
chart = arcpy.charts.Bar(x="BEAT", aggregation="count", title="Chicago Thefts by Beat", dataSource=url)
chart.exportToSVG('bar.svg', width=800, height=500)

有关此主题的反馈?

在本主题中
  1. 摘要
  2. 说明
  3. 语法
  4. 属性
  5. 方法概述
  6. 方法
  7. 代码示例