fsdk.PolyLine类 参考

Public 成员函数
def	GetLineEndStyle ()
	获取终点的线端样式。 更多...
def	GetLineStartStyle ()
	获取起始点的线端样式。 更多...
def	GetMeasureConversionFactor (measure_type)
	获取用于测量的转换因子。 更多...
def	GetMeasureRatio ()
	获取用于测量的比例比率字符串。 更多...
def	GetMeasureRatioW ()
	获取用于测量的比例比率字符串。 更多...
def	GetMeasureUnit (measure_type)
	获取用于显示测量单位的标签。 更多...
def	GetMeasureUnitW (measure_type)
	获取用于显示测量单位的标签。 更多...
def	GetStyleFillColor ()
	获取某些线端样式的填充颜色。 更多...
def	GetVertexes ()
	获取顶点。 更多...
def	SetLineEndStyle (ending_style)
	设置终点的线端样式。 更多...
def	SetLineStartStyle (starting_style)
	设置起始点的线端样式。 更多...
def	SetMeasureConversionFactor (measure_type, factor)
	设置用于测量的转换因子。 更多...
def	SetMeasureRatio (ratio)
	设置用于测量的比例比率字符串。 更多...
def	SetMeasureUnit (measure_type, unit)
	设置用于测量的单位显示标签。 更多...
def	SetStyleFillColor (fill_color)
	设置某些线端样式的填充颜色。 更多...
def	SetVertexes (vertexes)
	设置顶点。 更多...

详细描述

折线注释（PDF 1.5）类似于多边形，只是第一个和最后一个顶点没有 隐式连接。
折线注释是一种标记注释，所以类PolyLine 派生自 类Markup ，并且还提供获取/设置折线注释属性和 重置折线注释外观流的函数。
对于折线注释，顶点属性是必需的。因此，请确保折线注释 在重置其外观流之前具有有效的顶点属性；否则折线注释无法 重置外观流。

注解

对于新创建的折线注释， 如果用户在设置必需的顶点属性后直接调用函数fsdk.Annot.ResetAppearanceStream 而不设置任何其他属性，将使用默认外观：
边框宽度 = 2.0，边框样式 = fsdk.BorderInfoE_Solid ， 边框颜色 = 0xFFFF0000（红色），不透明度 = 1.0。

参见

Markup

成员函数说明

GetLineEndStyle()

def fsdk.PolyLine.GetLineEndStyle

(

)

获取终点的线端样式。

此属性对折线注释的外观有影响。

返回

终点的线端样式。请参考从fsdk.MarkupE_EndingStyleNone 开始的值， 这将是这些值中的一个。

GetLineStartStyle()

def fsdk.PolyLine.GetLineStartStyle

(

)

获取起始点的线端样式。

此属性对折线注释的外观有影响。

返回

起始点的线端样式。请参考从fsdk.MarkupE_EndingStyleNone 开始的值， 这将是这些值中的一个。

GetMeasureConversionFactor()

def fsdk.PolyLine.GetMeasureConversionFactor

(

measure_type

)

获取用于测量的转换因子。

折线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]

measure_type

测量类型。请参考从fsdk.MarkupE_MeasureTypeX 开始的值， 这应该是这些值中的一个。

返回

转换因子。

GetMeasureRatio()

def fsdk.PolyLine.GetMeasureRatio

(

)

获取用于测量的比例比率字符串。

折线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 比例比率字符串表达该区域中绘图的比例比率。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

返回

表达比例比率的UTF-8字节字符串。

GetMeasureRatioW()

def fsdk.PolyLine.GetMeasureRatioW

(

)

获取用于测量的比例比率字符串。

折线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 比例比率字符串表达该区域中绘图的比例比率。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

返回

表达比例比率的Unicode字符串。

GetMeasureUnit()

def fsdk.PolyLine.GetMeasureUnit

(

measure_type

)

获取用于显示测量单位的标签。

折线注释可能具有测量字典，该字典为页面的某个区域指定替代坐标系。 有关更多详细信息，请参阅《PDF Reference 1.7》第745页。

