Box

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

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

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

Обсуждение

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

Синтаксис

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

Параметр	Описание	Тип данных
y	The fields to display as boxes. Specify a single field name or a list of field names.	String
x	The x-axis field is used to create multiple series box plots by setting the category. See the documentation on box plots for more information.	String
splitCategory	A second categorical field that adds a separate series or box for each unique value in the field.	String
splitCategoryAsMeanLine	Multiple-series box plots created with a split field can be displayed as mean lines or as side-by-side boxes. True displays split multiple series as mean lines. False displays multiple series as side-by-side boxes. (Значение по умолчанию — False)	Boolean
standardizeValues	Box plots created from multiple fields are standardized by default. True displays standardized values. False displays nonstandardized values. (Значение по умолчанию — True)	Boolean
showOutliers	Indicates whether outliers are shown as points extending beyond the whiskers. True displays outliers as points. False includes outliers in whiskers. (Значение по умолчанию — False)	Boolean
rotated	Indicates whether boxes are viewed vertically or horizontally. Boxes are displayed vertically by default. True rotates boxes horizontally. False displays boxes vertically. (Значение по умолчанию — False)	Boolean
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

Свойства

Свойство	Описание	Тип данных
dataSource (чтение и запись)	Устанавливает источник данных диаграммы. Когда диаграмма экспортируется с использованием метода exportToSVG или отображается в ArcGIS Notebook, источник данных считывается и отображается на диаграмме. К допустимым источникам данных относятся пути к наборам данных, включая локальные наборы данных, пути UNC, URL-адреса служб и объекты arcpy.mp Layer.	Object
description (чтение и запись)	Задает описание диаграммы. Текст диаграммы отображается внизу вида диаграммы.	String
displaySize (чтение и запись)	Задает размер диаграммы при экспорте с помощью метода exportToSVG или при отображении в ArcGIS Notebook. Значение должно быть указано как список из двух элементов где первый элемент является шириной диаграммы, а второй - высотой.	List
legend (чтение и запись)	Задает свойства легенды диаграммы. visible – показывает, отображается ли легенда в виде диаграммы. True – отображает легенду. False - скрывает легенду. title – заголовок, отображаемый для легенды.	Object
rotated (чтение и запись)	Указывает, отображаются ли столбцы вертикально или горизонтально. По умолчанию диаграмма отображается вертикально. True поворачивает диаграмму горизонтально. False отображает диаграмму вертикально.	Boolean
showOutliers (чтение и запись)	Указывает, будут ли отображаться выбросы как точки, которые выходят за линии усов. True отображает выбросы как точки. False включает выбросы в усы.	Boolean
splitCategory (чтение и запись)	Поле второй категории, которое добавляет отдельные серии или ящичек для каждого уникального значения в поле.	String
splitCategoryAsMeanLine (чтение и запись)	Ящичковые диаграммы с несколькими сериями, которые создаются с использованием поля разбиения, могут отображаться как средние линии или как ящички, располагающиеся бок о бок. True отображает разделенные несколько серий в виде средних линий. False отображает разделенные несколько серий как ящички, располагающиеся бок о бок.	Boolean
standardizeValues (чтение и запись)	Ящичковые диаграммы, которые создаются из нескольких полей, по умолчанию стандартизируются. True отображает стандартизированные значения. False отображает нестандартизированные значения.	Boolean
title (чтение и запись)	Задает заголовок диаграммы. Текст заголовка появляется в верхней части вида диаграммы и используется как надпись на панели Содержание на вкладке Содержание на вкладке По отображению.	String
type (только чтение)	Строковое значение, обозначающее тип диаграммы.	String
x (чтение и запись)	Имя поля, используемого для создания множества серий ящичковых диаграмм с помощью задания категории. См. документацию по ящичковым диаграммам для получения дополнительной информации.	String
xAxis (чтение и запись)	Задает свойства оси x. field - имя поля, используемого для создания множества серий ящичковых диаграмм с помощью задания категории. logarithmic - это свойство не поддерживается для класса Box. maximum – максимальная граница оси. minimum – минимальная граница оси. sort – метод сортировки, примененный к этой оси. ASC используется для сортировки по возрастанию, а DESC - для сортировки по убыванию. title – подпись оси, отображаемая в диаграмме.	Object
y (чтение и запись)	Поле или поля для отображения как ящичков. Необходимо задать одно имя поля или список имен полей.	String
yAxis (чтение и запись)	Задает свойства оси y. field - поле или поля для отображения как ящичков. Необходимо задать одно имя поля или список имен полей. logarithmic - это свойство не поддерживается для класса Box. maximum – максимальная граница оси. minimum – минимальная граница оси. sort – метод сортировки, примененный к этой оси. MEAN_ASC и MEAN_DESC используются для сортировки ящичков по средним значениям. MEDIAN_ASC и MEDIAN_DESC используются для сортировки ящичков по медианным значениям. 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()

Пример кода

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