@syncfusion/ej2-pdf-export 23.2.4 → 24.1.41

package/dist/ts/implementation/graphics/fonts/enum.ts

@@ -0,0 +1,385 @@
+/**
+ * public Enum for `PdfFontStyle`.
+ * @private
+ */
+export enum PdfFontStyle {
+    /**
+     * Specifies the type of `Regular`.
+     * @private
+     */
+    Regular = 0,
+    /**
+     * Specifies the type of `Bold`.
+     * @private
+     */
+    Bold = 1,
+    /**
+     * Specifies the type of `Italic`.
+     * @private
+     */
+    Italic = 2,
+    /**
+     * Specifies the type of `Underline`.
+     * @private
+     */
+    Underline = 4,
+    /**
+     * Specifies the type of `Strikeout`.
+     * @private
+     */
+    Strikeout = 8
+}
+/**
+ * Specifies the font family from the standard font.
+ * ```typescript
+ * // create a new PDF document
+ * let document : PdfDocument = new PdfDocument();
+ * // add a new page to the document
+ * let page1 : PdfPage = document.pages.add();
+ * // create new standard font
+ * let font : PdfStandardFont = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
+ * // create black brush
+ * let blackBrush : PdfSolidBrush = new PdfSolidBrush(new PdfColor(0, 0, 0));
+ * // draw the text
+ * page1.graphics.drawString('Hello World', font, blackBrush, new PointF(0, 0));
+ * // save the document
+ * document.save('output.pdf');
+ * ```
+ */
+export enum PdfFontFamily {
+    /**
+     * Specifies the `Helvetica` font.
+     */
+    Helvetica,
+    /**
+     * Specifies the `Courier` font.
+     */
+    Courier,
+    /**
+     * Specifies the `TimesRoman` font.
+     */
+    TimesRoman,
+    /**
+     * Specifies the `Symbol` font.
+     */
+    Symbol,
+    /**
+     * Specifies the `ZapfDingbats` font.
+     */
+    ZapfDingbats,
+}
+/**
+ * public Enum for `PdfFontType`.
+ * @private
+ */
+export enum PdfFontType {
+    /**
+     * Specifies the type of `Standard`.
+     * @private
+     */
+    Standard,
+    /**
+     * Specifies the type of `TrueType`.
+     * @private
+     */
+    TrueType,
+    /**
+     * Specifies the type of `TrueTypeEmbedded`.
+     * @private
+     */
+    TrueTypeEmbedded
+}
+/**
+ * public Enum for `PdfWordWrapType`.
+ * @private
+ */
+export enum PdfWordWrapType {
+    /**
+     * Specifies the type of `None`.
+     * @private
+     */
+    None,
+    /**
+     * Specifies the type of `Word`.
+     * @private
+     */
+    Word,
+    /**
+     * Specifies the type of `WordOnly`.
+     * @private
+     */
+    WordOnly,
+    /**
+     * Specifies the type of `Character`.
+     * @private
+     */
+    Character
+}
+/**
+ * public Enum for `PdfSubSuperScript`.
+ * @private
+ */
+export enum PdfSubSuperScript {
+    /**
+     * Specifies the type of `None`.
+     * @private
+     */
+    None = 0,
+    /**
+     * Specifies the type of `SuperScript`.
+     * @private
+     */
+    SuperScript = 1,
+    /**
+     * Specifies the type of `SubScript`.
+     * @private
+     */
+    SubScript = 2
+}
+/**
+ * public Enum for `FontEncoding`.
+ * @private
+ */
+export enum FontEncoding {
+    /**
+     * Specifies the type of `Unknown`.
+     * @private
+     */
+    Unknown = 0,
+    /**
+     * Specifies the type of `StandardEncoding`.
+     * @private
+     */
+    StandardEncoding,
+    /**
+     * Specifies the type of `MacRomanEncoding`.
+     * @private
+     */
+    MacRomanEncoding,
+    /**
+     * Specifies the type of `MacExpertEncoding`.
+     * @private
+     */
+    MacExpertEncoding,
+    /**
+     * Specifies the type of `WinAnsiEncoding`.
+     * @private
+     */
+    WinAnsiEncoding,
+    /**
+     * Specifies the type of `PdfDocEncoding`.
+     * @private
+     */
+    PdfDocEncoding,
+    /**
+     * Specifies the type of `IdentityH`.
+     * @private
+     */
+    IdentityH
+}
+/**
+ * public Enum for `TtfCmapFormat`.
+ * @private
+ */
+export enum TtfCmapFormat {
+    /**
+     * This is the Apple standard character to glyph index mapping table.
+     * @private
+     */
+    Apple = 0,
+    /**
+     * This is the Microsoft standard character to glyph index mapping table.
+     * @private
+     */
+    Microsoft = 4,
+    /**
+     * Format 6: Trimmed table mapping.
+     * @private
+     */
+    Trimmed = 6
+}
+/**
+ * Enumerator that implements CMAP encodings.
+ * @private
+ */
+export enum TtfCmapEncoding {
+    /**
+     * Unknown encoding.
+     * @private
+     */
+    Unknown = 0,
+    /**
+     * When building a symbol font for Windows.
+     * @private
+     */
+    Symbol = 1,
+    /**
+     * When building a Unicode font for Windows.
+     * @private
+     */
+    Unicode = 2,
+    /**
+     * For font that will be used on a Macintosh.
+     * @private
+     */
+    Macintosh = 3
+}
+/**
+ * Ttf platform ID.
+ * @private
+ */
+export enum TtfPlatformID {
+    /**
+     * Apple platform.
+     * @private
+     */
+    AppleUnicode = 0,
+    /**
+     * Macintosh platform.
+     * @private
+     */
+    Macintosh = 1,
+    /**
+     * Iso platform.
+     * @private
+     */
+    Iso = 2,
+    /**
+     * Microsoft platform.
+     * @private
+     */
+    Microsoft = 3
+}
+/**
+ * Microsoft encoding ID.
+ * @private
+ */
+export enum TtfMicrosoftEncodingID {
+    /**
+     * Undefined encoding.
+     * @private
+     */
+    Undefined = 0,
+    /**
+     * Unicode encoding.
+     * @private
+     */
+    Unicode = 1,
+}
+/**
+ * Macintosh encoding ID.
+ * @private
+ */
+export enum TtfMacintoshEncodingID {
+    /**
+     * Roman encoding.
+     * @private
+     */
+    Roman = 0,
+    /**
+     * Japanese encoding.
+     * @private
+     */
+    Japanese = 1,
+    /**
+     * Chinese encoding.
+     * @private
+     */
+    Chinese = 2
+}
+/**
+ * Enumerator that implements font descriptor flags.
+ * @private
+ */
+export enum FontDescriptorFlags {
+    /**
+     * All glyphs have the same width (as opposed to proportional or variable-pitch fonts, which have different widths). 
+     * @private
+     */
+    FixedPitch = 1,
+    /**
+     * Glyphs have serifs, which are short strokes drawn at an angle on the top and
+     * bottom of glyph stems (as opposed to sans serif fonts, which do not).
+     * @private
+     */
+    Serif = 2,
+    /**
+     * Font contains glyphs outside the Adobe standard Latin character set. The
+     * flag and the nonsymbolic flag cannot both be set or both be clear.
+     * @private
+     */
+    Symbolic = 4,
+    /**
+     * Glyphs resemble cursive handwriting.
+     * @private
+     */
+    Script = 8,
+    /**
+     * Font uses the Adobe standard Latin character set or a subset of it.
+     * @private
+     */
+    Nonsymbolic = 32,
+    /**
+     * Glyphs have dominant vertical strokes that are slanted.
+     * @private
+     */
+    Italic = 64,
+    /**
+     * Bold font.
+     * @private
+     */
+    ForceBold = 0x40000,
+}
+/**
+ * true type font composite glyph flags.
+ * @private
+ */
+export enum TtfCompositeGlyphFlags {
+    /**
+     * The Arg1And2AreWords.
+     * @private
+     */
+    Arg1And2AreWords = 0x0001,
+    /**
+     * The ArgsAreXyValues.
+     * @private
+     */
+    ArgsAreXyValues = 0x0002,
+    /**
+     * The RoundXyToGrid.
+     * @private
+     */
+    RoundXyToGrid = 0x0004,
+    /**
+     * The WeHaveScale.
+     * @private
+     */
+    WeHaveScale = 0x0008,
+    /**
+     * The Reserved.
+     * @private
+     */
+    Reserved = 0x0010,
+    /**
+     * The MoreComponents.
+     * @private
+     */
+    MoreComponents = 0x0020,
+    /**
+     * The WeHaveAnXyScale.
+     * @private
+     */
+    WeHaveAnXyScale = 0x0040,
+    /**
+     * The WeHaveTwoByTwo
+     */
+    WeHaveTwoByTwo = 0x0080,
+    /**
+     * The WeHaveInstructions.
+     */
+    WeHaveInstructions = 0x0100,
+    /**
+     * The UseMyMetrics.
+     */
+    UseMyMetrics = 0x0200,
+}

