DsPdfJS API - v9.1.0
    Preparing search index...

    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.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    Methods

    Constructors

    • 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

        ObjectManager that controls the lifetime of the DestinationXYZ.

      • pageIndex: number

        The target page index.

      • Optionalleft: number

        The left coordinate of the document window.

      • OptionalpdfTop: number

        The top coordinate of the document window relative to the bottom of the page.

      • Optionalzoom: number

        The zoom factor of the document window.

      Returns 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.

      • Optionalleft: number

        The left coordinate of the document window.

      • OptionalpdfTop: number

        The top coordinate of the document window relative to the bottom of the page.

      • Optionalzoom: number

        The zoom factor of the document window.

      Returns DestinationXYZ

    • Initializes a new instance of the DestinationXYZ class.

      Parameters

      • om: ObjectManager

        ObjectManager that controls the lifetime of the DestinationXYZ.

      • page: PdfPage

        The target PdfPage.

      • Optionalleft: number

        The left coordinate of the document window.

      • Optionaltop: number

        The top coordinate of the document window relative to the top of the page.

      • Optionalzoom: number

        The zoom factor of the document window.

      Returns DestinationXYZ

    • Initializes a new instance of the DestinationXYZ class.

      Parameters

      • page: PdfPage

        The target PdfPage.

      • Optionalleft: number

        The left coordinate of the document window.

      • Optionaltop: number

        The top coordinate of the document window relative to the top of the page.

      • Optionalzoom: number

        The zoom factor of the document window.

      Returns DestinationXYZ

    Accessors

    • get id(): number

      Gets the reference to the object.

      Returns number

    • get left(): number | null

      Gets the left coordinate of the document window, if null then unchanged.

      Returns number | null

    • get page(): PdfPage | null

      Gets this destination's target PdfPage object. Returns null if the target page was specified by index.

      Returns PdfPage | null

    • 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

    • get pdfTop(): number | null

      Gets the top coordinate of the document window relative to the bottom left corner, unchanged if null.

      Returns number | null

    • 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

    • get zoom(): number | null

      Gets the zoom factor of the document window, unchanged if null or zero.

      Returns number | null

    Methods