Pie

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

Класс Pie создает круговые диаграммы. Круговые диаграммы группируют данные в доли для отображения отношений части к целому.

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

Обсуждение

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

Синтаксис

 Pie ({categoryField}, {numberFields}, {splitCategory}, {miniChartsPerRow}, {showPreviewChart}, {groupingPercent}, {donutSize}, {sort}, {showDataLabels}, {dataLabelsDisplay}, {title}, {description}, {dataSource}, {displaySize})
ПараметрОписаниеТип данных
categoryField

The field name of the category variable.

String
numberFields

The field names for the numeric field or fields. Provide a single field name or a list of field names.

String
splitCategory

A categorical field that adds a separate series for each unique value in the field.

String
miniChartsPerRow

The number of minicharts that will be shown per row. The number of rows will be determined by the total number of series divided by the miniChartsPerRow value.

Integer
showPreviewChart

Specifies whether the preview chart will be displayed for grid charts.

  • TrueThe preview chart will be displayed.
  • FalseThe preview chart will not be displayed.

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

Boolean
groupingPercent

The percentage threshold for grouping smaller slices into a single Other category. Provide an integer between 0 and 100 that represents the maximum percentage value for determining which slices are grouped into the Other category.

Integer
donutSize

The size of the hole when displaying a pie chart as a donut. Provide an integer between 0 and 100 that represents the size of the hole as a percentage relative to the total size of the pie.

Integer
sort

Specifies the sort order for the slices in the chart.

  • LABEL_CLOCKWISESlices will be displayed in clockwise alphabetical order, starting at the top center of chart.
  • LABEL_COUNTERCLOCKWISESlices will be displayed in counterclockwise alphabetical order, starting at the top center of chart.
  • VALUE_CLOCKWISESlices will be displayed in clockwise order by value, starting at the top center of chart.
  • VALUE_COUNTERCLOCKWISESlices will be displayed in counterclockwise order by value, starting at the top center of chart.
String
showDataLabels

Specifies whether data labels will be displayed.

  • TrueData labels will be displayed.
  • FalseData labels will not be displayed.
Boolean
dataLabelsDisplay

Specifies the format that will be used for the data labels.

  • VALUERaw number values will be displayed.
  • PERCENTAGEpercentage values will be displayed.
  • PERCENTAGE_AND_VALUEBoth raw number and percentage values will be displayed.
String
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
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

Свойства

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

Имя поля для переменной категории.

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

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

  • VALUEБудут отображены необработанные числовые значения.
  • PERCENTAGEБудут отображены процентные значения.
  • PERCENTAGE_AND_VALUEБудут отображены необработанные числовые значения и процентные значения.
String
dataSource
(чтение и запись)

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

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

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

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

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

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

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

Размер отверстия при отображении круговой диаграммы в виде кольца. Введите целое число от 0 до 100, представляющее размер отверстия в процентах по отношению к общему размеру круговой диаграммы.

Integer
groupingPercent
(чтение и запись)

Процентный порог для группировки меньших долей в одну категорию Other. Введите целое число от 0 до 100, представляющее максимальное процентное значение для определения того, какие доли будут сгруппированы в категорию Other.

Integer
legend
(чтение и запись)

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

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

Число минидиаграмм, которые будут отображаться в строке. Число строк будет определяться количеством серий, деленным на значение miniChartsPerRow.

Integer
numberFields
(чтение и запись)

Имена полей для числовых полей. Укажите одно имя поля или список имен полей.

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

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

  • TrueПодписи к данным будут отображены.
  • FalseПодписи к данным не будут отображены.
Boolean
showPreviewChart
(чтение и запись)

Показывает, будет ли отображаться предварительный просмотр диаграмм в гриде.

  • TrueПредварительный просмотр диаграммы отображается.
  • FalseПредварительный просмотр диаграммы не отображается.
Boolean
sort
(чтение и запись)

Определяет порядок сортировки долей диаграммы.

  • LABEL_CLOCKWISEДоли будут отображаться в алфавитном порядке по часовой стрелке, начиная с верхней центральной точки диаграммы.
  • LABEL_COUNTERCLOCKWISEДоли будут отображаться в алфавитном порядке против часовой стрелки, начиная с верхней центральной точки диаграммы.
  • VALUE_CLOCKWISEДоли будут отображаться в порядке значений по часовой стрелке, начиная с верхней центральной точки диаграммы.
  • VALUE_COUNTERCLOCKWISEДоли будут отображаться в порядке значений против часовой стрелки, начиная с верхней центральной точки диаграммы.
String
splitCategory
(чтение и запись)

Поле категории, которое добавляет отдельные серии для каждого уникального значения в поле.

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

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

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

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

String
type
(только чтение)

Строковое значение, обозначающее тип диаграммы.

String

Обзор метода

МетодОписание
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()

Пример кода

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

import arcpy

activemap = arcpy.mp.ArcGISProject("current").activeMap
lyr = activemap.listLayers("nyc_noise_complaints")[0]
chart = arcpy.charts.Pie(categoryField="Complaint_Type", title="Noise Complaints by Type", dataSource=lyr)
chart.exportToSVG('pie.svg', width=1000, height=800)