トップへ戻る

CalendarHeat

このトピックの内容

  1. サマリー
  2. 説明
  3. 構文
  4. プロパティ
  5. 方法の概要
  6. 方法
  7. コードのサンプル

サマリー

The CalendarHeat class create calendar heat charts. Calendar heat charts visualize patterns in temporal data by aggregating incidents into a calendar grid.

Learn more about calendar heat charts in ArcGIS Pro

説明

When creating this object, optional arguments for the class constructor must be specified using the argument name; they cannot be specified by argument position. See the Code sample section for an example of how to specify arguments using keywords.

構文

CalendarHeat (dateField, {numberField}, {calendarType}, {viewType}, {includeLeapDay}, {aggregation}, {nullPolicy}, {classificationMethod}, {classCount}, {title}, {description}, {xTitle}, {yTitle}, {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
calendarType

Specifies the time-unit pair that is supported in the calendar heat chart.

  • YEAR_MONTHSDAYS—Display months on the row axis and day of month on the column axis.
  • WEEK_DAYSHOURS—Display days on the row axis and hour of day on the column axis.
String
viewType

Specifies whether the calendar will be collapsed into a single calendar view or displayed as sequential calendar views.

  • SINGLE—Display as a single calendar view.
  • SEQUENTIAL—Display as sequential calendar views.
String
includeLeapDay

Specifies whether the leap day (February 29) cell will be included in the chart.

  • True—Include leap day.
  • False—Exclude leap day.
Boolean
aggregation

Specifies the statistical calculation that will be applied to values aggregated into each cell.

  • COUNT—The total number of records will be identified.
  • SUM—The sum of all values will be calculated.
  • MEAN—The mean of all values will be calculated.
  • MEDIAN—The median of all values will be calculated.
  • MIN—The minimum value will be identified.
  • MAX—The maximum value will be identified.
String
nullPolicy

Specifies how summarized cells returning a null value will be displayed.

  • null—Cells will be displayed as null.
  • zero—Cells will be displayed as zero.
String
classificationMethod

Specifies the classification method that will be used to visualize cell color and classify data.

  • equalIntervals—The equal interval method will be used.
  • geometricalIntervals—The geometric interval method will be used.
  • naturalBreaks—The natural breaks method will be used.
  • quantiles—The quantiles method will be used.
String
classCount

The number of classes used in the classification method.

Integer
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
(読み書き)

Specifies the statistical calculation that will be applied to values aggregated into each cell.

  • COUNT—The total number of records will be identified.
  • SUM—The sum of all values will be calculated.
  • MEAN—The mean of all values will be calculated.
  • MEDIAN—The median of all values will be calculated.
  • MIN—The minimum value will be identified.
  • MAX—The maximum value will be identified.
String
calendarType
(読み書き)

The description for the time-unit pair supported in the calendar heat chart.

  • YEAR_MONTHSDAYS—Display months on the row axis and day of month on the column axis.
  • WEEK_DAYSHOURS—Display days on the row axis and hour of day on the column axis.
String
classCount
(読み書き)

The number of classes used in the classification method.

Integer
classificationMethod
(読み書き)

Specifies the classification method that will be used to visualize cell color and classify data.

  • equalIntervals—The equal interval method will be used.
  • geometricalIntervals—The geometric interval method will be used.
  • naturalBreaks—The natural breaks method will be used.
  • quantiles—The quantiles method will be used.
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
dateField
(読み書き)

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

String
description
(読み書き)

The description of the chart. The description text appears at the bottom of the chart view.

String
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
includeLeapDay
(読み書き)

Specifies whether the leap day (February 29) cell will be included in the chart.

  • True—Include leap day.
  • False—Exclude leap day.
Boolean
invertViews
(読み書き)

Specifies whether the calendar view is inverted.

  • True—Displays the calendar view as inverted.
  • False—Does not display the calendar view as inverted.
Boolean
legend
(読み書き)

The properties of the chart legend.

  • alignment—Specifies the alignment of the legend. Alignment options are left, bottom, top, and right.
  • title—The title of the legend.
  • visible—Specifies whether the legend will be displayed in the chart view. True displays the legend, and False hides the legend.
Object
nullPolicy
(読み書き)

Specifies how summarized cells returning a null value will be displayed.

  • null—Cells will be displayed as null.
  • zero—Cells will be displayed as zero.
String
numberField
(読み書き)

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

String
theme
(読み書き)

The name of the theme that will be applied to the chart.

String
title
(読み書き)

The title of the chart. The title text appears at the top of the chart view and is used as the label in the Contents pane on the List By Drawing Order tab 描画順にリスト.

String
type
(読み取り専用)

The string value indicating the chart type.

String
viewType
(読み書き)

Specifies whether the calendar will be collapsed into a single calendar view or displayed as sequential calendar views.

  • SINGLE—Display as a single calendar view.
  • SEQUENTIAL—Display as sequential calendar views.
String
xAxis
(読み書き)

The properties of the x-axis.

  • field—The name of the date field that is used to create the chart.
  • logarithmic—This property is not supported for the CalendarHeat class.
  • maximum—This property is not supported for the CalendarHeat class.
  • minimum—This property is not supported for the CalendarHeat class.
  • sort—This property is not supported for the CalendarHeat class.
  • title—The label of the axis that displays on the chart.
Object
yAxis
(読み書き)

The properties of the y-axis.

  • field—The name of the field that is aggregated and used to determine the color of the chart cells.
  • logarithmic—This property is not supported for the CalendarHeat class.
  • maximum—This property is not supported for the CalendarHeat class.
  • minimum—This property is not supported for the CalendarHeat class.
  • sort—This property is not supported for the CalendarHeat class.
  • title—The label of the axis that displays on the chart.
Object

方法の概要

方法説明
addToLayer (layer_or_layerfile)

The addToLayer method adds the chart object to a layer or table view.

exportToSVG (path, width, height)

The exportToSVG method exports the chart to SVG format.

updateChart ()

The updateChart method updates chart properties to sync changes between the object and the chart previously added to a layer.

方法

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

Adding the chart object to a layer or table using the addToLayer method is often the final step after defining chart properties.

Add a chart to an existing layer.

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

In some cases, you may want to save the chart as a graphic that can be shared and viewed outside of ArcGIS Pro. Exporting to the SVG graphic format is beneficial, as the chart elements and text are stored as vector elements that can be independently modified in vector graphics software. An SVG graphic can also be resized to any scale without pixelation or loss in quality.

Export a chart that has a project layer data source to an .svg file.

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)

Export a chart that has a feature service data source to an .svg file.

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 ()

Adding the chart object to a layer using the addToLayer method is often the final step after defining chart properties.

You can also modify the properties of the original chart instead of starting with a new chart. You can then use the updateChart method to synchronize any changes into the chart that was added to the layer. This allows the changes you make to be presented in the Chart properties pane and chart view.

Use the updateChart method to synchronize chart property changes into a layer.

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()

コードのサンプル

Create a calendar heat chart and add it to a layer in the current project.

import arcpy

lyr = arcpy.mp.ArcGISProject("current").listMaps()[0].listLayers("car_accidents")[0]
chart = arcpy.charts.CalendarHeat(dateField="Date", calendarType="WEEK_DAYSHOURS", aggregation="count")
chart.addToLayer(lyr)

このトピックへのフィードバック

このトピックの内容
  1. サマリー
  2. 説明
  3. 構文
  4. プロパティ
  5. 方法の概要
  6. 方法
  7. コードのサンプル