|
FoxitPDFSDKforWeb
7.1.1
Foxit PDF SDK for Web
|
Public Member Functions | |
| enableCaption (enable) | |
| Toggle line's caption. More... | |
| exportToJSON () | |
| Export annotation to a json object. Override Markup::exportToJSON. More... | |
| getEndingStyle () | |
| Get line ending style. More... | |
| getEndPoint () | |
| Get line end point. More... | |
| getLeaderLineExtend () | |
| Get line's leader line extend length. More... | |
| getLeaderLineLength () | |
| Get line's leader line length. More... | |
| getLeaderLinePoints () | |
| Get leader line points. More... | |
| getStartPoint () | |
| Get line start point. More... | |
| getStartStyle () | |
| Get callout line start style. More... | |
| getStyleFillColor () | |
| Get free text's fill color. More... | |
| hasCaption () | |
| Check line has caption or not. More... | |
| setEndingStyle (isBeginning, endingStyle) | |
| Set line terminal style. More... | |
| setEndPoint (point) | |
| Set line end point. More... | |
| setLeaderLineLength (length) | |
| Set line's leader line length. More... | |
| setStartPoint (point) | |
| Set line start point. More... | |
| setStyleFillColor (styleFillColor) | |
| Set annotation's fill color. More... | |
Public Member Functions inherited from Markup | |
| addMarkedState (stateName) | |
| Add marked state with specific name. More... | |
| addReply (content) | |
| Add a new reply to the end of reply list. More... | |
| addReviewState (stateName) | |
| Add review state with specific name. More... | |
| exportToJSON () | |
| Export annotation to a json object. Override Annot::exportToJSON. More... | |
| getCreateDateTime () | |
| Get creation date time. More... | |
| getGroupElements () | |
| Get the group annotations which own current annotation. More... | |
| getGroupHeader () | |
| Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More... | |
| getIntent () | |
| Get intent name. Following annotation types have predefined intent name: More... | |
| getMarkedState (index) | |
| Get a state annotation by index. state model is marked. More... | |
| getMarkedStateCount () | |
| Get the count of state annotations. More... | |
| getMarkedStates () | |
| Get all state annotation. state model is marked. More... | |
| getOpacity () | |
| Get opacity value. This property has effect on markup annotation's appearance. More... | |
| getPopup () | |
| Get annotation's popup. More... | |
| getReplies () | |
| Get all replies. More... | |
| getReply (index) | |
| Get a reply annot by index. More... | |
| getReplyCount () | |
| Count all replies. More... | |
| getReviewState (index) | |
| Get a state annotation by index. state model is review. More... | |
| getReviewStateCount () | |
| Get the count of state annotations. When state model is review, the markup annotation can have several state annotations in a chain: first state annotation refers to the markup annotation, second state annotation refers to the first state annotation, etc. Just like this: markup annotation <– reviewed state1 <– reviewed state2 ... More... | |
| getReviewStates () | |
| Get all state annotation. state model is review. More... | |
| getSubject () | |
| Get subject string. More... | |
| getTitle () | |
| Get title string. More... | |
| isGrouped () | |
| Check whether current markup annotation is in a group or not. More... | |
| isGroupHeader () | |
| Check whether current markup annotation is a group header annotation. More... | |
| removeAllStateAnnots () | |
| Remove all sate from this markup annotation. More... | |
| setContent (content) | |
| Set markup annotation's contents. More... | |
| setCreateDateTime (date) | |
| Set creation date time. More... | |
| setIntent (intent) | |
| Set annotaions's intent. More... | |
| setOpacity (opacity) | |
| Set opacity value. More... | |
| setSubject (subject) | |
| Set subject string. More... | |
| setTitle (title) | |
| Set title string. More... | |
Public Member Functions inherited from Annot | |
| exportToJSON () | |
| Export annotation to a json object. More... | |
| getBorderColor () | |
| Get annotation's border color. More... | |
| getBorderInfo () | |
| Get annotation's border information. More... | |
| getContent () | |
| Get annotation's contents. More... | |
| getFlags () | |
| Get annotation's flag. More... | |
| getModifiedDateTime () | |
| Get annotation's last modified date time. More... | |
| getPage () | |
| Get annotation's page. More... | |
| getRect () | |
| Get annotation's rect. More... | |
| getTitle () | |
| Get annotation's title. More... | |
| getType () | |
| Get annotation's type. More... | |
| getUniqueID () | |
| Get annotation's unique ID. More... | |
| isEmpty () | |
| Check annotation is empty or not. More... | |
| isMarkup () | |
| Check if current annotation is a markup annotation. More... | |
| setBorderColor (borderColor) | |
| Set annotation's border color. More... | |
| setBorderInfo (borderInfo) | |
| Set annotation's border information. More... | |
| setContent (content) | |
| Set annotation's contents. More... | |
| setFlags (flag) | |
| Set annotation's flag. More... | |
| setModifiedDateTime (date) | |
| Set annotation's last modified date time. More... | |
Line annot object.
|
inline |
Toggle line's caption.
| enable | {bool} - True to show caption, false to hide. |
|
inline |
Export annotation to a json object. Override Markup::exportToJSON.
|
inline |
Get line ending style.
|
inline |
Get line end point.
|
inline |
Get line's leader line extend length.
|
inline |
Get line's leader line length.
|
inline |
Get leader line points.
|
inline |
Get line start point.
|
inline |
Get callout line start style.
|
inline |
Get free text's fill color.
|
inline |
Check line has caption or not.
|
inline |
Set line terminal style.
| isBeginning | {bool} - Indecated start point or end point. |
| endingStyle | {number} - An interge value indecates ending style, one of: 0 for 'None' 1 for 'Square' 2 for 'Circle' 3 for 'Diamond' 4 for 'OpenArrow' 5 for 'ClosedArrow' 6 for 'Butt' 7 for 'ReverseOpenArrow' 8 for 'ReverseClosedArrow' 9 for 'Slash' |
|
inline |
Set line end point.
| point | {{x:{number},y:{number}}} - Line end point. |
|
inline |
Set line's leader line length.
| length | {number} - An interge indecated leader line length. |
|
inline |
Set line start point.
| point | {object} - Line start point. { x:{number}, y:{number} } |
|
inline |
Set annotation's fill color.
| styleFillColor | {number} - An interge indecated fill color. |