PDFTron WebViewer

Class: PolygonAnnot

PDFNet. PolygonAnnot

new PolygonAnnot()

A polygon annotation

Extends

Methods

<static> create(doc, pos)

Creates a new Polygon annotation in the specified document.
Parameters:
Name Type Description
doc PDFNet.PDFDoc | PDFNet.SDFDoc | PDFNet.FDFDoc A document to which the Polygon annotation is added.
pos PDFNet.Rect A rectangle specifying the Polygon annotation's bounds in default user space units.
Returns:
A promise that resolves to a newly created blank Polygon annotation.
Type
Promise.<PDFNet.PolygonAnnot>

<static> createFromAnnot(ann)

creates a Polygon annotation and initializes it using given annotation object.
Parameters:
Name Type Description
ann PDFNet.Annot Annot object used to initialize the Polygon annotation.
Returns:
A promise that resolves to an object of type: "PDFNet.PolygonAnnot"
Type
Promise.<PDFNet.PolygonAnnot>

<static> createFromObj( [d])

creates a Polygon annotation and initializes it using given Cos/SDF object.
Parameters:
Name Type Argument Description
d PDFNet.Obj <optional>
 The Cos/SDF object to initialze the annotation with.
Returns:
A promise that resolves to an object of type: "PDFNet.PolygonAnnot"
Type
Promise.<PDFNet.PolygonAnnot>

compare(d)

Compares two annotations for equality. The comparison will return true only if both annotations share the same underlying SDF/Cos object.
Parameters:
Name Type Description
d PDFNet.Annot Annotation to compare to
Inherited From:
Returns:
A promise that resolves to an object of type: "boolean"
Type
Promise.<boolean>

copy()

Copy Constructor
Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.Annot"
Type
Promise.<PDFNet.Annot>

deleteCustomData(key)

Deletes custom data associated with the given key.
Parameters:
Name Type Description
key string The key for which to delete the associated data.
Inherited From:
Returns:
Type
Promise.<void>

flatten(page)

Parameters:
Name Type Description
page PDFNet.Page
Inherited From:
Returns:
Type
Promise.<void>

getActiveAppearanceState()

Gets the annotation's active appearance state.
Inherited From:
Returns:
A promise that resolves to the name of the active state. The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary.
Type
Promise.<string>

getAppearance( [annot_state] [, app_state])

Gets the annotation's appearance for the given combination of annotation and appearance states.
Parameters:
Name Type Argument Description
annot_state number <optional>
 
PDFNet.Annot.State = {
	e_normal : 0
	e_rollover : 1
	e_down : 2
}
the annotation's appearance state, which selects the applicable appearance stream from the appearance sub-dictionary. An annotation can define as many as three separate appearances: The normal, rollover, and down appearance.
app_state string <optional>
 is an optional parameter specifying the appearance state to look for (e.g. "Off", "On", etc). If appearance_state is NULL, the choice between different appearance states is determined by the AS (Appearance State) entry in the annotation dictionary.
Inherited From:
Returns:
A promise that resolves to the appearance stream for this annotation, or NULL if the annotation does not have an appearance for the given combination of annotation and appearance states.
Type
Promise.<PDFNet.Obj>

getBorderEffect()

Inherited From:
Returns:
A promise that resolves to the border effect of the markup annotation. Default value: e_None. Beginning with PDF 1.5, some annotations (square, circle, and polygon) may have a 'BE' entry, which is a border effect dictionary that specifies an effect that shall be applied to the border of the annotations. Beginning with PDF 1.6, the free text annotation may also have a BE entry.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.MarkupAnnot.BorderEffect = {
	e_None : 0
	e_Cloudy : 1
}
</pre>

getBorderEffectIntensity()

Inherited From:
Returns:
A promise that resolves to a number describing the intensity of the border effect, in the range 0 to 2. Beginning with PDF 1.5, some annotations (square, circle, and polygon) may have a 'BE' entry, which is a border effect dictionary that specifies an effect that shall be applied to the border of the annotations. Beginning with PDF 1.6, the free text annotation may also have a BE entry.
Type
Promise.<number>

