Class PDFNet.CircleAnnot
PDFNet.CircleAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A Circle annotation is a type of markup annotation that displays an ellipse on
the page.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.CircleAnnot.create(doc, pos)
Creates a new Circle annotation in the specified document.
|
| <static> |
PDFNet.CircleAnnot.createFromAnnot(circle)
creates a Circle annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.CircleAnnot.createFromObj(d)
creates an Circle annotation and initializes it using given Cos/SDF object.
|
|
[Documentation Not Yet Added]
|
|
|
[Documentation Not Yet Added]
|
|
|
[Documentation Not Yet Added]
|
|
|
[Documentation Not Yet Added]
|
|
|
setContentRect(cr)
[Documentation Not Yet Added]
|
|
|
setInteriorColor(col, numcomp)
[Documentation Not Yet Added]
|
|
|
[Documentation Not Yet Added]
|
|
|
setPadding(cr)
[Documentation Not Yet Added]
|
Class Detail
PDFNet.CircleAnnot(id)
A Circle annotation is a type of markup annotation that displays an ellipse on
the page. When opened, it can display a pop-up window containing the text of
the associated note. The ellipse may be inscribed and possibly padded within the
annotation rectangle defined by the annotation dictionary's Rect entry.
- Parameters:
- id
Method Detail
<static>
{CircleAnnot}
PDFNet.CircleAnnot.create(doc, pos)
Creates a new Circle 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:
- {CircleAnnot} A promise that resolves to a newly created blank Circle annotation.
<static>
{CircleAnnot}
PDFNet.CircleAnnot.createFromAnnot(circle)
creates a Circle annotation and initializes it using given annotation object.
- Parameters:
- {Annot} circle
- Annot object used to initialize the Circle annotation.
- Returns:
- {CircleAnnot} A promise that resolves to an object of type: "CircleAnnot" (generated documentation)
<static>
{CircleAnnot}
PDFNet.CircleAnnot.createFromObj(d)
creates an Circle annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {CircleAnnot} A promise that resolves to an object of type: "CircleAnnot" (generated documentation)
{rect}
getContentRect()
[Documentation Not Yet Added]
- Returns:
- {rect} A promise that resolves to an object of type: "rect" (generated documentation)
{colorpt}
getInteriorColor()
[Documentation Not Yet Added]
- Returns:
- {colorpt} A promise that resolves to an object of type: "colorpt" (generated documentation)
{number}
getInteriorColorCompNum()
[Documentation Not Yet Added]
- Returns:
- {number} A promise that resolves to an object of type: "number" (generated documentation)
{rect}
getPadding()
[Documentation Not Yet Added]
- Returns:
- {rect} A promise that resolves to an object of type: "rect" (generated documentation)
setContentRect(cr)
[Documentation Not Yet Added]
- Parameters:
- {rect} cr
- (generated documentation)
setInteriorColor(col, numcomp)
[Documentation Not Yet Added]
- Parameters:
- {colorpt} col
- (generated documentation)
- {number} numcomp
- (generated documentation)
setInteriorColorDefault(col)
[Documentation Not Yet Added]
- Parameters:
- {colorpt} col
- (generated documentation)
setPadding(cr)
[Documentation Not Yet Added]
- Parameters:
- {rect} cr
- (generated documentation)