- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
Image
DsPdfJS API / Image
Class: Image
Represents a JPEG or PNG image instance.
Extends
Accessors
height
Get Signature
get height():
number
Gets the height of the image, in pixels.
Returns
number
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
opaque
Get Signature
get opaque():
boolean
Gets the value indicating if the image is opaque.
Returns
boolean
type
Get Signature
get type():
ImageType
Gets the type of the image, such as JPEG or PNG.
Returns
width
Get Signature
get width():
number
Gets the width of the image, in pixels.
Returns
number
Methods
load()
Call Signature
staticload(imageBytes):Image
Creates an Image from the byte array with JPEG or PNG encoded image data.
Parameters
imageBytes
Uint8Array
The binary data of the image.
Returns
Image
A new instance of the Image.
Call Signature
staticload(om,imageBytes):Image
Creates an Image from the byte array with JPEG or PNG encoded image data.
Parameters
om
An object manager that controls the lifetime of the Image object.
imageBytes
Uint8Array
The binary data of the image.
Returns
Image
A new instance of the Image.
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
Inherited from
save()
save():
Uint8Array
Saves the Image as a byte array with PNG or JPEG-encoded image data.
Returns
Uint8Array
A byte array with image data.
toBitmap()
toBitmap():
Bitmap
Creates a Bitmap instance from the current Image.
Returns
A new instance of Bitmap with image data.