Наверх

CalendarHeat

В этом разделе

  1. Краткая информация
  2. Обсуждение
  3. Синтаксис
  4. Свойства
  5. Обзор метода
  6. Методы
  7. Пример кода

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

Класс 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

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

Задает статистический расчет, применяемый к значениям, агрегированным в каждой ячейке.

  • COUNT—Определяется общее количество записей.
  • SUM—Будет вычислена сумма всех значений.
  • MEAN—Будет вычислено среднее всех значений.
  • MEDIAN—Будет вычислена медиана всех значений.
  • MIN—Определяется минимальное значение.
  • MAX—Определяется максимальное значение.
String
nullPolicy

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

  • null—Ячейки отображаются со значением null.
  • zero—Ячейки отображаются с нулевым значением.
String
classificationMethod

Задает метод классификации, используемый для визуализации цвета ячейки и классификации данных.

  • equalIntervals—Используется метод равных интервалов.
  • geometricalIntervals—Используется метод геометрических интервалов.
  • naturalBreaks—Используется метод естественных границ.
  • quantiles—Используется метод квантилей.
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
(чтение и запись)

Задает статистический расчет, применяемый к значениям, агрегированным в каждой ячейке.

  • 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-адреса сервисов
  • Объекты таблицы Arrow
  • Объекты Layer или Table

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

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

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

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

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

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

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

Определяет, будет ли ячейка високосного дня (29 февраля) в диаграмме.

  • True—Включает день високосного года.
  • False—Исключает день високосного года.
Boolean
invertViews
(чтение и запись)

Указывает, будет ли вид календаря инвертирован.

  • True—Отображает инвертированный вид календаря.
  • False—Не отображает вид календаря инвертированным.
Boolean
legend
(чтение и запись)

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

  • alignment—Определяет выравнивание легенды Опции выравнивания: left, bottom, top и right.
  • title - заголовок легенды.
  • visible - задает, будет ли легенда отображаться в виде диаграммы. True отображает легенду, False скрывает легенду.
Object
nullPolicy
(чтение и запись)

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

  • null—Ячейки отображаются со значением null.
  • zero—Ячейки отображаются с нулевым значением.
String
numberField
(чтение и запись)

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

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

Имя темы, которая будет применена к диаграмме.

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)

Метод 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()

Пример кода

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

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. Пример кода