new CircleAnnot()
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.
Methods
-
<static> create(doc, pos)
-
Creates a new Circle annotation in the specified document.
Parameters:
Name Type Description doc
SDFDoc A document to which the annotation is added.
pos
rect A rectangle specifying the annotation's bounds in default user space units.
Returns:
A promise that resolves to a newly created blank Circle annotation.
- Type
- CircleAnnot
-
<static> createFromAnnot(circle)
-
creates a Circle annotation and initializes it using given annotation object.
Parameters:
Name Type Description circle
Annot Annot object used to initialize the Circle annotation.
Returns:
A promise that resolves to an object of type: "CircleAnnot"
- Type
- CircleAnnot
-
<static> createFromObj(d)
-
creates an Circle annotation and initializes it using given Cos/SDF object.
Parameters:
Name Type Description d
Obj The Cos/SDF object to initialze the annotation with.
Returns:
A promise that resolves to an object of type: "CircleAnnot"
- Type
- CircleAnnot
-
getContentRect()
-
Returns:
A promise that resolves to an object of type: "rect"
- Type
- rect
-
getInteriorColor()
-
Returns:
A promise that resolves to an object of type: "colorpt"
- Type
- colorpt
-
getInteriorColorCompNum()
-
Returns:
A promise that resolves to an object of type: "number"
- Type
- number
-
getPadding()
-
Returns:
A promise that resolves to an object of type: "rect"
- Type
- rect
-
setContentRect(cr)
-
Parameters:
Name Type Description cr
rect -
setInteriorColor(col, numcomp)
-
Parameters:
Name Type Description col
colorpt numcomp
number -
setInteriorColorDefault(col)
-
Parameters:
Name Type Description col
colorpt -
setPadding(cr)
-
Parameters:
Name Type Description cr
rect