getBorderStyle()

Gets the border style for the annotation. Typically used for Link annotations.
Inherited From:
Returns:
A promise that resolves to annotation's border style.
Type
Promise.<PDFNet.AnnotBorderStyle>

getCapPos()

Inherited From:
Returns:
A promise that resolves to an object of type: "number" 
PDFNet.LineAnnot.CapPos = {
	e_Inline : 0
	e_Top : 1
}
Type
Promise.<number>

getColor()

Gets an annotation's color without any specified color space. It is generally recommended to use getColorAsRGB(), getColorAsCMYK() or getColorAsGray() for more predictable behavior
Inherited From:
Returns:
A promise that resolves to a ColorPt object containing an array of numbers in the range 0.0 to 1.0.
Type
Promise.<PDFNet.ColorPt>

getColorAsCMYK()

Returns the annotation's color in CMYK color space.
Inherited From:
Returns:
A promise that resolves to a ColorPt object containing an array of four numbers in the range 0.0 to 1.0, representing a CMYK color used for the following purposes: The background of the annotation's icon when closed The title bar of the annotation's pop-up window The border of a link annotation If the annotation does not specify an explicit color, a default color is returned. Text annotations return 'default yellow;' all others return black.
Type
Promise.<PDFNet.ColorPt>

getColorAsGray()

Returns the annotation's color in Gray color space.
Inherited From:
Returns:
A promise that resolves to a ColorPt object containing a number in the range 0.0 to 1.0, representing a Gray Scale color used for the following purposes: The background of the annotation's icon when closed The title bar of the annotation's pop-up window The border of a link annotation If the annotation does not specify an explicit color, black color is returned.
Type
Promise.<PDFNet.ColorPt>

getColorAsRGB()

Gets an annotation's color in RGB color space.
Inherited From:
Returns:
A promise that resolves to a ColorPt object containing an array of three numbers in the range 0.0 to 1.0, representing an RGB colour used for the following purposes: The background of the annotation's icon when closed The title bar of the annotation's pop-up window The border of a link annotation If the annotation does not specify an explicit color, a default color is returned. Text annotations return 'default yellow;' all others return black.
Type
Promise.<PDFNet.ColorPt>

getColorCompNum()

Returns the color space the annotation's color is represented in.
Inherited From:
Returns:
A promise that resolves to an integer that is either 1(for DeviceGray), 3(DeviceRGB), or 4(DeviceCMYK). If the annotation has no color, i.e. is transparent, 0 will be returned.
Type
Promise.<number>

getContentRect()

Returns the inner bounding rectangle of the Markup annotation.
Inherited From:
Returns:
A promise that resolves to a rectangle specifying the region where content should be displayed.
Type
Promise.<PDFNet.Rect>

getContents()

Extract the content of this annotation. (Optional).
Inherited From:
Returns:
A promise that resolves to A unicode string object with the text that is associated with this annotation. This is the text that annotation displays on user interaction, if the annotation type supports it.
Type
Promise.<string>

getCreationDates()

Inherited From:
Returns:
A promise that resolves to the creation date for the markup annotation.
Type
Promise.<PDFNet.Date>

getCustomData(key)

Returns custom data associated with the given key.
Parameters:
Name Type Description
key string The key for which to retrieve the associated data.
Inherited From:
Returns:
A promise that resolves to the custom data string. If no data is available an empty string is returned.
Type
Promise.<string>

getDate()

Gets an annotation's last modified date.
Inherited From:
Returns:
A promise that resolves to the annotation's last modified time and date. If the annotation has no associated date structure, the returned date is not valid (date.IsValid() returns false). Corresponds to the "M" entry of the annotation dictionary.
Type
Promise.<PDFNet.Date>

getEndPoint()

Returns the coordinates of the end of a line.
Inherited From:
Returns:
A promise that resolves to a point specifying the coordinates of the end of the line.
Type
Promise.<PDFNet.Point>

