- 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
DestinationXYZ
DsPdfJS API / DestinationXYZ
Class: DestinationXYZ
Display the page designated by Destination#page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value.
Extends
Constructors
Constructor
new DestinationXYZ(
om,pageIndex,left?,pdfTop?,zoom?):DestinationXYZ
Initializes a new instance of the DestinationXYZ class.
Note that all Y coordinates should be specified relative to the bottom of the page.
Parameters
om
ObjectManager that controls the lifetime of the DestinationXYZ.
pageIndex
number
The target page index.
left?
number
The left coordinate of the document window.
pdfTop?
number
The top coordinate of the document window relative to the bottom of the page.
zoom?
number
The zoom factor of the document window.
Returns
DestinationXYZ
Overrides
Destination.constructor
Constructor
new DestinationXYZ(
pageIndex,left?,pdfTop?,zoom?):DestinationXYZ
Initializes a new instance of the DestinationXYZ class.
Note that all Y coordinates should be specified relative to the bottom of the page.
Parameters
pageIndex
number
The target page index.
left?
number
The left coordinate of the document window.
pdfTop?
number
The top coordinate of the document window relative to the bottom of the page.
zoom?
number
The zoom factor of the document window.
Returns
DestinationXYZ
Overrides
Destination.constructor
Constructor
new DestinationXYZ(
om,page,left?,top?,zoom?):DestinationXYZ
Initializes a new instance of the DestinationXYZ class.
Parameters
om
ObjectManager that controls the lifetime of the DestinationXYZ.
page
The target PdfPage.
left?
number
The left coordinate of the document window.
top?
number
The top coordinate of the document window relative to the top of the page.
zoom?
number
The zoom factor of the document window.
Returns
DestinationXYZ
Overrides
Destination.constructor
Constructor
new DestinationXYZ(
page,left?,top?,zoom?):DestinationXYZ
Initializes a new instance of the DestinationXYZ class.
Parameters
page
The target PdfPage.
left?
number
The left coordinate of the document window.
top?
number
The top coordinate of the document window relative to the top of the page.
zoom?
number
The zoom factor of the document window.
Returns
DestinationXYZ
Overrides
Destination.constructor
Accessors
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
left
Get Signature
get left():
number|null
Gets the left coordinate of the document window, if null then unchanged.
Returns
number | null
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
zoom
Get Signature
get zoom():
number|null
Gets the zoom factor of the document window, unchanged if null or zero.
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