Class PDFNet.PolyLineAnnot
PDFNet.PolyLineAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
This header defines classes for the Polygon and PolyLine annotations.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.PolyLineAnnot.create(doc, pos)
Creates a new PolyLine annotation in the specified document.
|
| <static> |
PDFNet.PolyLineAnnot.createFromAnnot(ann)
creates a PolyLine annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.PolyLineAnnot.createFromObj(d)
creates a PolyLine annotation and initializes it using given Cos/SDF object.
|
|
[Documentation Not Yet Added]
|
|
|
Returns the intent name as a value of the "IntentName" enumeration type.
|
|
|
[Documentation Not Yet Added]
|
|
|
getVertex(idx)
Returns the vertex(as a Point object) corresponding to the index
within the Vertices array.
|
|
|
Returns the number of vertices in the Vertices array.
|
|
|
setEndStyle(style)
[Documentation Not Yet Added]
|
|
|
setIntentName(mode)
Sets the Intent name as a value of the "IntentName" enumeration type.
|
|
|
setStartStyle(style)
[Documentation Not Yet Added]
|
|
|
setVertex(idx, pt)
sets the vertex(in Point object form) corresponding to the index
within the Vertices array.
|
Class Detail
PDFNet.PolyLineAnnot(id)
This header defines classes for the Polygon and PolyLine annotations.
Polygon annotations (PDF 1.5) display closed polygons on the page.
Such polygons may have any number of vertices connected by straight lines.
Polyline annotations (PDF 1.5) are similar to polygons, except that the
first and last vertex are not implicitly connected.
- Parameters:
- id
Method Detail
<static>
{PolyLineAnnot}
PDFNet.PolyLineAnnot.create(doc, pos)
Creates a new PolyLine annotation in the specified document.
- Parameters:
- {SDFDoc} doc
- A document to which the PolyLine annotation is added.
- {rect} pos
- A rectangle specifying the PolyLine annotation's bounds in default user space units.
- Returns:
- {PolyLineAnnot} A promise that resolves to a newly created blank PolyLine annotation.
<static>
{PolyLineAnnot}
PDFNet.PolyLineAnnot.createFromAnnot(ann)
creates a PolyLine annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the PolyLine annotation.
- Returns:
- {PolyLineAnnot} A promise that resolves to an object of type: "PolyLineAnnot" (generated documentation)
<static>
{PolyLineAnnot}
PDFNet.PolyLineAnnot.createFromObj(d)
creates a PolyLine annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {PolyLineAnnot} A promise that resolves to an object of type: "PolyLineAnnot" (generated documentation)
{[ERROR]}
getEndStyle()
[Documentation Not Yet Added]
- Returns:
- {[ERROR]} A promise that resolves to an unknown type (generated documentation)
{number}
getIntentName()
Returns the intent name as a value of the "IntentName" enumeration type.
Return value enum:
PDFNet.PolyLineAnnot.IntentType = {
e_PolygonCloud : 0
e_PolyLineDimension : 1
e_PolygonDimension : 2
e_Unknown : 3
}
- Returns:
- {number} A promise that resolves tos The intent type of the annotation.
- See:
- IntentType
{[ERROR]}
getStartStyle()
[Documentation Not Yet Added]
- Returns:
- {[ERROR]} A promise that resolves to an unknown type (generated documentation)
{point}
getVertex(idx)
Returns the vertex(as a Point object) corresponding to the index
within the Vertices array.
- Parameters:
- {number} idx
- The index of the vertex, should be less than the value returned by GetVertexCount().
- Returns:
- {point} A promise that resolves to a Point object corresponding to the vertex in the specified index position.
{number}
getVertexCount()
Returns the number of vertices in the Vertices array.
- Returns:
- {number} A promise that resolves to the number of vertices.
setEndStyle(style)
[Documentation Not Yet Added]
- Parameters:
- {number/enum} style
- (generated enum documentation)
PDFNet.LineAnnot.EndingStyle = { e_Square : 0 e_Circle : 1 e_Diamond : 2 e_OpenArrow : 3 e_ClosedArrow : 4 e_Butt : 5 e_ROpenArrow : 6 e_RClosedArrow : 7 e_Slash : 8 e_None : 9 e_Unknown : 10 }
setIntentName(mode)
Sets the Intent name as a value of the "IntentName" enumeration type.
(Optional; PDF 1.6 )
- Parameters:
- {number} mode
- The intent name of the annotation.
- See:
- IntentType
setStartStyle(style)
[Documentation Not Yet Added]
- Parameters:
- {number/enum} style
- (generated enum documentation)
PDFNet.LineAnnot.EndingStyle = { e_Square : 0 e_Circle : 1 e_Diamond : 2 e_OpenArrow : 3 e_ClosedArrow : 4 e_Butt : 5 e_ROpenArrow : 6 e_RClosedArrow : 7 e_Slash : 8 e_None : 9 e_Unknown : 10 }
setVertex(idx, pt)
sets the vertex(in Point object form) corresponding to the index
within the Vertices array.
- Parameters:
- {number} idx
- The index of the vertex.
- {point} pt
- A Point object corresponding to the vertex to be added to the array.