getEndStyle()

Inherited From:
Returns:
A promise that resolves to an object of type: "number" 
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
}
Type
Promise.<number>

getFlag(flag)

Parameters:
Name Type Description
flag number 
PDFNet.Annot.Flag = {
	e_invisible : 0
	e_hidden : 1
	e_print : 2
	e_no_zoom : 3
	e_no_rotate : 4
	e_no_view : 5
	e_annot_read_only : 6
	e_locked : 7
	e_toggle_no_view : 8
	e_locked_contents : 9
}
The Flag property to query.
Inherited From:
Returns:
A promise that resolves to the value of given Flag
Type
Promise.<boolean>

getIntentName()

Returns the intent name as a value of the "IntentName" enumeration type.
Inherited From:
See:
  • IntentType
Returns:
A promise that resolves to the intent type of the annotation.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.PolyLineAnnot.IntentType = {
	e_PolygonCloud : 0
	e_PolyLineDimension : 1
	e_PolygonDimension : 2
	e_Unknown : 3
}
</pre>

getIntentType()

Returns the intent type of the line.
Inherited From:
Returns:
A promise that resolves to an intent type value from the "IntentType" enum.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.LineAnnot.IntentType = {
	e_LineArrow : 0
	e_LineDimension : 1
	e_null : 2
}
</pre>

getInteriorColor()

Returns the interior color of the annotation.
Inherited From:
Returns:
A promise that resolves to a ColorPt object that denotes the color of the annotation.
Type
Promise.<PDFNet.ColorPt>

getInteriorColorCompNum()

Returns the number indicating the interior color space of the annotation.
Inherited From:
Returns:
A promise that resolves to an integer indicating the number of channels forming the color space. 3 corresponds to RGB, 4 corresponds to CMYK, and 1 corresponds to Gray. If the interior is transparent, the return value is 0.
Type
Promise.<number>

getLeaderLineExtensionLength()

Returns the leader line extension length of a line.
Inherited From:
Returns:
A promise that resolves to a number denoting the length of the leader line extension in default user space units.
Type
Promise.<number>

getLeaderLineLength()

Returns the leader line length of a line.
Inherited From:
Returns:
A promise that resolves to a number denoting the length of the leader line in default user space units.
Type
Promise.<number>

getLeaderLineOffset()

Returns the leader line offset length of a line.
Inherited From:
Returns:
A promise that resolves to a number denoting the length of the leader line offset in default user space units.
Type
Promise.<number>

getOpacity()

Inherited From:
Returns:
A promise that resolves to the opacity value. Default value: 1.0.
Type
Promise.<number>

getOptionalContent()

Returns optional content associated with this annotation.
Inherited From:
Returns:
A promise that resolves to a SDF object corresponding to the group of optional properties.
Type
Promise.<PDFNet.Obj>

getPadding()

Returns the rectangle difference between overall annotation rectangle and content rectangle.
Inherited From:
See:
  • GetContentRect()
Returns:
A promise that resolves to a set of four numbers represented as a Rect struct.
Type
Promise.<PDFNet.Rect>

getPage()

Gets the page the annotation is associated with.
Inherited From:
Returns:
A promise that resolves to a Page object or null page object if the page reference is not available. The page object returned is an indirect reference to the page object with which this annotation is associated. This entry shall be present in screen annotations associated with rendition actions. Optional. PDF 1.3 PDF 1.4 PDF 1.5 not used in FDF files.
Type
Promise.<PDFNet.Page>

getPopup()

Returns the Popup object associated with this markup annotation.
Inherited From:
Returns:
A promise that resolves to a Popup object that is associated with this markup annotation.
Type
Promise.<PDFNet.Annot>

getRect()

Inherited From:
Returns:
A promise that resolves to annotation's bounding rectangle, specified in user space coordinates. The meaning of the rectangle depends on the annotation type. For Link and RubberStamp annotations, the rectangle specifies the area containing the hyperlink area or stamp. For Note annotations, the rectangle is describing the popup window when it's opened. When it's closed, the icon is positioned at lower left corner.
Type
Promise.<PDFNet.Rect>

