@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/settings/document-settings-values.js

@@ -0,0 +1,60 @@
+/**
+ * Simple typed wrappers for `w:defaultTabStop` and `w:characterSpacingControl`
+ * (`CT_TwipsMeasure` and `ST_CharacterSpacing`, Transitional `wml.xsd`).
+ *
+ * @private
+ */
+import { WML_TRANSITIONAL_NAMESPACE } from '../../core/xml/index';
+import { pointToTwips, twipsToPoint } from '../document/length';
+import { wmlAttr, wmlElement } from '../document/wml';
+var VALID_CSC = new Set([
+    'doNotCompress',
+    'compressPunctuation',
+    'compressPunctuationAndJapaneseKana',
+]);
+function wValStr(element) {
+    var found = element.attributes.find(function (a) { return a.localName === 'val' &&
+        (a.namespaceUri === WML_TRANSITIONAL_NAMESPACE || a.namespaceUri === ''); });
+    return found == null ? undefined : found.value;
+}
+/**
+ * Parse `w:defaultTabStop/@w:val` (`ST_TwipsMeasure` on the wire) into plain points.
+ * Returns `undefined` when missing or non-numeric.
+ *
+ * @private
+ */
+export function parseDefaultTabStop(element) {
+    var val = wValStr(element);
+    if (val === undefined)
+        return undefined;
+    var n = Number(val);
+    return Number.isNaN(n) ? undefined : twipsToPoint(n);
+}
+/**
+ * Serialize `w:defaultTabStop` from a plain points value (writes twips on the wire).
+ *
+ * @private
+ */
+export function serializeDefaultTabStop(value) {
+    return wmlElement('defaultTabStop', { attributes: [wmlAttr('val', String(pointToTwips(value)))] });
+}
+/**
+ * Parse `w:characterSpacingControl/@w:val`.
+ * Returns `undefined` when missing or not a recognised value.
+ *
+ * @private
+ */
+export function parseCharacterSpacingControl(element) {
+    var val = wValStr(element);
+    if (val === undefined || !VALID_CSC.has(val))
+        return undefined;
+    return val;
+}
+/**
+ * Serialize `w:characterSpacingControl` from a value.
+ *
+ * @private
+ */
+export function serializeCharacterSpacingControl(value) {
+    return wmlElement('characterSpacingControl', { attributes: [wmlAttr('val', value)] });
+}

package/src/features/settings/footnote-properties.d.ts

