Наверх

Guide

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

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

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

Класс Guide содержит свойства для настройки направляющих диаграмм.

Обсуждение

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

Синтаксис

 Guide (guideType, {name}, {label}, {valueFrom}, {valueTo}, {valueFromField}, {valueFromFieldAggregationType}, {polyline}, {lineColor}, {lineWidth}, {lineDashStyle}, {fillColor})
ПараметрОписаниеТип данных
guideType

Specifies the type of guide that will be created.

  • line—A line guide will be created. Use this value in conjunction with the valueFrom argument.
  • range—A range guide will be created. Use this value in conjunction with the valueFrom and valueTo arguments.
  • polyline—A polyline or point guide will be created. Use this value in conjunction with the polyline argument.
String
name

The unique name for the guide that will appear in the Chart Properties pane.

String
label

The guide label that will be displayed in the chart.

String
valueFrom

The location of the guide when creating a line guide, or the start location of the range when creating a range guide. Use a double value for numeric axes and a datetime object for temporal axes.

Object
valueTo

The end location of the range when creating a range guide. Use a double value for numeric axes and a datetime object for temporal axes.

Object
valueFromField

The field name whose values will be used to calculate the location of a data-driven guide. Use this argument in conjunction with the valueFromFieldAggregationType argument.

String
valueFromFieldAggregationType

Specifies the statistical calculation that will be used to determine the location of a data-driven guide. Use this argument in conjunction with the valueFromField argument.

  • MEAN—The mean of all values will be calculated and applied.
  • MEDIAN—The median of all values will be identified and applied.
  • MIN—The minimum value will be identified and applied.
  • MAX—The maximum value will be identified and applied.
String
polyline
[polyline,...]

A list of coordinates that will be used when creating a polyline guide. Coordinates should be in row-major order. Specifying a single coordinate pair will create a point guide.

Create a polyline guide.

# Coordinates will be: (0, 2), (10, 12), (20, 15)
coordinates = [0, 2, 10, 12, 20, 15] 
guide = arcpy.charts.Guide(guideType="polyline", polyline=coordinates)
List
lineColor

The color of a line guide in hexadecimal format.

String
lineWidth

The width of a line guide.

Double
lineDashStyle

Specifies the dash style that will be used for a line guide.

  • solid—A solid style will be used.
  • dot—A dot style will be used.
  • dash—A dash style will be used.
  • dashDot—A dash-dot style will be used.
  • longDash—A long-dash style will be used.
  • longDashDot—A long-dash-dot style will be used.
String
fillColor

The fill color of a range guide in hexadecimal format.

String

Свойства

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

Цвет заливки направляющей диапазона в шестнадцатеричном формате.

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

Определяет тип направляющей, которая будет создана.

  • line—Будет создана направляющая линии. Используйте это значение в сочетании со свойством valueFrom.
  • range—Будет создана направляющая диапазона. Используйте это значение в сочетании со свойствами valueFrom и valueTo.
  • polyline—Будет создана точечная или полилинейная направляющая. Используйте это значение в сочетании со свойством polyline.
String
label
(чтение и запись)

Надпись направляющей, которая будет отображаться на диаграмме.

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

Цвет направляющей линии в шестнадцатеричном формате.

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

Определяет стиль штриховки, который будет использоваться для направляющей линии.

  • solid—Будет использован сплошной стиль.
  • dot—Будет использоваться точечный стиль.
  • dash—Будет использован стиль штриховки.
  • dashDot—Будет использован стиль тире – точка.
  • longDash—Будет использован стиль длинное тире.
  • longDashDot—Будет использован стиль длинное тире - точка.
String
lineWidth
(чтение и запись)

Ширина направляющей линии.

Double
name
(чтение и запись)

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

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

Список координат, которые будут использоваться при создании направляющей полилинии. Координаты должны быть указаны в порядке возрастания строк. Для создания точечной направляющей требуется указать пару координат.

Создайте направляющую полилинии.


# Coordinates will be: (0, 2), (10, 12), (20, 15)
coordinates = [0, 2, 10, 12, 20, 15] 
guide = arcpy.charts.Guide(guideType="polyline", polyline=coordinates)
List
valueFrom
(чтение и запись)

Местоположение направляющей при создании направляющей линии или начальное местоположение диапазона при создании направляющей диапазона. Используйте двойное значение для числовых осей и объект datetime для временных осей.

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

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

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

Указывает статистический расчет, который будет использоваться для определения местоположения направляющей на основе данных. Используйте это свойство совместно со свойством valueFromField.

  • MEAN—Среднее значение всех значений будет рассчитано и применено.
  • MEDIAN—Медиана всех значений будет определена и применена.
  • MIN—Минимальное значение будет определено и применено.
  • MAX—Максимальное значение будет определено и применено.
String
valueTo
(чтение и запись)

Конечное местоположение диапазона при создании направляющей диапазона. Используйте двойное значение для числовых осей и объект datetime для временных осей.

Object

Пример кода

Направляющая, пример 1

Добавьте две направляющие к точечной диаграмме (рассеяния), показывающей среднее значение по каждой оси.

import arcpy

chart = arcpy.charts.Scatter(x="voter_turnout", y="per_capita_income", dataSource="VoterTurnout2020")

# Create and configure guides
guideX = arcpy.charts.Guide(guideType="line", valueFrom=65.6, label="Avg. Voter Turnout")
guideY = arcpy.charts.Guide(guideType="line", valueFrom=26823.8, label="Avg. Per Capita Income")

# Add guides to appropriate axis
chart.xAxis.addGuide(guideX)
chart.yAxis.addGuide(guideY)

chart.exportToSVG("chart_with_guides.svg")
Направляющая, пример 2

Добавьте управляемую данными направляющую в виде столбчатой диаграммы, чтобы показать среднее значение по оси y.

import arcpy

lyr = arcpy.mp.ArcGISProject("current").listMaps()[0].listLayers()[0]
chart = arcpy.charts.Bar(x="State", y="TotalPop", aggregation="MEAN")

# Create data-driven guide
guide = arcpy.charts.Guide("line", valueFromField="TotalPop", valueFromFieldAggregationType="MEAN")

# Add guide to y-axis
chart.yAxis.addGuide(guide)

chart.addToLayer(lyr)

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

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