-
Classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionHide
- ActionImportData
- ActionJavaScript
- ActionJavaScriptMap
- ActionLaunch
- ActionLaunchWinAttrs
- ActionNamed
- ActionResetForm
- ActionSound
- ActionSubmitForm
- ActionUnknown
- ActionUri
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- AppearanceStream
- AppearanceStreams
- AssociatedFiles
- Attr
- AttrClsRevision
- AttrClsRevisionCollection
- AttrCollection
- AttrRevision
- AttrRevisionCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ClassMap
- ComboBoxField
- CombTextField
- ContentItemLink
- ContentItemLinkCollection
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBh
- DestinationFitBv
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXyz
- DocAction
- DocumentDestinations
- DocumentInfo
- DocumentSecurityStore
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileInfo
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FormXObject
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- IccProfile
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkInfo
- MarkupAnnotation
- McidContentItemLink
- McrContentItemLink
- Metadata
- Model3DAnnotation
- Model3DStream
- Model3DView
- Model3DViewCollection
- Namespace
- NamespaceCollection
- ObjectBase
- ObjectManager
- ObjrContentItemLink
- OutlineNode
- OutlineNodeCollection
- OutputIntent
- OutputIntentCollection
- PageLabelingRange
- PageLabelingRangeMap
- PdfCidFont
- PdfCidFontType0
- PdfCidFontType2
- PdfCidFontUnknown
- PdfCMapTable
- PdfContext
- PdfDocument
- PdfFont
- PdfFontDescriptor
- PdfFontSimple
- PdfFontTrueType
- PdfFontType0
- PdfFontType1
- PdfFontType3
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- PdfSignature
- Pen
- Pkcs7Signer
- Pkcs7SignerBase
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RContentItemLink
- RedactAnnotation
- RichMediaAnnotation
- RoleMap
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- StructElement
- StructElementCollection
- StructTreeItem
- StructTreeItemCollection
- StructTreeRoot
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- TimeStamper
- TimeStampProvider
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- Enumerations
- Functions
- Interfaces
- README
- Index
- TypeAliases
- Variables
Pen
Class: Pen
Represents a pen used to draw lines and contours.
Extends
Constructors
Constructor
new Pen(penProperties): Pen;
Creates a new Pen based on properties of an existing Pen.
Parameters
penProperties
The settings overriding properties of the base Pen.
Returns
Pen
Overrides
ObjectBase.constructor
Constructor
new Pen(basePen, penProperties): Pen;
Creates a new Pen based on properties of an existing Pen.
Parameters
basePen
Pen
The Pen used as the base for the new Pen.
penProperties
The settings overriding properties of the base Pen.
Returns
Pen
Overrides
ObjectBase.constructor
Constructor
new Pen(om, penProperties): Pen;
Creates a new Pen object with specified properties.
Parameters
om
An object manager that controls the lifetime of the Pen object.
penProperties
The settings for creating a Pen.
Returns
Pen
Overrides
ObjectBase.constructor
Accessors
color
Get Signature
get color(): Color;
Gets the pen color.
Returns
dashOffset
Get Signature
get dashOffset(): number;
Gets the distance within the dash pattern where a dash begins.
Returns
number
dashPattern
Get Signature
get dashPattern(): number[];
Gets the custom dash pattern of lines drawn with this pen.
Returns
number[]
dashStyle
Get Signature
get dashStyle(): DashStyle;
Gets the style of dashed lines drawn with this pen.
Returns
id
Get Signature
get id(): number;
Gets the reference to the object.
Returns
number
Inherited from
lineCap
Get Signature
get lineCap(): PenLineCap;
Gets the line cap style that specifies the shape used at the ends of open subpaths (and dashes, if any) when they are stroked.
Returns
lineJoin
Get Signature
get lineJoin(): PenLineJoin;
Gets the line join style that specifies the shape used at the corners of paths that are stroked.
Returns
miterLimit
Get Signature
get miterLimit(): number;
Gets a maximum on the ratio of the miter length to the pen width. When the limit is exceeded, the join is converted from a miter to a bevel.
Returns
number
om
Get Signature
get om(): ObjectManager;
Gets the owner ObjectManager instance.
Returns
Inherited from
width
Get Signature
get width(): number;
Gets the pen width, in units used for drawing.
Returns
number
Methods
free()
free(): void;
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(omTo): void;
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void