getRotation()

Returns the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.
Inherited From:
Returns:
A promise that resolves to an integer representing the rotation value of the annotation.
Type
Promise.<number>

getSDFObj()

Inherited From:
Returns:
A promise that resolves to the underlying SDF/Cos object.
Type
Promise.<PDFNet.Obj>

getShowCaption()

Returns true if caption is to be shown, otherwise false.
Inherited From:
Returns:
A promise that resolves to a boolean value indicating whether the caption will be shown.
Type
Promise.<boolean>

getStartPoint()

Returns the coordinates of the start of a line.
Inherited From:
Returns:
A promise that resolves to a point specifying the coordinates of the start of the line.
Type
Promise.<PDFNet.Point>

getStartStyle()

Inherited From:
Returns:
A promise that resolves to an object of type: "number" 
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
}
Type
Promise.<number>

getStructParent()

Returns the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Inherited From:
Returns:
A promise that resolves to an integer which is the integer key of the annotation's entry in the structural parent tree.
Type
Promise.<number>

getSubject()

Returns the subject of the Markup annotation. (PDF 1.5)
Inherited From:
Returns:
A promise that resolves to a string representing the subject of the Markup annotation.
Type
Promise.<string>

getTextHOffset()

Returns the horizontal offset of the caption.
Inherited From:
Returns:
A promise that resolves to a number denoting the horizontal offset of the caption in default user space units.
Type
Promise.<number>

getTextVOffset()

Returns the vertical offset of the caption.
Inherited From:
Returns:
A promise that resolves to a number denoting the vertical offset of the caption in default user space units.
Type
Promise.<number>

getTitle()

Returns the title of the markup annotation.
Inherited From:
Returns:
A promise that resolves to a string representing the title of the markup annotation, or null is the title is not specified.
Type
Promise.<string>

getTriggerAction(trigger)

Get the Action associated with the selected Annot Trigger event.
Parameters:
Name Type Description
trigger number 
PDFNet.Annot.EventType = {
	e_action_trigger_activate : 0
	e_action_trigger_annot_enter : 1
	e_action_trigger_annot_exit : 2
	e_action_trigger_annot_down : 3
	e_action_trigger_annot_up : 4
	e_action_trigger_annot_focus : 5
	e_action_trigger_annot_blur : 6
	e_action_trigger_annot_page_open : 7
	e_action_trigger_annot_page_close : 8
	e_action_trigger_annot_page_visible : 9
	e_action_trigger_annot_page_invisible : 10
}
the type of trigger event to get
Inherited From:
Returns:
A promise that resolves to the Action Obj if present, otherwise NULL
Type
Promise.<PDFNet.Obj>

getType()

Inherited From:
Returns:
A promise that resolves to the type of this annotation. Corresponds to the "Subtype" entry of annotation dictionary, as per PDF Reference Manual section 12.5.2
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.Annot.Type = {
	e_Text : 0
	e_Link : 1
	e_FreeText : 2
	e_Line : 3
	e_Square : 4
	e_Circle : 5
	e_Polygon : 6
	e_Polyline : 7
	e_Highlight : 8
	e_Underline : 9
	e_Squiggly : 10
	e_StrikeOut : 11
	e_Stamp : 12
	e_Caret : 13
	e_Ink : 14
	e_Popup : 15
	e_FileAttachment : 16
	e_Sound : 17
	e_Movie : 18
	e_Widget : 19
	e_Screen : 20
	e_PrinterMark : 21
	e_TrapNet : 22
	e_Watermark : 23
	e_3D : 24
	e_Redact : 25
	e_Projection : 26
	e_RichMedia : 27
	e_Unknown : 28
}
</pre>

getUniqueID()

Inherited From:
Returns:
A promise that resolves to the unique identifier for this annotation, or NULL if the identifier is not available. The returned value is a String object and is the value of the "NM" field, which was added as an optional attribute in PDF 1.4.
Type
Promise.<PDFNet.Obj>

