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 (可读写)	创建线参考线时参考线的起始位置，或创建范围参考线时范围的起始位置。 对数字轴，预期接收一个双精度值；对时间轴，预期接收一个 datetime 对象。	Object
valueTo (可读写)	创建范围参考线时范围的结束位置。 对数字轴，预期接收一个双精度值；对时间轴，预期接收一个 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")