Box

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

Класс Box создает ящичковые диаграммы. Ящичковые диаграммы позволяют визуализировать и сравнивать распределение и основную тенденцию числовых значений посредством их квартилей.

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

Обсуждение

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

Синтаксис

Box(y, {x}, {splitCategory}, {splitCategoryAsMeanLine}, {standardizeValues}, {showOutliers}, {rotated}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize}, {theme})

Имя	Объяснение	Тип данных
y	Поля для отображения в виде ящичков. Укажите одно имя поля или список имен полей.	String
x (Дополнительный)	Поле ось x используется для создания множества серий ящичковых диаграмм с помощью задания категории. См. раздел Ящичковые диаграммы для получения дополнительной информации.	String
splitCategory (Дополнительный)	Поле второй категории, которое добавляет отдельные серии или ящичек для каждого уникального значения в поле.	String
splitCategoryAsMeanLine (Дополнительный)	Определяет, будут ли ящичковые диаграммы с несколькими сериями, которые создаются с использованием поля разбиения, отображаться как средние линии или как расположенные рядом ящички. True—Display split multiple-series box plots as mean lines. False—Display multiple-series box plots as side-by-side boxes. (Значение по умолчанию — False)	Boolean
standardizeValues (Дополнительный)	Определяет, будут ли ящичковые диаграммы, созданные из нескольких полей, стандартизироваться. True—Display standardized values. False—Display nonstandardized values. (Значение по умолчанию — True)	Boolean
showOutliers (Дополнительный)	Определяет, будут ли отображаться выбросы как точки, которые выходят за линии усов. True—Display outliers as points. False—Include outliers in whiskers. (Значение по умолчанию — False)	Boolean
rotated (Дополнительный)	Определяет, как будут отображаться ящички, вертикально или горизонтально. True—The chart is rotated so that boxes will be displayed horizontally. False—Boxes will be displayed vertically. (Значение по умолчанию — False)	Boolean
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

Свойства

Имя	Объяснение	Тип данных
color (Чтение / Запись)	Цвета, которые будут применены к каждой серии диаграмм. Значение должно представлять собой список шестнадцатеричных значений строки. Если это свойство не задано, цвета серии будут соответствовать цветам условных обозначений, где это применимо; в противном случае будет применена стандартная цветовая палитра.	List
dataSource (Чтение / Запись)	Источник данных диаграммы. Когда диаграмма экспортируется с использованием метода exportToSVG или отображается в ArcGIS Notebook, источник данных считывается и отображается на диаграмме. К допустимым источникам данных относятся следующие: Пути к наборам данных, включая локальные наборы данных, пути UNC, URL-адреса сервисов Объекты таблицы Apache Arrow Объекты Layer или Table	Object
description (Чтение / Запись)	Описание диаграммы. Текст диаграммы отображается внизу вида диаграммы.	String
displaySize (Чтение / Запись)	Размер диаграммы при экспорте с помощью метода exportToSVG или при отображении в ArcGIS Notebook. Значение должно быть указано как список из двух элементов, в котором первый элемент является шириной диаграммы, а второй - высотой.	List
legend (Чтение / Запись)	Свойства легенды диаграммы. alignment—Определяет выравнивание легенды Опции выравнивания: left, bottom, top и right. title - заголовок легенды. visible - задает, будет ли легенда отображаться в виде диаграммы. True отображает легенду, False скрывает легенду.	Object
rotated (Чтение / Запись)	Указывает, отображается ли диаграмма вертикально или горизонтально. True—Диаграмма отображается горизонтально. False—Диаграмма отображается вертикально.	Boolean
showOutliers (Чтение / Запись)	Определяет, будут ли отображаться выбросы как точки, которые выходят за линии усов. True—Выбросы будут показаны в виде точек. False—Выбросы будут включены в усы.	Boolean
splitCategory (Чтение / Запись)	Поле второй категории, которое добавит отдельные серии или ящичек для каждого уникального значения в поле.	String
splitCategoryAsMeanLine (Чтение / Запись)	Определяет, будут ли ящичковые диаграммы с несколькими сериями, которые создаются с использованием поля разбиения, отображаться как средние линии или как расположенные рядом ящички. True—Ящичковые диаграммы с несколькими сериями будут отображаться в виде средних линий. False—Ящичковые диаграммы будут отображаться в виде расположенных рядом друг с другом ящичков.	Boolean
standardizeValues (Чтение / Запись)	Определяет, будут ли ящичковые диаграммы, созданные из нескольких полей, стандартизироваться. True—Будут отображены стандартизированные значения. False—Будут отображены нестандартизированные значения.	Boolean
theme (Чтение / Запись)	Задает тему, которая будет применена к диаграмме. Light—Будет применена светлая тема. Medium—Будет применена средняя тема. Dark—Будет применена темная тема.	String
title (Чтение / Запись)	Заголовок диаграммы. Текст заголовка появляется в верхней части вида диаграммы и используется как надпись на панели Содержание на вкладке Содержание на вкладке По отображению.	String
type (Только для чтения)	Строковое значение, обозначающее тип диаграммы.	String
x (Чтение / Запись)	Поле, которое будет использоваться для создания ящичковых диаграмм с несколькими сериями, путем задания категории. См. раздел Ящичковые диаграммы для получения дополнительной информации.	String
xAxis (Чтение / Запись)	Задает свойства оси x. field — имя поля, которое будет использоваться для создания ящичковых диаграмм с несколькими сериями, путем задания категории. logarithmic - это свойство не поддерживается для класса Box. maximum – максимальная граница оси. minimum – минимальная граница оси. sort — порядок сортировки, который будет применен к этой оси. ASC соответствует сортировке по возрастанию, в DESC — сортировке по убыванию. title – подпись оси, отображаемая в диаграмме.	Object
y (Чтение / Запись)	Поле или поля, которые будут отображаться в виде ящичков. Укажите одно имя поля или список имен полей.	String
yAxis (Чтение / Запись)	Определяет свойства оси y. addGuide - Добавляет направляющую к оси при помощи объекта Guide. field — поле или поля, которые будут отображаться в виде ящичков. Вам необходимо задать одно имя поля или список имен полей. logarithmic - это свойство не поддерживается для класса Box. listGuides — список объектов оси Guide. maximum – максимальная граница оси. minimum – минимальная граница оси. removeGuide — удаляет направляющую, указанную аргументом объекта Guide. sort — порядок сортировки, примененный к этой оси. MEAN_ASC и MEAN_DESC используются для сортировки ящичков по средним значениям в порядке возрастания или убывания, соответственно. MEDIAN_ASC и MEDIAN_DESC используются для сортировки ящичков по медианным значениям в порядке возрастания или убывания, соответственно. 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()

Пример кода

Создайте ящичковую диаграмму, используя файл .csv, и экспортируйте ее в файл .svg.

import arcpy

chart = arcpy.charts.Box(y=["pct_diabetes", "pct_asthma", "pct_heart"],
                         splitCategory="State",
                         dataSource="chronic_health_conditions.csv")
chart.title = "Distribution of Chronic Health Conditions by State"
chart.exportToSVG("box.svg", width=700, height=600)