Class PDFNet.LineAnnot
PDFNet.LineAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.LineAnnot(id)
A line annotation (PDF 1.3) is used to display a single straight
line on the page.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.LineAnnot.create(doc, pos)
Creates a new Line annotation in the specified document.
|
| <static> |
PDFNet.LineAnnot.createFromAnnot(ann)
creates a Line annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.LineAnnot.createFromObj(d)
creates a Line annotation and initializes it using given Cos/SDF object.
|
|
[Documentation Not Yet Added]
|
|
|
Returns the coordinates of the end of a line.
|
|
|
Returns the ending style that applies to the second point of the line.
|
|
|
Returns the intent type of the line.
|
|
|
Returns the leader line extension length of a line.
|
|
|
Returns the leader line length of a line.
|
|
|
Returns the leader line offset length of a line.
|
|
|
Returns true if caption is to be shown, otherwise false.
|
|
|
Returns the coordinates of the start of a line.
|
|
|
Returns the ending style that applies to the first point of the line.
|
|
|
Returns the horizontal offset of the caption.
|
|
|
Returns the vertical offset of the caption.
|
|
|
setCapPos(it)
[Documentation Not Yet Added]
|
|
|
setEndPoint(ep)
sets the coordinates of the end of a line.
|
|
|
setEndStyle(es)
sets the ending style that applies to the second point of the line.
|
|
|
setIntentType(it)
sets the intent type of the line.
|
|
|
setLeaderLineExtensionLength(length)
Sets the leader line extension length of a line.
|
|
|
setLeaderLineLength(length)
Sets the leader line length of a line.
|
|
|
setLeaderLineOffset(length)
sets the leader line offset length of a line.
|
|
|
setShowCaption(showCaption)
Sets the option of whether to show caption.
|
|
|
setStartPoint(sp)
sets the coordinates of the start of a line.
|
|
|
setStartStyle(ss)
sets the ending style that applies to the first point of the line.
|
|
|
setTextHOffset(offset)
sets the horizontal offset of the caption.
|
|
|
setTextVOffset(offset)
sets the vertical offset of the caption.
|
Class Detail
PDFNet.LineAnnot(id)
A line annotation (PDF 1.3) is used to display a single straight
line on the page. When opened, it should display a pop-up window containing
the text of the associated note.
- Parameters:
- id
Method Detail
<static>
{LineAnnot}
PDFNet.LineAnnot.create(doc, pos)
Creates a new Line annotation in the specified document.
- Parameters:
- {SDFDoc} doc
- A document to which the annotation is added.
- {rect} pos
- A rectangle specifying the annotation's bounds in default user space units.
- Returns:
- {LineAnnot} A promise that resolves to a newly created blank Line annotation.
<static>
{LineAnnot}
PDFNet.LineAnnot.createFromAnnot(ann)
creates a Line annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the Line annotation.
- Returns:
- {LineAnnot} A promise that resolves to an object of type: "LineAnnot" (generated documentation)
<static>
{LineAnnot}
PDFNet.LineAnnot.createFromObj(d)
creates a Line annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- (generated documentation)
- Returns:
- {LineAnnot} A promise that resolves to an object of type: "LineAnnot" (generated documentation)
{[ERROR]}
getCapPos()
[Documentation Not Yet Added]
- Returns:
- {[ERROR]} A promise that resolves to an unknown type (generated documentation)
{point}
getEndPoint()
Returns the coordinates of the end of a line.
- Returns:
- {point} A promise that resolves to a point specifying the coordinates of the end of the line.
{number}
getEndStyle()
Returns the ending style that applies to the second point of the line.
Return value enum:
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
}
- Returns:
- {number} A promise that resolves to a enum value from the "EndingStyle".
{number}
getIntentType()
Returns the intent type of the line.
Return value enum:
PDFNet.LineAnnot.IntentType = {
e_LineArrow : 0
e_LineDimension : 1
e_null : 2
}
- Returns:
- {number} A promise that resolves to an intent type value from the "IntentType" enum.
{number}
getLeaderLineExtensionLength()
Returns the leader line extension length of a line.
- Returns:
- {number} A promise that resolves to a number denoting the length of the leader line extension in default user space units.
{number}
getLeaderLineLength()
Returns the leader line length of a line.
- Returns:
- {number} A promise that resolves to a number denoting the length of the leader line in default user space units.
{number}
getLeaderLineOffset()
Returns the leader line offset length of a line.
- Returns:
- {number} A promise that resolves to a number denoting the length of the leader line offset in default user space units.
{boolean}
getShowCaption()
Returns true if caption is to be shown, otherwise false.
- Returns:
- {boolean} A promise that resolves to a boolean value indicating whether the caption will be shown.
{point}
getStartPoint()
Returns the coordinates of the start of a line.
- Returns:
- {point} A promise that resolves to a point specifying the coordinates of the start of the line.
{number}
getStartStyle()
Returns the ending style that applies to the first point of the line.
Return value enum:
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
}
- Returns:
- {number} A promise that resolves to a enum value from the "EndingStyle".
{number}
getTextHOffset()
Returns the horizontal offset of the caption.
- Returns:
- {number} A promise that resolves to a number denoting the horizontal offset of the caption in default user space units.
{number}
getTextVOffset()
Returns the vertical offset of the caption.
- Returns:
- {number} A promise that resolves to a number denoting the vertical offset of the caption in default user space units.
setCapPos(it)
[Documentation Not Yet Added]
- Parameters:
- {number/enum} it
- (generated enum documentation)
PDFNet.LineAnnot.CapPos = { e_Inline : 0 e_Top : 1 }
setEndPoint(ep)
sets the coordinates of the end of a line.
- Parameters:
- {point} ep
- A point specifying the coordinates of the end of the line.
setEndStyle(es)
sets the ending style that applies to the second point of the line.
(Optional; PDF 1.4)
- Parameters:
- {number} es
- A enum value from the "EndingStyle".
setIntentType(it)
sets the intent type of the line.
(For PDF 1.6)
- Parameters:
- {number} it
- An intent type value from the "IntentType" enum.
setLeaderLineExtensionLength(length)
Sets the leader line extension length of a line.
(PDF 1.6)
- Parameters:
- {number} length
- A number denoting the length of the leader line extension in default user space units.
setLeaderLineLength(length)
Sets the leader line length of a line.
(PDF 1.6)
- Parameters:
- {number} length
- A number denoting the length of the leader line in default user space units.
setLeaderLineOffset(length)
sets the leader line offset length of a line.
(PDF 1.7)
- Parameters:
- {number} length
- A number denoting the length of the leader line offset in default user space units.
setShowCaption(showCaption)
Sets the option of whether to show caption.
- Parameters:
- {boolean} showCaption
- A boolean value indicating whether the caption will be shown.
setStartPoint(sp)
sets the coordinates of the start of a line.
- Parameters:
- {point} sp
- A point specifying the coordinates of the end of the line.
setStartStyle(ss)
sets the ending style that applies to the first point of the line.
(Optional; PDF 1.4.)
- Parameters:
- {number} ss
- A enum value from the "EndingStyle".
setTextHOffset(offset)
sets the horizontal offset of the caption.
(For PDF 1.7 )
- Parameters:
- {number} offset
- A number denoting the horizontal offset of the caption in default user space units.
setTextVOffset(offset)
sets the vertical offset of the caption.
(For PDF 1.7 )
- Parameters:
- {number} offset
- A number denoting the vertical offset of the caption in default user space units.