Skip to main content

CalendarHeat

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

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

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

Обсуждение

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

Синтаксис

CalendarHeat(dateField, {numberField}, {calendarType}, {viewType}, {includeLeapDay}, {aggregation}, {nullPolicy}, {classificationMethod}, {classCount}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize}, {theme})

Имя Объяснение Тип данных

dateField

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

String

numberField

(Дополнительный)

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

String

calendarType

(Дополнительный)

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

  • 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

(Дополнительный)

Определяет, будет ли выполняться свертывание календаря в один вид календаря или отображение будет в виде последовательных видов календаря.

  • SINGLE—Display as a single calendar view.

  • SEQUENTIAL—Display as sequential calendar views.

String

includeLeapDay

(Дополнительный)

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

  • 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

(Дополнительный)

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

Integer

title

(Дополнительный)

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

String

description

(Дополнительный)

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

String

xTitle

(Дополнительный)

Заголовок оси х диаграммы.

String

yTitle

(Дополнительный)

Заголовок оси y диаграммы.

String

dataSource

(Дополнительный)

Источник данных диаграммы. Когда диаграмма экспортируется с использованием метода exportToSVG или отображается в ArcGIS Notebooks , источник данных считывается и отображается на диаграмме. К допустимым источникам данных относятся следующие:

  • Пути к наборам данных, включая локальные наборы данных, пути UNC, URL-адреса сервисов

  • Объекты таблицы Apache Arrow

  • Объекты Layer или Table

Object

displaySize

(Дополнительный)

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

List

theme

(Дополнительный)

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

  • Light—The Light theme will be applied.

  • Medium—The Medium theme will be applied.

  • Dark—The Dark theme will be applied.

String

Свойства

Имя Объяснение Тип данных

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-адреса сервисов

  • Объекты таблицы Apache 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

(Чтение / Запись)

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

  • Light—Будет применена светлая тема.

  • Medium—Будет применена средняя тема.

  • Dark—Будет применена темная тема.

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 добавляет объект диаграммы в представление слоя или таблицы.

Имя Объяснение Тип данных

layer_or_layerfile

The chart will be added to the target object. This argument can be a Layer or Table object.

Object

Добавьте диаграмму к существующему слою.

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)

exportToJPEG(path, width, height)

Метод exportToJPEG экспортирует диаграмму в формат JPEG.

Имя Объяснение Тип данных

path

The path where the chart will be exported in JPEG format.

String

width

The width of the output graphic.

Integer

height

The height of the output graphic.

Integer

Экспортируйте диаграмму, содержащую источник данных сервиса объектов в файл .jpeg.

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.exportToJPEG('theftsPerBeat.jpg', 800, 600)

exportToPNG(path, width, height)

Метод exportToPNG экспортирует диаграмму в формат PNG.

Имя Объяснение Тип данных

path

The path where the chart will be exported in PNG format.

String

width

The width of the output graphic.

Integer

height

The height of the output graphic.

Integer

Получите доступ к существующей диаграмме из слоя, обновите заголовок и экспортируйте ее в файл .png.

import arcpy

lyr = arcpy.mp.ArcGISProject('current').listLayers()[0]

# Retrieve the first chart belonging to the layer
chart = lyr.listCharts()[0]

# Update chart title
chart.title = 'Voter Turnout by State'

# Save the chart to PNG file with dimensions width=800, height=600
chart.exportToPNG('populationByState.png', 800, 600)

exportToSVG(path, width, height)

Метод exportToSVG экспортирует диаграмму в формат SVG.

Имя Объяснение Тип данных

path

Папка, в которой будет сохранена диаграмма в формате SVG.

String

width

Ширина выходной графики.

Integer

height

Высота выходной графики.

Integer

Экспортируйте диаграмму, содержащую источник данных слоя проекта в файл .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)

updateChart()

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