CalendarHeat

Краткая информация

Календарные диаграммы интенсивности визуализируют структуру временных данных путем объединения инцидентов в календарную сетку.

Более подробно о календарных диаграммах интенсивности в ArcGIS Pro.

Обсуждение

При создании объекта диаграммы необязательные аргументы для конструктора классов должны указываться с помощью имени аргумента; их нельзя указывать по позиции аргумента. См. раздел с примерами кодов, содержащий пример того, как можно задавать аргументы, используя ключевые слова.

Синтаксис

 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

The description for the time-unit pair supported in the data clock chart. Supported options are YEAR_MONTHSDAYS and WEEK_DAYSHOURS.

String
viewType

Configures the calendar to be collapsed into a single calendar view or to be displayed as sequential calendar views. Supported options are SINGLE and SEQUENTIAL.

String
includeLeapDay

Indicates whether to include the leap day (February 29) cell in the chart.

Boolean
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
xTitle

Sets the title for the x-axis of the chart.

String
yTitle

Sets the title for the y-axis of the chart.

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
(чтение и запись)

Статистический расчет, применяемый к значениям, агрегированным в каждой ячейке. Поддерживается следующая статистика: COUNT, SUM, MEAN, MEDIAN, MIN и MAX.

String
calendarType
(чтение и запись)

Описание пары единиц измерения времени, которые поддерживаются в диаграмме календарной интенсивности. Поддерживаются следующие опции: YEAR_MONTHSDAYS и WEEK_DAYSHOURS.

String
classCount
(чтение и запись)

Число классов, используемых в методе классификации.

Integer
classificationMethod
(чтение и запись)

Метод классификации, используемый для визуализации цвета ячейки. Поддерживаются следующие опции: equalIntervals, geometricalIntervals, naturalBreaks и quantiles.

String
dataSource
(чтение и запись)

Устанавливает источник данных диаграммы. Когда диаграмма экспортируется с использованием метода exportToSVG или отображается в ArcGIS Notebook, источник данных считывается и отображается на диаграмме. К допустимым источникам данных относятся пути к наборам данных, включая локальные наборы данных, пути UNC, URL-адреса служб и объекты arcpy.mp Layer.

Object
dateField
(чтение и запись)

Имя поля даты, которое используется для создания диаграммы.

String
description
(чтение и запись)

Задает описание диаграммы. Текст диаграммы отображается внизу вида диаграммы.

String
displaySize
(чтение и запись)

Задает размер диаграммы при экспорте с помощью метода exportToSVG или при отображении в ArcGIS Notebook. Значение должно быть указано как список из двух элементов где первый элемент является шириной диаграммы, а второй - высотой.

List
includeLeapDay
(чтение и запись)

Задает использование ячейки високосного дня (29 февраля) в диаграмме.

Boolean
legend
(чтение и запись)

Задает свойства легенды диаграммы.

  • visible – показывает, отображается ли легенда в виде диаграммы. True – отображает легенду. False - скрывает легенду.
  • title – заголовок, отображаемый для легенды.
Object
nullPolicy
(чтение и запись)

Как отображаются суммированные ячейки, возвращающие значение null. Поддерживаются следующие опции: null и zero.

String
numberField
(чтение и запись)

Имя поля, которое агрегируется и используется для определения цвета ячеек диаграммы.

String
title
(чтение и запись)

Задает заголовок диаграммы. Текст заголовка появляется в верхней части вида диаграммы и используется как надпись на панели Содержание на вкладке По отображению Содержание на вкладке По отображению.

String
type
(только чтение)

Строковое значение, обозначающее тип диаграммы.

String
viewType
(чтение и запись)

Настраивает свертывание календаря в одно представление календаря или отображение в виде последовательных представлений календаря. Поддерживаемые опции - SINGLE и SEQUENTIAL.

String
xAxis
(чтение и запись)

Задает свойства оси x.

  • field - имя поля даты, которое используется для создания диаграммы.
  • logarithmic - это свойство не поддерживается для класса CalendarHeat.
  • maximum - это свойство не поддерживается для класса CalendarHeat.
  • minimum - это свойство не поддерживается для класса CalendarHeat.
  • sort - это свойство не поддерживается для класса CalendarHeat.
  • title – подпись оси, отображаемая в диаграмме.
Object
yAxis
(чтение и запись)

Задает свойства оси y.

  • field - имя поля, которое агрегируется и используется для определения цвета ячеек диаграммы.
  • logarithmic - это свойство не поддерживается для класса CalendarHeat.
  • maximum - это свойство не поддерживается для класса CalendarHeat.
  • minimum - это свойство не поддерживается для класса CalendarHeat.
  • sort - это свойство не поддерживается для класса CalendarHeat.
  • title – подпись оси, отображаемая в диаграмме.
Object

Обзор метода

МетодОписание
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()

Пример кода

Создайте календарную диаграмму интенсивности и добавьте ее к слою в текущем проекте.


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)