参数

[in]

measure_type

测量类型。请参考从 fsdk.MarkupE_MeasureTypeX 开始的值，应为这些值之一。

返回

表示显示单位标签的 UTF-8 文本字符串。

GetMeasureUnitW()

def fsdk.PolyLine.GetMeasureUnitW

(

measure_type

)

获取用于显示测量单位的标签。

折线注释可能具有测量字典，该字典为页面的某个区域指定替代坐标系。 有关更多详细信息，请参阅《PDF Reference 1.7》第745页。

参数

[in]

measure_type

测量类型。请参考从 fsdk.MarkupE_MeasureTypeX 开始的值，应为这些值之一。

返回

表示显示单位标签的 Unicode 字符串。

GetStyleFillColor()

def fsdk.PolyLine.GetStyleFillColor

(

)

获取某些线端样式的填充颜色。

当线端样式是以下样式之一时，此属性对折线注释的外观有影响：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。

返回

填充颜色。格式：0xRRGGBB。 如果找不到填充颜色，将返回0x000000。

GetVertexes()

def fsdk.PolyLine.GetVertexes

(

)

获取顶点。

顶点属性对于折线注释是必需的，此属性对折线 注释的外观有影响。

返回

表示顶点的点数组。

SetLineEndStyle()

def fsdk.PolyLine.SetLineEndStyle

(

ending_style

)

设置终点的线端样式。

此属性对折线注释的外观有影响。 如果用户希望终点的新线端样式对注释的外观产生影响， 请在设置终点的新线端样式后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

ending_style

要设置的终点的线端样式。请参考从 fsdk.MarkupE_EndingStyleNone 开始的值，这应该是这些值中的一个。

返回

无。

SetLineStartStyle()

def fsdk.PolyLine.SetLineStartStyle

(

starting_style

)

设置起始点的线端样式。

此属性对折线注释的外观有影响。 如果用户希望起始点的新线端样式对注释的外观产生影响， 请在设置起始点的新线端样式后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

starting_style

要设置的起始点的线端样式。请参考从 fsdk.MarkupE_EndingStyleNone 开始的值，这应该是这些值中的一个。

返回

无。

SetMeasureConversionFactor()

def fsdk.PolyLine.SetMeasureConversionFactor	(		measure_type,
			factor
	)

设置用于测量的转换因子。

折线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]	measure_type	测量类型。请参考从fsdk.MarkupE_MeasureTypeX 开始的值， 这应该是这些值中的一个。
[in]	factor	转换因子。

返回

无。

SetMeasureRatio()

def fsdk.PolyLine.SetMeasureRatio

(

ratio

)

设置用于测量的比例比率字符串。

折线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 比例比率字符串表达该区域中绘图的比例比率。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]

ratio

表达比例比率的UTF-8字节字符串。字符串应该像："1/4 in = 1 ft"， 表示默认用户空间中的1/4英寸等同于真实世界测量中的1英尺。

返回

无。

SetMeasureUnit()

def fsdk.PolyLine.SetMeasureUnit	(		measure_type,
			unit
	)

设置用于测量的单位显示标签。

折线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]	measure_type	测量类型。请参考从fsdk.MarkupE_MeasureTypeX 开始的值， 这应该是这些值中的一个。
[in]	unit	指定显示单位标签的UTF-8文本字符串。

返回

无。

SetStyleFillColor()

def fsdk.PolyLine.SetStyleFillColor

(

fill_color

)

设置某些线端样式的填充颜色。

当起始点或终点的线端样式是以下样式之一时，此属性对折线注释的外观有影响：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。

参数

[in]

fill_color

要设置的新填充颜色。格式：0xRRGGBB。

返回

无。

SetVertexes()

def fsdk.PolyLine.SetVertexes

(

vertexes

)

设置顶点。

顶点属性对于折线注释是必需的，此属性对折线 注释的外观有影响。如果用户希望新顶点对注释的外观产生影响，请在 设置新顶点后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

vertexes

顶点的有效点数组。它应该包含至少2个点作为顶点。

返回

无。