@syncfusion/ej2-pdf 1.0.22 → 23.1.36

package/src/pdf/core/pdf-file-structure.d.ts

@@ -0,0 +1,54 @@
+import { PdfCrossReferenceType } from './enumerator';
+/**
+ * `PdfFileStructure` class represents the internal structure of the PDF file.
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data, password);
+ * // Access the internal file structure of the PDF document
+ * let fileStructure: PdfFileStructure = document.fileStructure;
+ * // Set the cross reference type
+ * fileStructure.crossReferenceType = PdfCrossReferenceType.stream;
+ * // Save the document
+ * document.save('output.pdf');
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfFileStructure {
+    _crossReferenceType: PdfCrossReferenceType;
+    /**
+     * Gets the cross reference type of the PDF document.
+     *
+     * @returns {PdfCrossReferenceType} - Returns the cross reference type of the PDF document.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the internal file structure of the PDF document
+     * let fileStructure: PdfFileStructure = document.fileStructure;
+     * // Get the cross reference type
+     * let type: PdfCrossReferenceType = fileStructure.crossReferenceType;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the cross reference type of the PDF document.
+    *
+    * @param {PdfCrossReferenceType} value - Specifies the cross reference type of the PDF document.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Access the internal file structure of the PDF document
+    * let fileStructure: PdfFileStructure = document.fileStructure;
+    * // Set the cross reference type
+    * fileStructure.crossReferenceType = PdfCrossReferenceType.stream;
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    crossReferenceType: PdfCrossReferenceType;
+}

package/src/pdf/core/pdf-file-structure.js

@@ -0,0 +1,65 @@
+/**
+ * `PdfFileStructure` class represents the internal structure of the PDF file.
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data, password);
+ * // Access the internal file structure of the PDF document
+ * let fileStructure: PdfFileStructure = document.fileStructure;
+ * // Set the cross reference type
+ * fileStructure.crossReferenceType = PdfCrossReferenceType.stream;
+ * // Save the document
+ * document.save('output.pdf');
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+var PdfFileStructure = /** @class */ (function () {
+    function PdfFileStructure() {
+    }
+    Object.defineProperty(PdfFileStructure.prototype, "crossReferenceType", {
+        /**
+         * Gets the cross reference type of the PDF document.
+         *
+         * @returns {PdfCrossReferenceType} - Returns the cross reference type of the PDF document.
+         * ```typescript
+         * // Load an existing PDF document
+         * let document: PdfDocument = new PdfDocument(data, password);
+         * // Access the internal file structure of the PDF document
+         * let fileStructure: PdfFileStructure = document.fileStructure;
+         * // Get the cross reference type
+         * let type: PdfCrossReferenceType = fileStructure.crossReferenceType;
+         * // Save the document
+         * document.save('output.pdf');
+         * // Destroy the document
+         * document.destroy();
+         * ```
+         */
+        get: function () {
+            return this._crossReferenceType;
+        },
+        /**
+         * Sets the cross reference type of the PDF document.
+         *
+         * @param {PdfCrossReferenceType} value - Specifies the cross reference type of the PDF document.
+         * ```typescript
+         * // Load an existing PDF document
+         * let document: PdfDocument = new PdfDocument(data, password);
+         * // Access the internal file structure of the PDF document
+         * let fileStructure: PdfFileStructure = document.fileStructure;
+         * // Set the cross reference type
+         * fileStructure.crossReferenceType = PdfCrossReferenceType.stream;
+         * // Save the document
+         * document.save('output.pdf');
+         * // Destroy the document
+         * document.destroy();
+         * ```
+         */
+        set: function (value) {
+            this._crossReferenceType = value;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return PdfFileStructure;
+}());
+export { PdfFileStructure };

package/src/pdf/core/pdf-outline.d.ts

@@ -0,0 +1,362 @@
+import { PdfTextStyle } from './enumerator';
+import { _PdfCrossReference } from './pdf-cross-reference';
+import { PdfDestination } from './pdf-page';
+import { _PdfDictionary } from './pdf-primitives';
+/**
+ * Represents a base class for all bookmark objects.
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data, password);
+ * // Get bookmarks
+ * let bookmarks: PdfBookmarkBase = document.bookmarks;
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfBookmarkBase {
+    _dictionary: _PdfDictionary;
+    _crossReference: _PdfCrossReference;
+    _bookMarkList: PdfBookmark[];
+    _destination: PdfDestination;
+    _color: number[];
+    _isExpanded: boolean;
+    _namedDestination: PdfNamedDestination;
+    _namedDestinations: _PdfNamedDestinationCollection;
+    _title: string;
+    _textStyle: PdfTextStyle;
+    _isLoadedBookmark: boolean;
+    /**
+     * Initializes a new instance of the `PdfBookmarkBase` class.
+     *
+     * @private
+     * @param {_PdfDictionary} dictionary Outline dictionary.
+     * @param {_PdfCrossReference} crossReference Cross reference.
+     *
+     */
+    constructor(dictionary: _PdfDictionary, crossReference: _PdfCrossReference);
+    /**
+     * Gets the bookmark count (Read only).
+     *
+     * @returns {number} Number of bookmarks.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Get bookmark count
+     * let bookmarkCount: number = bookmarks.count;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly count: number;
+    /**
+     * Gets the `PdfBookmark` at the specified index.
+     *
+     * @param {number} index Bookmark index.
+     * @returns {PdfBookmark} Bookmark at the specified index.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Get bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    at(index: number): PdfBookmark;
+    /**
+     * Gets the boolean flag indicating whether `PdfBookmark` is present or not.
+     *
+     * @param {PdfBookmark} outline Bookmark.
+     * @returns {boolean} whether the bookmark is present or not.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Get the bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the boolean flag indicating whether `PdfBookmark` is present or not.
+     * let isPresent: boolean = bookmarks.contains(bookmark);
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    contains(outline: PdfBookmark): boolean;
+    _reproduceTree(): void;
+    _getFirstBookmark(bookmarkBase: PdfBookmarkBase): PdfBookmark;
+}
+/**
+ * Represents a bookmark in a PDF document
+ *
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data, password);
+ * // Get the bookmarks
+ * let bookmarks: PdfBookmarkBase = document.bookmarks;
+ * // Gets the bookmark at the specified index
+ * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfBookmark extends PdfBookmarkBase {
+    /**
+     * Initializes a new instance of the `PdfBookmark` class.
+     *
+     * @private
+     * @param {_PdfDictionary} dictionary Bookmark dictionary.
+     * @param {_PdfCrossReference} crossReference Cross reference.
+     *
+     */
+    constructor(dictionary: _PdfDictionary, crossReference: _PdfCrossReference);
+    /**
+     * Gets the destination (Read only).
+     *
+     * @returns {PdfDestination} Page destination.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets the bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the destination
+     * let destination: PdfDestination = bookmark.destination;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly destination: PdfDestination;
+    /**
+     * Gets the named destination (Read only).
+     *
+     * @returns {PdfNamedDestination} Named destination.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the named destination
+     * let namedDestination: PdfNamedDestination = bookmark.namedDestination;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly namedDestination: PdfNamedDestination;
+    /**
+     * Gets the bookmark title (Read only).
+     *
+     * @returns {string} Bookmark title.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the bookmark title
+     * let bookmarkTitle: string = bookmark.title;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly title: string;
+    /**
+     * Gets the bookmark color (Read only).
+     *
+     * @returns {number[]} Bookmark color.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the bookmark color
+     * let color: number[] = bookmark.color;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly color: number[];
+    /**
+     * Gets the textStyle (Read only).
+     *
+     * @returns {PdfTextStyle} Text style.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the textStyle
+     * let textStyle: PdfTextStyle = bookmark.textStyle;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly textStyle: PdfTextStyle;
+    /**
+     * Gets the boolean flag indicating whether the bookmark is expanded or not (Read only).
+     *
+     * @returns {boolean} whether the bookmark is expanded or not.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the boolean flag indicating whether the bookmark is expanded or not
+     * let isExpanded: boolean = bookmark.isExpanded;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly isExpanded: boolean;
+    readonly _next: PdfBookmark;
+    _obtainTextStyle(): PdfTextStyle;
+    _obtainTitle(): string;
+    _obtainNamedDestination(): PdfNamedDestination;
+    _obtainDestination(): PdfDestination;
+}
+/**
+ * Represents a named destination in a PDF document.
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data, password);
+ * // Get the bookmarks
+ * let bookmarks: PdfBookmarkBase = document.bookmarks;
+ * // Gets the bookmark at the specified index
+ * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+ * // Gets the named destination
+ * let namedDestination: PdfNamedDestination = bookmark.namedDestination;
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfNamedDestination {
+    _destination: PdfDestination;
+    _title: string;
+    _dictionary: _PdfDictionary;
+    _crossReference: _PdfCrossReference;
+    /**
+     * Initializes a new instance of the `PdfNamedDestination` class.
+     *
+     * @private
+     * @param {_PdfDictionary} dictionary Destination dictionary.
+     * @param {_PdfCrossReference} crossReference Cross reference.
+     *
+     */
+    constructor(dictionary: _PdfDictionary, crossReference: _PdfCrossReference);
+    /**
+     * Gets the destination.
+     *
+     * @returns {PdfDestination} Page destination.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets the bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the named destination
+     * let namedDestination: PdfNamedDestination = bookmark.namedDestination;
+     * // Gets the destination
+     * let destination: PdfDestination = namedDestination.destination;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the destination.
+    *
+    * @param {PdfDestination} value destination.
+    *
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Get the bookmarks
+    * let bookmarks: PdfBookmarkBase = document.bookmarks;
+    * // Gets the bookmark at the specified index
+    * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+    * // Gets the named destination
+    * let namedDestination: PdfNamedDestination = bookmark.namedDestination;
+    * // Set the destination
+    * namedDestination.destination = new PdfDestination(page, [100, 200]);
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    destination: PdfDestination;
+    /**
+     * Gets the title.
+     *
+     * @returns {string} title.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Gets the bookmark at the specified index
+     * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+     * // Gets the named destination
+     * let namedDestination: PdfNamedDestination = bookmark.namedDestination;
+     * // Gets the title
+     * let title: string = namedDestination.title;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the title.
+    *
+    * @param {string} value title.
+    *
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Get the bookmarks
+    * let bookmarks: PdfBookmarkBase = document.bookmarks;
+    * // Gets the bookmark at the specified index
+    * let bookmark: PdfBookmark = bookmarks.at(0) as PdfBookmark;
+    * // Gets the named destination
+    * let namedDestination: PdfNamedDestination = bookmark.namedDestination;
+    * // Set the title
+    * namedDestination.title = 'Syncfusion';
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    title: string;
+}
+export declare class _PdfNamedDestinationCollection {
+    _dictionary: _PdfDictionary;
+    _crossReference: _PdfCrossReference;
+    _namedDestinations: PdfNamedDestination[];
+    constructor();
+    constructor(dictionary: _PdfDictionary, crossReference: _PdfCrossReference);
+    _addCollection(destination: _PdfDictionary): void;
+}