getVertex(idx)

Returns the vertex(as a Point object) corresponding to the index within the Vertices array.
Parameters:
Name Type Description
idx number The index of the vertex, should be less than the value returned by GetVertexCount().
Inherited From:
Returns:
A promise that resolves to a Point object corresponding to the vertex in the specified index position.
Type
Promise.<PDFNet.Point>

getVertexCount()

Returns the number of vertices in the Vertices array.
Inherited From:
Returns:
A promise that resolves to the number of vertices.
Type
Promise.<number>

getVisibleContentBox()

It is possible during viewing that GetRect does not return the most accurate bounding box of what is actually rendered. This method calculates the bounding box, rather than relying on what is specified in the PDF document. The bounding box is defined as the smallest rectangle that includes all the visible content on the annotation.
Inherited From:
Returns:
A promise that resolves to the bounding box for this annotation. The dimensions are specified in user space coordinates.
Type
Promise.<PDFNet.Rect>

isMarkup()

Return true if this annotation is classified as a markup annotation.
Inherited From:
Returns:
A promise that resolves to boolean value, true if this annotation is classified as a markup annotation.
Type
Promise.<boolean>

isValid()

Inherited From:
Returns:
A promise that resolves to true if this is a valid (non-null) annotation, false otherwise. If the function returns false the underlying SDF/Cos object is null or is not valid and the annotation object should be treated as a null object.
Type
Promise.<boolean>

refreshAppearance()

Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.
Inherited From:
Returns:
Type
Promise.<void>

refreshAppearanceRefreshOptions( [options])

A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
Parameters:
Name Type Argument Description
options PDFNet.RefreshOptions <optional>
 The RefreshOptions.
Inherited From:
Returns:
Type
Promise.<void>

removeAppearance( [annot_state] [, app_state])

Removes the annotation's appearance for the given combination of annotation and appearance states.
Parameters:
Name Type Argument Description
annot_state number <optional>
 
PDFNet.Annot.State = {
	e_normal : 0
	e_rollover : 1
	e_down : 2
}
the annotation's appearance state, which selects the applicable appearance stream from the appearance sub-dictionary. An annotation can define as many as three separate appearances: The normal, rollover, and down appearance.
app_state string <optional>
 is an optional parameter specifying the appearance state (e.g. "Off", "On", etc) under which the new appearance should be stored. If appearance_state is NULL, the annotation will have only one annotation state.
Inherited From:
Returns:
Type
Promise.<void>

resize(newrect)

Scales the geometry of the annotation so that its appearance would now fit a new rectangle on the page, in user units. Users still have to call RefreshAppearance() later if they want a corresponding appearance stream to be generated for the new rectangle. The main reason for not combining the two operations together is to be able to resize annotations that do not have an appearance stream.
Parameters:
Name Type Description
newrect PDFNet.Rect A reference to the new rectangle to which this annotation has to be resized.
Inherited From:
Returns:
Type
Promise.<void>

rotateAppearance(angle)

Rotates the appearance of the Markup annotation.
Parameters:
Name Type Description
angle number The new rotation
Inherited From:
Returns:
Type
Promise.<void>

setActiveAppearanceState(astate)

Parameters:
Name Type Description
astate string
Inherited From:
Returns:
Type
Promise.<void>

setAppearance(app_stream [, annot_state] [, app_state])

Sets the annotation's appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
Parameters:
Name Type Argument Description
app_stream PDFNet.Obj a content stream defining the new appearance.
annot_state number <optional>
 
PDFNet.Annot.State = {
	e_normal : 0
	e_rollover : 1
	e_down : 2
}
the annotation's appearance state, which selects the applicable appearance stream from the appearance sub-dictionary. An annotation can define as many as three separate appearances: The normal, rollover, and down appearance.
app_state string <optional>
 is an optional parameter specifying the appearance state (e.g. "Off", "On", etc) under which the new appearance should be stored. If appearance_state is NULL, the annotation will have only one annotation state.
