Foxit PDF SDK
|
Public Member Functions | |
constructor (line_width, line_join, miter_limit, line_cap, dash_phase, dashes) const ructor() Set(line_width | |
Constructor, with parameters. More... | |
Public Attributes | |
dash_phase | |
Dash phase for dash pattern. | |
dashes | |
A dash array that represents the dash patterns. Value of each element in this array should not be negative. | |
line_cap | |
Line cap style. More... | |
line_join | |
Line join style. More... | |
line_width | |
Line width. More... | |
miter_limit | |
The miter limit for line join. More... | |
Static Public Attributes | |
static | e_LineCapButt |
Enumeration for line cap style. More... | |
static | e_LineCapRound |
Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in. | |
static | e_LineCapSquare |
Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is squared off. | |
static | e_LineJoinBevel |
Bevel line join type. More... | |
static | e_LineJoinMiter |
Enumeration for line join style. More... | |
static | e_LineJoinRound |
Round line join type. More... | |
This class represents PDF graph states.
FSDK.GraphState.constructor | ( | line_width, | |
line_join, | |||
miter_limit, | |||
line_cap, | |||
dash_phase, | |||
dashes | |||
) | const |
Constructor, with parameters.
[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.GraphState.e_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.GraphState.e_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. |
Constructor.
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.GraphState.e_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.GraphState.e_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. |
|
static |
Enumeration for line cap style.
Values of this enumeration should be used alone. 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.
Butt cap. The stroke is squared off at the endpoint of a path. There is no projection beyond the end of a path.
|
static |
Bevel line join type.
The two segments are finished with butt caps and the resulting notch beyond the end of the segments is filled with a triangle.
|
static |
Enumeration for line join style.
Values of this enumeration should be used alone. The line join style specifies the shape to be used at the corners of paths that are stroked.
Miter line join type.
The outer edges of the strokes for the two segments are extended until they meet at an angle.
|
static |
Round line join type.
An arc of a circle with a diameter equal to the line width is drawn around the point where the two segments meet, connecting the outer edges of the strokes for the two segments.
FSDK.GraphState.line_cap |
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.GraphState.e_LineCapButt and this should be one of these values.
FSDK.GraphState.line_join |
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.GraphState.e_LineJoinMiter and this should be one of these values.
FSDK.GraphState.line_width |
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.miter_limit |
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.