Guide

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

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

Обсуждение

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

Синтаксис

 Guide (guideType, {name}, {label}, {valueFrom}, {valueTo}, {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 property.
  • range—A range guide will be created. Use this value in conjunction with the valueFrom and valueTo properties.
  • polyline—A polyline guide will be created. Use this value in conjunction with the polyline property.
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. Expects 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. Expects a double value for numeric axes and a datetime object for temporal axes.

Object
polyline
[polyline,...]

A list of coordinates when creating a polyline guide. Coordinates are expected to be in row-major order.

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 dash style will be used.
  • dot—A dot dash 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
(чтение и запись)

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

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

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

Object

Пример кода

Пример направляющей

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

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")