Inherited From:
Returns:
Type
Promise.<void>

setBorderEffect( [effect])

Sets the border effect of the markup annotation. (Optional; PDF 1.5 ) Beginning with PDF 1.5, some annotations (square, circle, and polygon) may have a 'BE' entry, which is a border effect dictionary that specifies an effect that shall be applied to the border of the annotations. Beginning with PDF 1.6, the free text annotation may also have a BE entry.
Parameters:
Name Type Argument Description
effect number <optional>
 
PDFNet.MarkupAnnot.BorderEffect = {
	e_None : 0
	e_Cloudy : 1
}
An entry from the enum "BorderEffect" that represents the border effect of the Markup annotation. Default value: e_None.
Inherited From:
Returns:
Type
Promise.<void>

setBorderEffectIntensity( [intensity])

sets the border effect intensity of the markup annotation. (Optional; valid only if Border effect is Cloudy) Beginning with PDF 1.5, some annotations (square, circle, and polygon) may have a 'BE' entry, which is a border effect dictionary that specifies an effect that shall be applied to the border of the annotations. Beginning with PDF 1.6, the free text annotation may also have a BE entry.
Parameters:
Name Type Argument Description
intensity number <optional>
 A number describing the intensity of the border effect, in the range 0 (which is default) to 2.
Inherited From:
Returns:
Type
Promise.<void>

setBorderStyle(bs [, oldStyleOnly])

Sets the border style for the annotation.
Parameters:
Name Type Argument Description
bs PDFNet.AnnotBorderStyle New border style for this annotation.
oldStyleOnly boolean <optional>
 PDF manual specifies two ways to add border information to an annotation object, either through an array named 'Border' (PDF 1.0), or a dictionary called 'BS' (PDF 1.2) the latter taking precedence over the former. However, if you want to create a border with rounded corners, you can only do that using PDF 1.0 Border specification, in which case if you call SetBorderStyle() set the parameter oldStyleOnly to true. This parameter has a default value of false in the API and does not need to be used otherwise.
Inherited From:
Returns:
Type
Promise.<void>

setCapPos(it)

Parameters:
Name Type Description
it number 
PDFNet.LineAnnot.CapPos = {
	e_Inline : 0
	e_Top : 1
}
Inherited From:
Returns:
Type
Promise.<void>

setColor(col [, numcomp])

Sets an annotation's color. (Optional; PDF 1.1)
Parameters:
Name Type Argument Description
col PDFNet.ColorPt A ColorPt object in RGB or Gray or CMYK color space representing the annotation's color. The ColorPt contains an array of numbers in the range 0.0 to 1.0, representing a color used for the following purposes: The background of the annotation's icon when closed The title bar of the annotation's pop-up window The border of a link annotation The number of array elements determines the color space in which the color shall be defined: 0 No color; transparent 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
numcomp number <optional>
 The number of color components used to represent the color (i.e. 1, 3, 4).
Inherited From:
Returns:
Type
Promise.<void>

setColorDefault(col)

Parameters:
Name Type Description
col PDFNet.ColorPt
Inherited From:
Returns:
Type
Promise.<void>

setContentRect(cr)

sets the inner bounding rectangle of the Markup annotation. (Optional)
Parameters:
Name Type Description
cr PDFNet.Rect A Rect struct to be assign to the 'RD' entry of the annotation dictionary.
Inherited From:
Returns:
Type
Promise.<void>

setContents(contents)

Sets the content of this annotation. (Optional).
Parameters:
Name Type Description
contents string A reference to unicode string object with the text that will be associated with this annotation. This is the text that annotation displays on user interaction, if the annotation type supports it.
Inherited From:
Returns:
Type
Promise.<void>

setCreationDates(dt)

Sets the creation date for the markup annotation. (Optional; PDF 1.5 )
Parameters:
Name Type Description
dt PDFNet.Date A Date object indicating the date the markup annotation is created.
Inherited From:
Returns:
Type
Promise.<void>

