|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetLineEndStyle () |
| Get line ending style of the end point. More... | |
| def | GetLineStartStyle () |
| Get line ending style of the start point. 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 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 for displaying the units for measuring. More... | |
| def | GetStyleFillColor () |
| Get fill color for some line ending styles. More... | |
| def | GetVertexes () |
| Get vertexes. More... | |
| def | SetLineEndStyle (ending_style) |
| Set line ending style of the end point. More... | |
| def | SetLineStartStyle (starting_style) |
| Set line ending style of the start point. 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 | SetStyleFillColor (fill_color) |
| Set fill color for some line ending styles. More... | |
| def | SetVertexes (vertexes) |
| Set vertexes. More... | |
A polyline annotation (PDF 1.5) is similar to a polygon, except that the first and last vertex are not implicitly connected.
Polyline annotation is a kind of markup annotation, so class PolyLine is derived from class Markup , and also offers functions to get/set polyline annotation's properties and reset appearance stream of a polyline annotation.
For a polyline annotation, vertexes property is required. So please ensure that a polyline annotation has valid vertexes property before resetting its appearance stream; otherwise the polyline annotation cannot be reset appearance stream.
| def fsdk.PolyLine.GetLineEndStyle | ( | ) |
Get line ending style of the end point.
This property has effect on polyline annotation's appearance.
| def fsdk.PolyLine.GetLineStartStyle | ( | ) |
Get line ending style of the start point.
This property has effect on polyline annotation's appearance.
| def fsdk.PolyLine.GetMeasureConversionFactor | ( | measure_type | ) |
Get the conversion factor for measuring.
A polyline 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.PolyLine.GetMeasureRatio | ( | ) |
Get the scale ratio string for measuring.
A polyline 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.PolyLine.GetMeasureRatioW | ( | ) |
Get the scale ratio string for measuring.
A polyline 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.PolyLine.GetMeasureUnit | ( | measure_type | ) |
Get the label for displaying the units for measuring.
A polyline 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.PolyLine.GetMeasureUnitW | ( | measure_type | ) |
Get the label for displaying the units for measuring.
A polyline 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.PolyLine.GetStyleFillColor | ( | ) |
Get fill color for some line ending styles.
This property has effect on polyline annotation's appearance when the line ending style is one of following styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
| def fsdk.PolyLine.GetVertexes | ( | ) |
Get vertexes.
Vertexes property is required for a polyline annotation and this property has effect on polyline annotation's appearance.
| def fsdk.PolyLine.SetLineEndStyle | ( | ending_style | ) |
Set line ending style of the end point.
This property has effect on polyline annotation's appearance. If user wants the new line ending style of end point has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting the new line ending style of end point.
| [in] | ending_style | The line ending style for the end point to be set. Please refer to values starting from fsdk.MarkupE_EndingStyleNone and this should be one of these values. |
| def fsdk.PolyLine.SetLineStartStyle | ( | starting_style | ) |
Set line ending style of the start point.
This property has effect on polyline annotation's appearance. If user wants the new line ending style of start point has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting the new line ending style of start point.
| [in] | starting_style | The line ending style for the start point to be set.Please refer to values starting from fsdk.MarkupE_EndingStyleNone and this should be one of these values. |
| def fsdk.PolyLine.SetMeasureConversionFactor | ( | measure_type, | |
| factor | |||
| ) |
Set the conversion factor for measuring.
A polyline 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] | factor | The conversion factor. |
| def fsdk.PolyLine.SetMeasureRatio | ( | ratio | ) |
Set the scale ratio string for measuring.
A polyline 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.PolyLine.SetMeasureUnit | ( | measure_type, | |
| unit | |||
| ) |
Set the label for displaying the units for measuring.
A polyline 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] | unit | A UTF-8 text string that specifies a label for displaying the units. |
| def fsdk.PolyLine.SetStyleFillColor | ( | fill_color | ) |
Set fill color for some line ending styles.
This property has effect on polyline annotation's appearance when the line ending style of start point or end point is one of following styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
| [in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
| def fsdk.PolyLine.SetVertexes | ( | vertexes | ) |
Set vertexes.
Vertexes property is required for a polyline annotation and this property has effect on polyline 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 of vertexes. It should contains at least 2 points as vertexes. |