|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetDash_phase () |
| Get dash phase for dash pattern. More... | |
| def | GetDashes () |
| Get a dash array that represents the dash patterns. More... | |
| def | GetLine_cap () |
| Get line cap style. More... | |
| def | GetLine_join () |
| Get line join style. More... | |
| def | GetLine_width () |
| Get line width. More... | |
| def | GetMiter_limit () |
| Get the miter limit for line join. More... | |
| def | Set (line_width, line_join, miter_limit, line_cap, dash_phase, dashes) |
| Set value. More... | |
| def | SetDash_phase (value) |
| Set dash phase for dash pattern. More... | |
| def | SetDashes (value) |
| Set a dash array that represents the dash patterns. More... | |
| def | SetLine_cap (value) |
| Set line cap style. More... | |
| def | SetLine_join (value) |
| Set line join style. More... | |
| def | SetLine_width (value) |
| Set line width. More... | |
| def | SetMiter_limit (value) |
| Set the miter limit for line join. More... | |
This class represents PDF graph states.
| fsdk.GraphState.GetDash_phase | ( | ) |
Get dash phase for dash pattern.
| fsdk.GraphState.GetDashes | ( | ) |
Get a dash array that represents the dash patterns.
| fsdk.GraphState.GetLine_cap | ( | ) |
Get line cap style.
The line cap style specifies the shape to be used at the ends of open sub-paths (and dashes, if any) when they are stroked. Please refer to values starting from fsdk.GraphStateE_LineCapButt and this should be one of these values.
| fsdk.GraphState.GetLine_join | ( | ) |
Get line join style.
The line join style specifies the shape to be used at the corners of paths that are stroked. Please refer to values starting from fsdk.GraphStateE_LineJoinMiter and this should be one of these values.
| fsdk.GraphState.GetLine_width | ( | ) |
Get line width.
It should be a non-negative number in [PDF coordinate system] (). If 0 is set to this, it will be treated as 1 by default.
| fsdk.GraphState.GetMiter_limit | ( | ) |
Get the miter limit for line join.
When two line segments meet at a sharp angle and mitered joins have been specified as the line join style, it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miter limit imposes a maximum on the ratio of the miter length to the line width. When the limit is exceeded, the join is converted from a miter to a bevel.
Please refer to <PDF Reference 1.7> P217 "Miter Limit" for more details.
| def fsdk.GraphState.Set | ( | line_width, | |
| line_join, | |||
| miter_limit, | |||
| line_cap, | |||
| dash_phase, | |||
| dashes | |||
| ) |
Set value.
| [in] | line_width | Line width. If 0 is set to this, it will be treated as 1 by default. |
| [in] | line_join | Line join style. Please refer to values starting from fsdk.GraphStateE_LineJoinMiter and this should be one of these values. |
| [in] | miter_limit | The miter limit for line join. |
| [in] | line_cap | Line cap style. Please refer to values starting from fsdk.GraphStateE_LineCapButt and this should be one of these values. |
| [in] | dash_phase | Dash phase for line dash pattern. |
| [in] | dashes | A dash array that represents the dash patterns. The value of each element in this array should not be negative. |
| fsdk.GraphState.SetDash_phase | ( | value | ) |
Set dash phase for dash pattern.
| [in] | value | Dash phase for dash pattern. |
| fsdk.GraphState.SetDashes | ( | value | ) |
Set a dash array that represents the dash patterns.
| [in] | value | A dash array that represents the dash patterns. Value of each element in this array should not be negative. |
| fsdk.GraphState.SetLine_cap | ( | value | ) |
Set line cap style.
The line cap style specifies the shape to be used at the ends of open sub-paths (and dashes, if any) when they are stroked. Please refer to values starting from fsdk.GraphStateE_LineCapButt and this should be one of these values.
| [in] | value | Line cap style. |
| fsdk.GraphState.SetLine_join | ( | value | ) |
Set line join style.
The line join style specifies the shape to be used at the corners of paths that are stroked. Please refer to values starting from fsdk.GraphStateE_LineJoinMiter and this should be one of these values.
| [in] | value | Line join style. |
| fsdk.GraphState.SetLine_width | ( | value | ) |
Set line width.
It should be a non-negative number in [PDF coordinate system] (). If 0 is set to this, it will be treated as 1 by default.
| [in] | value | Line width. |
| fsdk.GraphState.SetMiter_limit | ( | value | ) |
Set the miter limit for line join.
When two line segments meet at a sharp angle and mitered joins have been specified as the line join style, it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miter limit imposes a maximum on the ratio of the miter length to the line width. When the limit is exceeded, the join is converted from a miter to a bevel.
Please refer to <PDF Reference 1.7> P217 "Miter Limit" for more details.
| [in] | value | The miter limit for line join. |