- 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
DocumentDestinations
DsPdfJS API / DocumentDestinations
Class: DocumentDestinations
The dictionary of document destinations, provides an access to all destinations in the document:
Extends
PdfStringMap<DocDestination>
Accessors
count
Get Signature
get count():
number
Gets the number of items in the map.
Returns
number
Overrides
PdfStringMap.count
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
PdfStringMap.id
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
PdfStringMap.om
Methods
add()
add(
key,item):void
Adds the item with the specified key.
Parameters
key
string
The item key.
item
The item to add.
DocDestination | DocDestinationProperties
Returns
void
Overrides
PdfStringMap.add
clear()
clear():
void
Clears the collection.
Returns
void
Overrides
PdfStringMap.clear
contains()
contains(
key):boolean
Determines whether the specified key is in the collection.
Parameters
key
string
Returns
boolean
true if the key is in the collection, false otherwise.
Overrides
PdfStringMap.contains
free()
free():
void
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
PdfStringMap.free
get()
get(
key):DocDestination|undefined
Gets the item with the specified key.
Parameters
key
string
Returns
DocDestination | undefined
Overrides
PdfStringMap.get
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
PdfStringMap.rebind
remove()
remove(
key):boolean
Removes the item with specified key from the collection.
Parameters
key
string
The key to remove.
Returns
boolean
true if the item with specified key was actually removed, false otherwise.
Overrides
PdfStringMap.remove
set()
set(
key,item):void
Sets the item with the specified key.
Parameters
key
string
The item key.
item
The object to set.
DocDestination | DocDestinationProperties
Returns
void
Overrides
PdfStringMap.set