Foxit PDF SDK
fsdk.Polygon类 参考

Public 成员函数

def GetFillColor ()
 获取填充颜色。 更多...
 
def GetMeasureConversionFactor (measure_type)
 获取用于测量的转换因子。 更多...
 
def GetMeasureRatio ()
 获取用于测量的比例比率字符串。 更多...
 
def GetMeasureRatioW ()
 获取用于测量的比例比率Unicode字符串。 更多...
 
def GetMeasureUnit (measure_type)
 获取用于测量的单位显示标签。 更多...
 
def GetMeasureUnitW (measure_type)
 获取用于测量的单位显示标签(Unicode字符串格式)。 更多...
 
def GetVertexes ()
 获取顶点。 更多...
 
def SetFillColor (fill_color)
 设置填充颜色。 更多...
 
def SetMeasureConversionFactor (measure_type, factor)
 设置用于测量的转换因子。 更多...
 
def SetMeasureRatio (ratio)
 设置用于测量的比例比率字符串。 更多...
 
def SetMeasureUnit (measure_type, unit)
 设置用于测量的单位显示标签。 更多...
 
def SetVertexes (vertexes)
 设置顶点。 更多...
 

详细描述

多边形注释在页面上显示一个封闭的多边形。
多边形注释是一种标记注释,所以类Polygon 派生自 类Markup ,并且还提供获取/设置多边形注释属性和 重置多边形注释外观流的函数。
对于多边形注释,顶点属性是必需的。因此,请确保多边形注释 在重置其外观流之前具有有效的顶点属性;否则多边形注释无法 重置外观流。

注解
对于新创建的多边形注释, 如果用户在设置必需的顶点属性后直接调用函数fsdk.Annot.ResetAppearanceStream 而不设置任何其他属性,将使用默认外观:
边框宽度 = 2.0,边框样式 = fsdk.BorderInfoE_Solid , 边框颜色 = 0xFFFF0000(红色),不透明度 = 1.0。
参见
Markup

成员函数说明

◆ GetFillColor()

def fsdk.Polygon.GetFillColor ( )

获取填充颜色。

此属性对多边形注释的外观有影响。

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

◆ GetMeasureConversionFactor()

def fsdk.Polygon.GetMeasureConversionFactor (   measure_type)

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

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

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

◆ GetMeasureRatio()

def fsdk.Polygon.GetMeasureRatio ( )

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

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

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

◆ GetMeasureRatioW()

def fsdk.Polygon.GetMeasureRatioW ( )

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

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

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

◆ GetMeasureUnit()

def fsdk.Polygon.GetMeasureUnit (   measure_type)

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

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

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

◆ GetMeasureUnitW()

def fsdk.Polygon.GetMeasureUnitW (   measure_type)

获取用于测量的单位显示标签(Unicode字符串格式)。

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

参数
[in]measure_type测量类型。请参考从fsdk.MarkupE_MeasureTypeX 开始的值, 这应该是这些值中的一个。
返回
表示显示单位标签的Unicode字符串。

◆ GetVertexes()

def fsdk.Polygon.GetVertexes ( )

获取顶点。

顶点属性对于多边形注释是必需的,此属性对多边形 注释的外观有影响。

返回
表示顶点的点数组。

◆ SetFillColor()

def fsdk.Polygon.SetFillColor (   fill_color)

设置填充颜色。

此属性对多边形注释的外观有影响。如果用户希望新填充颜色对 注释的外观产生影响,请在设置新填充颜色后调用函数fsdk.Annot.ResetAppearanceStream

参数
[in]fill_color要设置的新填充颜色。格式:0xRRGGBB。
返回
无。

◆ SetMeasureConversionFactor()

def fsdk.Polygon.SetMeasureConversionFactor (   measure_type,
  factor 
)

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

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

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

◆ SetMeasureRatio()

def fsdk.Polygon.SetMeasureRatio (   ratio)

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

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

参数
[in]ratio表达比例比率的UTF-8字节字符串。字符串应该像:"1/4 in = 1 ft", 表示默认用户空间中的1/4英寸等同于真实世界测量中的1英尺。
返回
无。

◆ SetMeasureUnit()

def fsdk.Polygon.SetMeasureUnit (   measure_type,
  unit 
)

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

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

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

◆ SetVertexes()

def fsdk.Polygon.SetVertexes (   vertexes)

设置顶点。

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

参数
[in]vertexes用于顶点的有效点数组。它应该包含至少2个点作为顶点。
返回
无。