Foxit PDF SDK
fsdk.Polygon Class Reference

Public Member Functions

def GetFillColor ()
 Get fill color.
More...
 
def GetMeasureConversionFactor (measure_type)
 Get the conversion factor for measuring.
More...
 
def GetMeasureRatio ()
 Get the scale ratio string for measuring.
More...
 
def GetMeasureRatioW ()
 Get the scale ratio Unicode string for measuring.
More...
 
def GetMeasureUnit (measure_type)
 Get the label for displaying the units for measuring.
More...
 
def GetMeasureUnitW (measure_type)
 Get the label (in Unicode string) for displaying the units for measuring.
More...
 
def GetVertexes ()
 Get vertexes.
More...
 
def SetFillColor (fill_color)
 Set fill color.
More...
 
def SetMeasureConversionFactor (measure_type, factor)
 Set the conversion factor for measuring.
More...
 
def SetMeasureRatio (ratio)
 Set the scale ratio string for measuring.
More...
 
def SetMeasureUnit (measure_type, unit)
 Set the label for displaying the units for measuring.
More...
 
def SetVertexes (vertexes)
 Set vertexes.
More...
 

Detailed Description

A polygon annotation displays a closed polygon on the page.
Polygon annotation is a kind of markup annotation, so class Polygon is derived from class Markup , and also offers functions to get/set polygon annotation's properties and reset appearance stream of a polygon annotation.
For a polygon annotation, vertexes property is required. So please ensure that a polygon annotation has valid vertexes property before resetting its appearance stream; otherwise the polygon annotation cannot be reset appearance stream.

Note
For a newly created polygon annotation, if user calls function fsdk.Annot.ResetAppearanceStream directly after setting required vertexes property and not setting any other properties, the default appearance will be used:
border width = 2.0, border style = fsdk.BorderInfoE_Solid , border color = 0xFFFF0000 (red), opacity = 1.0.
See also
Markup

Member Function Documentation

◆ GetFillColor()

def fsdk.Polygon.GetFillColor ( )

Get fill color.

This property has effect on polygon annotation's appearance.

Returns
The fill color. Format: 0xRRGGBB. If no fill color can be found, 0x000000 will be returned.

◆ GetMeasureConversionFactor()

def fsdk.Polygon.GetMeasureConversionFactor (   measure_type)

Get the conversion factor for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.

Parameters
[in]measure_typeMeasure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this would be one of these values.
Returns
The conversion factor.

◆ GetMeasureRatio()

def fsdk.Polygon.GetMeasureRatio ( )

Get the scale ratio string for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.

Returns
A UTF-8 byte string that expresses the scale ratio.

◆ GetMeasureRatioW()

def fsdk.Polygon.GetMeasureRatioW ( )

Get the scale ratio Unicode string for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.

Returns
A Unicode string that expresses the scale ratio.

◆ GetMeasureUnit()

def fsdk.Polygon.GetMeasureUnit (   measure_type)

Get the label for displaying the units for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.

Parameters
[in]measure_typeMeasure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this should be one of these values.
Returns
A UTF-8 text string that represents a label for displaying the units.

◆ GetMeasureUnitW()

def fsdk.Polygon.GetMeasureUnitW (   measure_type)

Get the label (in Unicode string) for displaying the units for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.

Parameters
[in]measure_typeMeasure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this should be one of these values.
Returns
A Unicode string that represents a label for displaying the units.

◆ GetVertexes()

def fsdk.Polygon.GetVertexes ( )

Get vertexes.

Vertexes property is required for a polygon annotation and this property has effect on polygon annotation's appearance.

Returns
A point array that represents the vertexes.

◆ SetFillColor()

def fsdk.Polygon.SetFillColor (   fill_color)

Set fill color.

This property has effect on polygon annotation's appearance. If user wants the new fill color has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting the new fill color.

Parameters
[in]fill_colorNew fill color to be set. Format: 0xRRGGBB.
Returns
None.

◆ SetMeasureConversionFactor()

def fsdk.Polygon.SetMeasureConversionFactor (   measure_type,
  factor 
)

Set the conversion factor for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.

Parameters
[in]measure_typeMeasure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this would be one of these values.
[in]factorThe conversion factor.
Returns
None.

◆ SetMeasureRatio()

def fsdk.Polygon.SetMeasureRatio (   ratio)

Set the scale ratio string for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.

Parameters
[in]ratioA UTF-8 byte string expressing the scale ratio. The string should be like: "1/4 in = 1 ft", indicating that 1/4 inches in default user space is equivalent to 1 foot in real-world measurements.
Returns
None.

◆ SetMeasureUnit()

def fsdk.Polygon.SetMeasureUnit (   measure_type,
  unit 
)

Set the label for displaying the units for measuring.

A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.

Parameters
[in]measure_typeMeasure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this should be one of these values.
[in]unitA UTF-8 text string that specifies a label for displaying the units.
Returns
None.

◆ SetVertexes()

def fsdk.Polygon.SetVertexes (   vertexes)

Set vertexes.

Vertexes property is required for a polygon annotation and this property has effect on polygon annotation's appearance. If user wants the new vertexes have effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting the new vertexes.

Parameters
[in]vertexesA valid point array for vertexes. It should contains at least 2 points as vertexes.
Returns
None.