package/dist/ts/implementation/graphics/fonts/pdf-font-metrics.ts

@@ -0,0 +1,248 @@
+/**
+ * PdfFontMetrics.ts class for EJ2-PDF
+ */
+import { PdfStringFormat } from './pdf-string-format';
+import { PdfFont } from './pdf-font';
+import { PdfSubSuperScript } from './enum';
+import { PdfArray } from './../../primitives/pdf-array';
+/**
+ * `Metrics` of the font.
+ * @private
+ */
+export class PdfFontMetrics {
+    //  Fields
+    /**
+     * Gets `ascent` of the font.
+     * @private
+     */
+    public ascent : number;
+    /**
+     * Gets `descent` of the font.
+     * @private
+     */
+    public descent : number;
+    /**
+     * `Name` of the font.
+     * @private
+     */
+    public name : string;
+    /**
+     * Gets `PostScript` Name of the  font.
+     * @private
+     */
+    public postScriptName : string;
+    /**
+     * Gets `size` of the font.
+     * @private
+     */
+    public size : number;
+    /**
+     * Gets `height` of the font.
+     * @private
+     */
+    public height : number;
+    /**
+     * `First char` of the font.
+     * @private
+     */
+    public firstChar : number;
+    /**
+     * `Last char` of the font.
+     * @private
+     */
+    public lastChar : number;
+    /**
+     * `Line gap`.
+     * @private
+     */
+    public lineGap : number = 0;
+    /**
+     * `Subscript` size factor.
+     * @private
+     */
+    public subScriptSizeFactor : number;
+    /**
+     * `Superscript` size factor.
+     * @private
+     */
+    public superscriptSizeFactor : number;
+    /**
+     * Gets `table` of glyphs` width.
+     * @private
+     */
+    public internalWidthTable : WidthTable;
+    /**
+     * Checks whether is it `unicode font` or not.
+     * @private
+     */
+    public isUnicodeFont : boolean;
+    /**
+     * Indicate whether the true type font reader font has bold style.
+     */
+    public isBold : boolean;
+    //  Public methods
+    /**
+     * Returns `ascent` taking into consideration font`s size.
+     * @private
+     */
+    public getAscent(format : PdfStringFormat) : number {
+        let returnValue : number = this.ascent * PdfFont.charSizeMultiplier * this.getSize(format);
+        return returnValue;
+    }
+    /**
+     * Returns `descent` taking into consideration font`s size.
+     * @private
+     */
+    public getDescent(format : PdfStringFormat) : number {
+        let returnValue : number = this.descent * PdfFont.charSizeMultiplier * this.getSize(format);
+        return returnValue;
+    }
+    /**
+     * Returns `Line gap` taking into consideration font`s size.
+     * @private
+     */
+    public getLineGap(format : PdfStringFormat) : number {
+        let returnValue : number = this.lineGap * PdfFont.charSizeMultiplier * this.getSize(format);
+        return returnValue;
+    }
+    /**
+     * Returns `height` taking into consideration font`s size.
+     * @private
+     */
+    public getHeight(format : PdfStringFormat) : number {
+        let height : number;
+        let clearTypeFonts : string[] = [ 'cambria', 'candara', 'constantia', 'corbel', 'cariadings' ];
+        let clearTypeFontCollection : string[] = [];
+        for (let index : number  = 0; index < clearTypeFonts.length; index++) {
+            let font : string = clearTypeFonts[index];
+            clearTypeFontCollection.push(font);
+        }
+        if (this.getDescent(format) < 0) {
+            // if ((clearTypeFontCollection.indexOf(this.name.toLowerCase()) !== -1) && !this.isUnicodeFont) {
+            //     height = (this.GetAscent(format) - this.GetDescent(format) - this.GetLineGap(format));
+            // } else {
+                height = (this.getAscent(format) - this.getDescent(format) + this.getLineGap(format));
+            // }
+        } else {
+            height = (this.getAscent(format) + this.getDescent(format) + this.getLineGap(format));
+        }
+        return height;
+    }
+    /**
+     * Calculates `size` of the font depending on the subscript/superscript value.
+     * @private
+     */
+    public getSize(format : PdfStringFormat) : number {
+        let size : number = this.size;
+        if (format != null) {
+            switch (format.subSuperScript) {
+                case PdfSubSuperScript.SubScript:
+                    size /= this.subScriptSizeFactor;
+                    break;
+
+                case PdfSubSuperScript.SuperScript:
+                    size /= this.superscriptSizeFactor;
+                    break;
+            }
+        }
+        return size;
+    }
+    /**
+     * `Clones` the metrics.
+     * @private
+     */
+    public clone() : PdfFontMetrics {
+        let metrics : PdfFontMetrics = this;
+        metrics.widthTable = WidthTable.clone() as WidthTable;
+        return metrics;
+    }
+    //  Properies
+    /**
+     * Gets or sets the `width table`.
+     * @private
+     */
+    public get widthTable() : WidthTable {
+        return this.internalWidthTable;
+    }
+    public set widthTable(value : WidthTable) {
+        this.internalWidthTable = value;
+    }
+}
+export abstract class WidthTable {
+    // // Properties
+    /**
+     * Returns the `width` of the specific index.
+     * @private
+     */
+    public abstract items(index : number) : number;
+    // //  ICloneable Members
+    /**
+     * `Clones` this instance of the WidthTable class.
+     * @private
+     */
+    public abstract clone() : WidthTable;
+    /**
+     * Static `clones` this instance of the WidthTable class.
+     * @private
+     */
+    public static clone() : WidthTable {
+        return null;
+    }
+}
+export class StandardWidthTable extends WidthTable {
+    // Fields
+    /**
+     * The `widths` of the supported characters.
+     * @private
+     */
+    private widths : number[];
+    //Properties
+    /**
+     * Gets the `32 bit number` at the specified index.
+     * @private
+     */
+    public items(index : number) : number {
+        if (index < 0 || index >= this.widths.length) {
+            throw new Error('ArgumentOutOfRangeException:index, The character is not supported by the font.');
+        }
+        let result : number = this.widths[index];
+        return result;
+    }
+    /**
+     * Gets the `length` of the internal array.
+     * @private
+     */
+    public get length() : number {
+        return this.widths.length;
+    }
+    // Constructors
+    /**
+     * Initializes a new instance of the `StandardWidthTable` class.
+     * @private
+     */
+    public constructor(widths : number[]) {
+        super();
+        if (widths == null) {
+            throw new Error('ArgumentNullException:widths');
+        }
+        this.widths = widths;
+    }
+    //Overrides
+    /**
+     * `Clones` this instance of the WidthTable class.
+     * @private
+     */
+    public clone() : WidthTable {
+        let swt : StandardWidthTable = this;
+        swt.widths = this.widths;
+        return swt;
+    }
+    /**
+     * Converts width table to a `PDF array`.
+     * @private
+     */
+    public toArray() : PdfArray {
+        let arr : PdfArray = new PdfArray(this.widths);
+        return arr;
+    }
+}