setCustomData(key, value)

Sets the custom data associated with the specified key.
Parameters:
Name Type Description
key string The key under which to store this custom data
value string The custom data string to store
Inherited From:
Returns:
Type
Promise.<void>

setDate(date)

Sets an annotation's last modified date.
Parameters:
Name Type Description
date PDFNet.Date The annotation's last modified time and date. Corresponds to the "M" entry of the annotation dictionary.
Inherited From:
Returns:
Type
Promise.<void>

setEndPoint(ep)

sets the coordinates of the end of a line.
Parameters:
Name Type Description
ep PDFNet.Point A point specifying the coordinates of the end of the line.
Inherited From:
Returns:
Type
Promise.<void>

setEndStyle(style)

Parameters:
Name Type Description
style number 
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
}
Inherited From:
Returns:
Type
Promise.<void>

setFlag(flag, value)

sets the value of given Flag.
Parameters:
Name Type Description
flag number 
PDFNet.Annot.Flag = {
	e_invisible : 0
	e_hidden : 1
	e_print : 2
	e_no_zoom : 3
	e_no_rotate : 4
	e_no_view : 5
	e_annot_read_only : 6
	e_locked : 7
	e_toggle_no_view : 8
	e_locked_contents : 9
}
The Flag property to modify.
value boolean The new value for the property.
Inherited From:
Returns:
Type
Promise.<void>

setIntentName(mode)

Sets the Intent name as a value of the "IntentName" enumeration type. (Optional; PDF 1.6 )
Parameters:
Name Type Description
mode number 
PDFNet.PolyLineAnnot.IntentType = {
	e_PolygonCloud : 0
	e_PolyLineDimension : 1
	e_PolygonDimension : 2
	e_Unknown : 3
}
The intent name of the annotation.
Inherited From:
See:
  • IntentType
Returns:
Type
Promise.<void>

setIntentType(it)

sets the intent type of the line. (For PDF 1.6)
Parameters:
Name Type Description
it number 
PDFNet.LineAnnot.IntentType = {
	e_LineArrow : 0
	e_LineDimension : 1
	e_null : 2
}
An intent type value from the "IntentType" enum.
Inherited From:
Returns:
Type
Promise.<void>

setInteriorColor(c, CompNum)

Sets the interior color of the Markup annotation.
Parameters:
Name Type Description
c PDFNet.ColorPt A ColorPt object that denotes the color of the Markup annotation.
CompNum number An integer indicating the number of channels forming the color space used. It also defines the length of the array to be allocated for storing the entries of c.
Inherited From:
Returns:
Type
Promise.<void>

setInteriorColorRGB(col)

Parameters:
Name Type Description
col PDFNet.ColorPt
Inherited From:
Returns:
Type
Promise.<void>

setLeaderLineExtensionLength(length)

Sets the leader line extension length of a line. (PDF 1.6)
Parameters:
Name Type Description
length number A number denoting the length of the leader line extension in default user space units.
Inherited From:
Returns:
Type
Promise.<void>

setLeaderLineLength(length)

Sets the leader line length of a line. (PDF 1.6)
Parameters:
Name Type Description
length number A number denoting the length of the leader line in default user space units.
Inherited From:
Returns:
Type
Promise.<void>

setLeaderLineOffset(length)

sets the leader line offset length of a line. (PDF 1.7)
Parameters:
Name Type Description
length number A number denoting the length of the leader line offset in default user space units.
Inherited From:
Returns:
Type
Promise.<void>

setOpacity(op)

Sets the opacity value for the annotation. (Optional; PDF 1.4 )
Parameters:
Name Type Description
op number A number indicating the Markup annotation's opacity value. Default value: 1.0.
Inherited From:
Returns:
Type
Promise.<void>

setOptionalContent(content)