@@ -0,0 +1,211 @@
+/**
+ * WordDocument-level footnote/endnote properties (`w:footnotePr` / `w:endnotePr`).
+ *
+ * Models `CT_FtnDocProps` / `CT_EdnDocProps` (extends `CT_FtnProps` / `CT_EdnProps`)
+ * from Transitional `wml.xsd`: optional `pos`, `numFmt`, `numStart`, `numRestart`,
+ * plus residual children (separator refs) and leftover root attributes.
+ *
+ * Standards: ECMA-376-1 §17.11; `ST_NumberFormat`, `ST_FtnPos`, `ST_EdnPos`,
+ * `ST_RestartNumber` in `specs/schemas/xsd/OfficeOpenXML-XMLSchema-Transitional/wml.xsd`.
+ *
+ * @public
+ */
+import { OpenXmlElement } from '../../core/xml/index';
+/**
+ * Where footnotes are placed on the page or in the document.
+ *
+ * - `pageBottom` — bottom of the page
+ * - `beneathText` — directly under the last body text on the page
+ * - `sectEnd` — end of the section
+ * - `docEnd` — end of the document
+ *
+ * @public
+ */
+export declare type FootnotePosition = 'pageBottom' | 'beneathText' | 'sectEnd' | 'docEnd';
+/**
+ * Where endnotes are placed in the document.
+ *
+ * - `sectEnd` — end of the section
+ * - `docEnd` — end of the document
+ *
+ * @public
+ */
+export declare type EndnotePosition = 'sectEnd' | 'docEnd';
+/**
+ * When automatic footnote or endnote numbering restarts.
+ *
+ * - `continuous` — numbering continues across the whole document
+ * - `eachSect` — numbering restarts at each section
+ * - `eachPage` — numbering restarts on each page (footnotes)
+ *
+ * @public
+ */
+export declare type NoteNumberingRestart = 'continuous' | 'eachSect' | 'eachPage';
+/**
+ * Closed set of note number formats (`ST_NumberFormat` in Transitional WML).
+ *
+ * Use common values such as `decimal`, `upperRoman`, `lowerRoman`,
+ * `upperLetter`, and `lowerLetter`. Less common regional and specialty tokens
+ * are accepted when present in the schema.
+ *
+ * @public
+ */
+export declare type NoteNumberFormat = 'decimal' | 'upperRoman' | 'lowerRoman' | 'upperLetter' | 'lowerLetter' | 'ordinal' | 'cardinalText' | 'ordinalText' | 'hex' | 'chicago' | 'ideographDigital' | 'japaneseCounting' | 'aiueo' | 'iroha' | 'decimalFullWidth' | 'decimalHalfWidth' | 'japaneseLegal' | 'japaneseDigitalTenThousand' | 'decimalEnclosedCircle' | 'decimalFullWidth2' | 'aiueoFullWidth' | 'irohaFullWidth' | 'decimalZero' | 'bullet' | 'ganada' | 'chosung' | 'decimalEnclosedFullstop' | 'decimalEnclosedParen' | 'decimalEnclosedCircleChinese' | 'ideographEnclosedCircle' | 'ideographTraditional' | 'ideographZodiac' | 'ideographZodiacTraditional' | 'taiwaneseCounting' | 'ideographLegalTraditional' | 'taiwaneseCountingThousand' | 'taiwaneseDigital' | 'chineseCounting' | 'chineseLegalSimplified' | 'chineseCountingThousand' | 'koreanDigital' | 'koreanCounting' | 'koreanLegal' | 'koreanDigital2' | 'vietnameseCounting' | 'russianLower' | 'russianUpper' | 'none' | 'numberInDash' | 'hebrew1' | 'hebrew2' | 'arabicAlpha' | 'arabicAbjad' | 'hindiVowels' | 'hindiConsonants' | 'hindiNumbers' | 'hindiCounting' | 'thaiLetters' | 'thaiNumbers' | 'thaiCounting' | 'bahtText' | 'dollarText' | 'custom';
+/**
+ * First-class `w:footnotePr` node (`CT_FtnDocProps`).
+ *
+ * @public
+ */
+export declare class FootnoteProperties {
+    private positionValue;
+    private readonly state;
+    private constructor();
+    /**
+     * @private
+     */
+    static fromElement(element: OpenXmlElement, onDirty?: () => void): FootnoteProperties;
+    /**
+     * @private
+   * Empty node for create path. */
+    static create(onDirty?: () => void): FootnoteProperties;
+    /**
+     * @private
+   * Bind dirty callback after SettingsPart wraps the node. */
+    bindDirty(onDirty: () => void): void;
+    private markDirty;
+    /**
+     * Display format for automatic footnote numbers (for example `decimal` or
+     * `lowerRoman`). `undefined` when the document does not specify a format.
+     *
+     * @public
+     */
+    /**
+    * Set or clear the footnote number format.
+    *
+    * @throws RangeError when `value` is not a supported {@link NoteNumberFormat}.
+    * @public
+    */
+    numberFormat: NoteNumberFormat | undefined;
+    /**
+     * Where footnotes appear relative to body text and sections.
+     * `undefined` when the document does not specify a placement.
+     *
+     * @public
+     */
+    /**
+    * Set or clear footnote placement.
+    *
+    * @throws RangeError when `value` is not a supported {@link FootnotePosition}.
+    * @public
+    */
+    position: FootnotePosition | undefined;
+    /**
+     * Starting value for automatic footnote numbering.
+     * `undefined` when the document uses the application default (typically `1`).
+     *
+     * @public
+     */
+    /**
+    * Set or clear the starting footnote number.
+    *
+    * @throws RangeError when `value` is not a finite integer.
+    * @public
+    */
+    initialNoteNumber: number | undefined;
+    /**
+     * When automatic footnote numbering restarts (`continuous`, `eachSect`, or
+     * `eachPage`). `undefined` when the document does not specify a restart rule.
+     *
+     * @public
+     */
+    /**
+    * Set or clear the footnote numbering restart rule.
+    *
+    * @throws RangeError when `value` is not a supported {@link NoteNumberingRestart}.
+    * @public
+    */
+    numberingRestart: NoteNumberingRestart | undefined;
+    /**
+     * @private
+     */
+    serialize(): OpenXmlElement;
+}
+/**
+ * First-class `w:endnotePr` node (`CT_EdnDocProps`).
+ *
+ * @public
+ */
+export declare class EndnoteProperties {
+    private positionValue;
+    private readonly state;
+    private constructor();
+    /**
+     * @private
+     */
+    static fromElement(element: OpenXmlElement, onDirty?: () => void): EndnoteProperties;
+    /**
+     * @private
+   * Empty node for create path. */
+    static create(onDirty?: () => void): EndnoteProperties;
+    /**
+     * @private
+     */
+    bindDirty(onDirty: () => void): void;
+    private markDirty;
+    /**
+     * Display format for automatic endnote numbers (for example `decimal` or
+     * `upperRoman`). `undefined` when the document does not specify a format.
+     *
+     * @public
+     */
+    /**
+    * Set or clear the endnote number format.
+    *
+    * @throws RangeError when `value` is not a supported {@link NoteNumberFormat}.
+    * @public
+    */
+    numberFormat: NoteNumberFormat | undefined;
+    /**
+     * Where endnotes appear relative to sections and the document end.
+     * `undefined` when the document does not specify a placement.
+     *
+     * @public
+     */
+    /**
+    * Set or clear endnote placement.
+    *
+    * @throws RangeError when `value` is not a supported {@link EndnotePosition}.
+    * @public
+    */
+    position: EndnotePosition | undefined;
+    /**
+     * Starting value for automatic endnote numbering.
+     * `undefined` when the document uses the application default (typically `1`).
+     *
+     * @public
+     */
+    /**
+    * Set or clear the starting endnote number.
+    *
+    * @throws RangeError when `value` is not a finite integer.
+    * @public
+    */
+    initialNoteNumber: number | undefined;
+    /**
+     * When automatic endnote numbering restarts (`continuous` or `eachSect`).
+     * `undefined` when the document does not specify a restart rule.
+     *
+     * @public
+     */
+    /**
+    * Set or clear the endnote numbering restart rule.
+    *
+    * @throws RangeError when `value` is not a supported {@link NoteNumberingRestart}.
+    * @public
+    */
+    numberingRestart: NoteNumberingRestart | undefined;
+    /**
+     * @private
+     */
+    serialize(): OpenXmlElement;
+}