DataClock

摘要

数据时钟可直观地将时态数据汇总到两个维度,以揭示随时间变化的季节性或周期性模式和趋势。

了解有关 ArcGIS Pro 中数据时钟的详细信息

说明

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

语法

 DataClock (dateField, {numberField}, {timeUnitsRingWedge}, {aggregation}, {nullPolicy}, {classificationMethod}, {classCount}, {title}, {description}, {dataSource}, {displaySize})
参数说明数据类型
dateField

The name of the date field that is used to create the chart.

String
numberField

The name of the field that is aggregated and used to determine the color of the chart cells.

String
timeUnitsRingWedge

The description for the time-unit pair supported in the data clock chart. The following options are supported:

  • YEARS_MONTHS
  • YEARS_WEEKS
  • YEARS_DAYS
  • WEEKS_DAYS
  • DAYS_HOURS

String
aggregation

The statistical calculation applied to values aggregated into each cell. Supported statistics are COUNT, SUM, MEAN, MEDIAN, MIN, and MAX.

String
nullPolicy

How summarized cells returning a null value are displayed. Supported options are null and zero.

String
classificationMethod

The classification method used to visualize cell color. Supported options are equalIntervals, geometricalIntervals, naturalBreaks, and quantiles

String
classCount

The number of classes used in the classification method.

Integer
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
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

属性

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

应用于聚合到每个像元中的值的统计计算。 受支持的统计数据包括 COUNTSUMMEANMEDIANMINMAX

String
classCount
(可读写)

用于分类方法中的类数。

Integer
classificationMethod
(可读写)

用于可视化像元颜色的分类方法。 受支持的选项为 equalIntervalsgeometricalIntervalsnaturalBreaksquantiles

String
dataSource
(可读写)

设置图表的数据源。 当通过 exportToSVG 方法导出图表或将其显示在 ArcGIS Notebook 中时,将读取数据源并将其呈现在图表上。 有效的数据源包括数据集的路径,包括本地数据集、UNC 路径和服务 URL,以及 arcpy.mp Layer 对象。

Object
dateField
(可读写)

用于创建图表的日期字段的名称。

String
description
(可读写)

设置图表描述。 该描述文本会显示于图表视图底部。

String
displaySize
(可读写)

当使用 exportToSVG 方法导出图表的大小或将其显示在 ArcGIS Notebook 中时,需要对其进行设置。 该值必须指定为两个项目的列表,其中第一个项目是图表的宽度,第二个项目是图表的高度。

List
legend
(可读写)

设置图表图例的属性。

  • visible - 指示是否在图表视图中显示图例。 True 将显示图例。 False 将隐藏图例。
  • title - 针对图例显示的标题。
Object
nullPolicy
(可读写)

返回空值的汇总像元的显示方式。 受支持的选项为 nullzero

String
numberField
(可读写)

聚合的字段的名称,用于确定图表单元格的颜色。

String
timeUnitsRingWedge
(可读写)

数据时钟图中支持的时间单位对的描述。 支持以下选项:

  • YEARS_MONTHS
  • YEARS_WEEKS
  • YEARS_DAYS
  • WEEKS_DAYS
  • DAYS_HOURS

String
title
(可读写)

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

String
type
(只读)

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

String

方法概述

方法说明
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()

代码示例

使用当前工程中的一个图层创建数据时钟图表,然后将该图表导出至 .svg 文件。

import arcpy
lyr = arcpy.mp.ArcGISProject("current").listMaps()[0].listLayers("car_accidents")[0]
chart = arcpy.charts.DataClock(dateField="Date", aggregation="count", 
                               timeUnitsRingWedge="WEEKS_DAYS", dataSource=lyr)
chart.exportToSVG("data_clock.svg", width=750, height=500)