Наверх

Box

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

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

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

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

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

Обсуждение

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

Синтаксис

 Box (y, {x}, {splitCategory}, {splitCategoryAsMeanLine}, {standardizeValues}, {showOutliers}, {rotated}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize})
ПараметрОписаниеТип данных
y

The fields to display as boxes. Provide 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 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

Specifies whether multiple-series box plots that are created with a split field will be displayed as mean lines or side-by-side boxes.

  • True—Display split multiple-series box plots as mean lines.
  • False—Display multiple-series box plots as side-by-side boxes.

(Значение по умолчанию — False)

Boolean
standardizeValues

Specifies whether box plots that are created from multiple fields will be standardized.

  • True—Display standardized values.
  • False—Display nonstandardized values.

(Значение по умолчанию — True)

Boolean
showOutliers

Specifies whether outliers will be shown as points extending beyond the whiskers.

  • True—Display outliers as points.
  • False—Include outliers in whiskers.

(Значение по умолчанию — False)

Boolean
rotated

Specifies whether boxes will be viewed vertically or horizontally.

  • True—The chart is rotated so that boxes will be displayed horizontally.
  • False—Boxes will be displayed vertically.

(Значение по умолчанию — False)

Boolean
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

Свойства

СвойствоОписаниеТип данных
dataSource
(чтение и запись)

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

  • Пути к наборам данных, включая локальные наборы данных, пути UNC, URL-адреса сервисов
  • Объекты таблицы 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
(чтение и запись)

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

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.
  • maximum – максимальная граница оси.
  • minimum – минимальная граница оси.
  • sort — порядок сортировки, примененный к этой оси. MEAN_ASC и MEAN_DESC используются для сортировки ящичков по средним значениям в порядке возрастания или убывания, соответственно. MEDIAN_ASC и MEDIAN_DESC используются для сортировки ящичков по медианным значениям в порядке возрастания или убывания, соответственно.
  • 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()

Пример кода

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

Отзыв по этому разделу?

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