|
Foxit PDF SDK
|
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... | |
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.
| def fsdk.Polygon.GetFillColor | ( | ) |
Get fill color.
This property has effect on polygon annotation's appearance.
| 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.
| [in] | measure_type | Measure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this would be one of these values. |
| 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.
| 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.
| 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.
| [in] | measure_type | Measure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this should be one of these values. |
| 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.
| [in] | measure_type | Measure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this should be one of these values. |
| def fsdk.Polygon.GetVertexes | ( | ) |
Get vertexes.
Vertexes property is required for a polygon annotation and this property has effect on polygon annotation's appearance.
| 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.
| [in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
| 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.
| [in] | measure_type | Measure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this would be one of these values. |
| [in] | factor | The conversion factor. |
| 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.
| [in] | ratio | A 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. |
| 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.
| [in] | measure_type | Measure type. Please refer to values starting from fsdk.MarkupE_MeasureTypeX and this should be one of these values. |
| [in] | unit | A UTF-8 text string that specifies a label for displaying the units. |
| 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.
| [in] | vertexes | A valid point array for vertexes. It should contains at least 2 points as vertexes. |