- 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
PdfImageHandlerCollection
DsPdfJS API / PdfImageHandlerCollection
Class: PdfImageHandlerCollection
Represents a collection of PdfImageHandler objects.
Extends
PdfKeyedObjectCollection<Image,PdfImageHandler>
Accessors
count
Get Signature
get count():
number
Gets the number of items in the map.
Returns
number
Overrides
PdfKeyedObjectCollection.count
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
PdfKeyedObjectCollection.id
last
Get Signature
get last():
TItem|null
Gets last item in the collection.
Returns
TItem | null
Inherited from
PdfKeyedObjectCollection.last
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
PdfKeyedObjectCollection.om
Methods
add()
add(
item):void
Adds an item to the end of the collection.
Parameters
item
The item to add.
Returns
void
Inherited from
PdfKeyedObjectCollection.add
clear()
clear():
void
Clears the collection.
Returns
void
Overrides
PdfKeyedObjectCollection.clear
contains()
contains(
item):boolean
Determines whether the item is in the collection.
Parameters
item
Returns
boolean
true if the item is in the collection, false otherwise.
Overrides
PdfKeyedObjectCollection.contains
containsKey()
containsKey(
key):boolean
Determines whether the item with specified key exists in the collection.
Parameters
key
Returns
boolean
true if the item with the specified key exists in the collection, false otherwise.
Overrides
PdfKeyedObjectCollection.containsKey
free()
free():
void
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
PdfKeyedObjectCollection.free
get()
get(
key):PdfImageHandler|undefined
Gets the item with the specified key.
Parameters
key
Returns
PdfImageHandler | undefined
Overrides
PdfKeyedObjectCollection.get
getAt()
getAt(
index):PdfImageHandler
Gets the item with the specified index.
Parameters
index
number
The index of the item.
Returns
Overrides
PdfKeyedObjectCollection.getAt
getImageHandler()
getImageHandler(
image):PdfImageHandler
Gets an existing PdfImageHandler associated with a specified Image, or creates a new one if such image does not exist.
Parameters
image
The image
Returns
The existing or newly created PdfImageHandler.
insert()
insert(
index,item):void
Inserts an item at a specific position in the collection.
Parameters
index
number
The position where the item will be inserted.
item
The item to insert.
Returns
void
Overrides
PdfKeyedObjectCollection.insert
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
PdfKeyedObjectCollection.rebind
remove()
remove(
item):boolean
Removes the specified item from the collection.
Parameters
item
The item to remove.
Returns
boolean
true if the item was actually removed, false otherwise.
Overrides
PdfKeyedObjectCollection.remove
removeAt()
removeAt(
index):void
Removes the item at specified index.
Parameters
index
number
The index of the item to remove.
Returns
void
Overrides
PdfKeyedObjectCollection.removeAt
removeByKey()
removeByKey(
key):boolean
Removes the item with specified key from the collection.
Parameters
key
The key to remove.
Returns
boolean
true if the item with specified key was actually removed, false otherwise.
Overrides
PdfKeyedObjectCollection.removeByKey
setAt()
setAt(
index,item):void
Sets the item at the specified index.
Parameters
index
number
The index of the item, starting from 0.
item
The object to set.
Returns
void
Overrides
PdfKeyedObjectCollection.setAt