Associates optional content with this annotation. (Optional, PDF1.5).
Parameters:
Name Type Description
content PDFNet.Obj A pointer to an SDF object corresponding to the optional content, a PDF::OCG::Group or membership dictionary specifying the PDF::OCG::Group properties for the annotation. Before the annotation is drawn, its visibility shall be determined based on this entry as well as the annotation flags specified in the Flag entry . If it is determined to be invisible, the annotation shall be skipped, as if it were not in the document.
Inherited From:
Returns:
Type
Promise.<void>

setPadding(rd)

sets the rectangle difference between overall annotation rectangle and content rectangle. (Optional)
Parameters:
Name Type Description
rd PDFNet.Rect A set of four numbers represented as a Rect struct
Inherited From:
See:
  • GetContentRect()
Returns:
Type
Promise.<void>

setPage(Page)

sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
Parameters:
Name Type Description
Page PDFNet.Page The page object user wants the annotation to be associated with.
Inherited From:
Returns:
Type
Promise.<void>

setPopup(ppup)

Sets the Popup object associated with this markup annotation. (Optional; PDF 1.3 )
Parameters:
Name Type Description
ppup PDFNet.Annot A Popup object that is associated with this markup annotation.
Inherited From:
Returns:
Type
Promise.<void>

setRect(pos)

Sets the size and location of an annotation on its page.
Parameters:
Name Type Description
pos PDFNet.Rect Annotation's bounding rectangle, specified in user space coordinates. The meaning of the rectangle depends on the annotation type. For Link and RubberStamp annotations, the rectangle specifies the area containing the hyperlink area or stamp. For Note annotations, the rectangle is describing the popup window when it's opened. When it's closed, the icon is positioned at lower left corner.
Inherited From:
Returns:
Type
Promise.<void>

setRotation(angle)

Sets the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)
Parameters:
Name Type Description
angle number An integer representing the rotation value of the annotation.
Inherited From:
Returns:
Type
Promise.<void>

setShowCaption(showCaption)

Sets the option of whether to show caption.
Parameters:
Name Type Description
showCaption boolean A boolean value indicating whether the caption will be shown.
Inherited From:
Returns:
Type
Promise.<void>

setStartPoint(sp)

sets the coordinates of the start of a line.
Parameters:
Name Type Description
sp PDFNet.Point A point specifying the coordinates of the end of the line.
Inherited From:
Returns:
Type
Promise.<void>

setStartStyle(style)

Parameters:
Name Type Description
style number 
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
}
Inherited From:
Returns:
Type
Promise.<void>

setStructParent(parkeyval)

sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Parameters:
Name Type Description
parkeyval number An integer which is the integer key of the annotation's entry in the structural parent tree.
Inherited From:
Returns:
Type
Promise.<void>

setSubject(contents)

Sets subject of the Markup annotation. (Optional; PDF 1.5 )
Parameters:
Name Type Description
contents string A string representing the subject of the Markup annotation.
Inherited From:
Returns:
Type
Promise.<void>

setTextHOffset(offset)

sets the horizontal offset of the caption. (For PDF 1.7 )
Parameters:
Name Type Description
offset number A number denoting the horizontal offset of the caption in default user space units.
Inherited From:
Returns:
Type
Promise.<void>

setTextVOffset(offset)

sets the vertical offset of the caption. (For PDF 1.7 )
Parameters:
Name Type Description
offset number A number denoting the vertical offset of the caption in default user space units.
Inherited From:
Returns:
Type
Promise.<void>

setTitle(title)

sets the title of the markup annotation. (Optional; PDF 1.1)
Parameters:
Name Type Description
title string A string.
Inherited From:
Returns:
Type
Promise.<void>

setTitleUString(title)

sets the title of the markup annotation. (Optional; PDF 1.1)
Parameters:
Name Type Description
title string A string.
Inherited From:
Returns:
Type
Promise.<void>

setVertex(idx, pt)

sets the vertex(in Point object form) corresponding to the index within the Vertices array.
Parameters:
Name Type Description
idx number The index of the vertex.
pt PDFNet.Point A Point object corresponding to the vertex to be added to the array.
Inherited From:
Returns:
Type
Promise.<void>