- 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
DestinationFitBH
DsPdfJS API / DestinationFitBH
Class: DestinationFitBH
Display the page designated by Destination#page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged.
Extends
Constructors
Constructor
new DestinationFitBH(
om,pageIndex,pdfTop?):DestinationFitBH
Initializes a new instance of the DestinationFitBH class.
Parameters
om
ObjectManager that controls the lifetime of the DestinationFitBH.
pageIndex
number
The target page index.
pdfTop?
number
The top coordinate of the document window relative to the bottom of the page.
Returns
DestinationFitBH
Overrides
Destination.constructor
Constructor
new DestinationFitBH(
pageIndex,pdfTop?):DestinationFitBH
Initializes a new instance of the DestinationFitBH class.
Parameters
pageIndex
number
The target page index.
pdfTop?
number
The top coordinate of the document window relative to the bottom of the page.
Returns
DestinationFitBH
Overrides
Destination.constructor
Constructor
new DestinationFitBH(
om,page,top?):DestinationFitBH
Initializes a new instance of the DestinationFitBH class.
Parameters
om
ObjectManager that controls the lifetime of the DestinationFitBH.
page
The target PdfPage.
top?
number
The top coordinate of the document window relative to the top of the page.
Returns
DestinationFitBH
Overrides
Destination.constructor
Constructor
new DestinationFitBH(
page,top?):DestinationFitBH
Initializes a new instance of the DestinationFitBH class.
Parameters
page
The target PdfPage.
top?
number
The top coordinate of the document window relative to the top of the page.
Returns
DestinationFitBH
Overrides
Destination.constructor
Accessors
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
page
Get Signature
get page():
PdfPage|null
Gets this destination's target PdfPage object. Returns null if the target page was specified by index.
Returns
PdfPage | null
Inherited from
pageIndex
Get Signature
get pageIndex():
number|null
Gets the index of this destination's target page. Returns null if the target page was specified as a PdfPage object.
Note that if this property is not null, then any Y coordinate is relative to the bottom left corner (see Destination description for details).
Returns
number | null
Inherited from
pdfTop
Get Signature
get pdfTop():
number|null
Gets the top coordinate of the document window relative to the bottom left corner, unchanged if null.
Returns
number | null
top
Get Signature
get top():
number|null
Gets the top coordinate of the document window, if null then unchanged.
If the target page of this destination was specified as an index (Destination#pageIndex), then this property returns the Y coordinate relative to the page bottom. If the target page was specified as a page object (see Destination#page), then this property returns the Y coordinate relative to the page top. See Destination description for details.
Returns
number | null
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