@ironsoftware/ironpdf/src/public/annotation.js

IronPDF for Node

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.BookmarkDestinations = void 0;
/**
 * Destination type that controls how a PDF reader displays the target page when a
 * bookmark or internal hyperlink is followed.
 *
 * Mirrors {@code IronPdf.Bookmarks.BookmarkDestinations} on the C# side. The numeric
 * value of each entry is what the engine expects on the wire, so the order must match
 * the C# enum.
 *
 * Corresponds to the PDF 1.7 specification §12.3.2 "Explicit Destinations".
 */
var BookmarkDestinations;
(function (BookmarkDestinations) {
    /**
     * Fit the entire destination page within the window (PDF {@code /Fit}).
     * No additional coordinates are used.
     */
    BookmarkDestinations[BookmarkDestinations["Page"] = 0] = "Page";
    /**
     * Scroll to a specific Y coordinate on the destination page while fitting the
     * page width to the window (PDF {@code /FitH}).
     * Uses {@link LinkAnnotation.destinationTop}.
     */
    BookmarkDestinations[BookmarkDestinations["PageY"] = 1] = "PageY";
    /**
     * Scroll to a specific X coordinate on the destination page while fitting the
     * page height to the window (PDF {@code /FitV}).
     * Uses {@link LinkAnnotation.destinationLeft}.
     */
    BookmarkDestinations[BookmarkDestinations["PageX"] = 2] = "PageX";
    /**
     * Scroll to a specific position and zoom level (PDF {@code /XYZ}).
     * Uses {@link LinkAnnotation.destinationLeft}, {@link LinkAnnotation.destinationTop},
     * and {@link LinkAnnotation.destinationZoom}. A {@code destinationZoom} of 0 means
     * "inherit the current zoom".
     */
    BookmarkDestinations[BookmarkDestinations["PageZoom"] = 3] = "PageZoom";
    /**
     * Fit the specified rectangle of the destination page into the window (PDF {@code /FitR}).
     * Uses {@link LinkAnnotation.destinationLeft}, {@link LinkAnnotation.destinationBottom},
     * {@link LinkAnnotation.destinationRight}, and {@link LinkAnnotation.destinationTop}.
     */
    BookmarkDestinations[BookmarkDestinations["PageRect"] = 4] = "PageRect";
    /**
     * Fit the bounding box of the destination page into the window (PDF {@code /FitB}).
     */
    BookmarkDestinations[BookmarkDestinations["PageBounds"] = 5] = "PageBounds";
    /**
     * Scroll to a Y coordinate while fitting the bounding box width to the window
     * (PDF {@code /FitBH}). Uses {@link LinkAnnotation.destinationTop}.
     */
    BookmarkDestinations[BookmarkDestinations["PageBoundsY"] = 6] = "PageBoundsY";
    /**
     * Scroll to an X coordinate while fitting the bounding box height to the window
     * (PDF {@code /FitBV}). Uses {@link LinkAnnotation.destinationLeft}.
     */
    BookmarkDestinations[BookmarkDestinations["PageBoundsX"] = 7] = "PageBoundsX";
})(BookmarkDestinations = exports.BookmarkDestinations || (exports.BookmarkDestinations = {}));
//# sourceMappingURL=annotation.js.map