|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetFillColor () |
| Get fill color. More... | |
| def | GetInnerRect () |
| Get the inner rectangle. 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 for displaying the units for measuring. More... | |
| def | SetFillColor (fill_color) |
| Set fill color. More... | |
| def | SetInnerRect (inner_rect) |
| Set the inner rectangle. 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... | |
Circle annotation is an ellipse on the page. Despite the name "circle", a circle annotation can represent either a circle or a oval, which means the width and height of the annotation rectangle need not be equal.
Circle annotation is a kind of markup annotation, so class Circle is derived from class Markup , and also offers functions to get/set circle annotation's properties and reset appearance stream of a circle annotation.
| def fsdk.Circle.GetFillColor | ( | ) |
Get fill color.
| def fsdk.Circle.GetInnerRect | ( | ) |
Get the inner rectangle.
For a circle annotation, inner rectangle means the actual boundaries of underlying circle. The inner rectangle could be just the same as or less than the annotation's rectangle, and should never be larger than annotation's rectangle.
| def fsdk.Circle.GetMeasureConversionFactor | ( | measure_type | ) |
Get the conversion factor for measuring.
A circle 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.Circle.GetMeasureRatio | ( | ) |
Get the scale ratio string for measuring.
A circle 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.Circle.GetMeasureRatioW | ( | ) |
Get the scale ratio Unicode string for measuring.
A circle 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.Circle.GetMeasureUnit | ( | measure_type | ) |
Get the label for displaying the units for measuring.
A circle 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.Circle.GetMeasureUnitW | ( | measure_type | ) |
Get the label for displaying the units for measuring.
A circle 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.Circle.SetFillColor | ( | fill_color | ) |
Set fill color.
If user wants the new fill color has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new fill color.
| [in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
| def fsdk.Circle.SetInnerRect | ( | inner_rect | ) |
Set the inner rectangle.
For a circle annotation, inner rectangle means the actual boundaries of underlying circle. The inner rectangle could be just the same as or less than the annotation's rectangle, and should never be larger than annotation's rectangle.
If user wants the new inner rectangle has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new inner rectangle.
| [in] | inner_rect | New inner rectangle to be set. It should be same as or less than annotation's rectangle. |
| def fsdk.Circle.SetMeasureConversionFactor | ( | measure_type, | |
| factor | |||
| ) |
Set the conversion factor for measuring.
A circle 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.Circle.SetMeasureRatio | ( | ratio | ) |
Set the scale ratio string for measuring.
A circle 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.Circle.SetMeasureUnit | ( | measure_type, | |
| unit | |||
| ) |
Set the label for displaying the units for measuring.
A circle 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. |