ts-visio 1.4.0 → 1.5.0

package/README.md

@@ -18,7 +18,7 @@ Built using specific schema-level abstractions to handle the complex internal st
 - **Modify Content**: Update text content of shapes.
 - **Create Shapes**: Rectangles, ellipses, diamonds, rounded rectangles, triangles, parallelograms.
 - **Connect Shapes**: Dynamic connectors with arrow styles, line styling, and routing (straight / orthogonal / curved).
-- **Text Styling**: Font size, font family, bold, color, horizontal/vertical alignment.
+- **Text Styling**: Font size, font family, bold, italic, underline, strikethrough, color, alignment, paragraph spacing, and text margins.
 - **Shape Transformations**: Rotate, flip (X/Y), and resize shapes via a fluent API.
 - **Deletion**: Remove shapes and pages cleanly (including orphaned connectors and relationships).
 - **Lookup API**: Find shapes by ID, predicate, or look up pages by name.
@@ -521,6 +521,43 @@ Fields map to OPC parts: `title`, `author`, `description`, `keywords`, `lastModi
 
 ---
 
+#### 27. Rich Text Formatting
+Italic, underline, strikethrough, paragraph spacing, and text block margins are available both at shape-creation time and via `shape.setStyle()`.
+
+```typescript
+// At creation time
+const shape = await page.addShape({
+    text: 'Important',
+    x: 2, y: 3, width: 3, height: 1,
+    bold: true,
+    italic: true,
+    underline: true,
+    strikethrough: false,
+    // Paragraph spacing (in points)
+    spaceBefore: 6,
+    spaceAfter: 6,
+    lineSpacing: 1.5,  // 1.5× line height
+    // Text block margins (in inches)
+    textMarginTop:    0.1,
+    textMarginBottom: 0.1,
+    textMarginLeft:   0.1,
+    textMarginRight:  0.1,
+});
+
+// Post-creation via setStyle()
+await shape.setStyle({
+    italic: true,
+    lineSpacing: 2.0,         // double spacing
+    textMarginTop: 0.15,
+    textMarginLeft: 0.05,
+});
+```
+
+`lineSpacing` is a multiplier: `1.0` = single, `1.5` = 1.5×, `2.0` = double.
+`spaceBefore` / `spaceAfter` are in **points**. Text margins are in **inches**.
+
+---
+
 ## Examples
 
 Check out the [examples](./examples) directory for complete scripts.

package/dist/ShapeModifier.d.ts

@@ -121,6 +121,12 @@ export interface ShapeStyle {
     fillColor?: string;
     fontColor?: string;
     bold?: boolean;
+    /** Italic text. */
+    italic?: boolean;
+    /** Underline text. */
+    underline?: boolean;
+    /** Strikethrough text. */
+    strikethrough?: boolean;
     /** Font size in points (e.g. 14 for 14pt). */
     fontSize?: number;
     /** Font family name (e.g. "Arial"). */
@@ -129,4 +135,18 @@ export interface ShapeStyle {
     horzAlign?: HorzAlign;
     /** Vertical text alignment. */
     verticalAlign?: VertAlign;
+    /** Space before each paragraph in **points**. */
+    spaceBefore?: number;
+    /** Space after each paragraph in **points**. */
+    spaceAfter?: number;
+    /** Line-height multiplier (1.0 = single, 1.5 = 1.5×, 2.0 = double). */
+    lineSpacing?: number;
+    /** Top text margin in inches. */
+    textMarginTop?: number;
+    /** Bottom text margin in inches. */
+    textMarginBottom?: number;
+    /** Left text margin in inches. */
+    textMarginLeft?: number;
+    /** Right text margin in inches. */
+    textMarginRight?: number;
 }

package/dist/ShapeModifier.js

@@ -349,19 +349,52 @@ class ShapeModifier {
             shape.Section.push((0, StyleHelpers_1.createFillSection)(style.fillColor));
         }
         // Update/Add Character (Font/Text Style)
-        if (style.fontColor || style.bold !== undefined || style.fontSize !== undefined || style.fontFamily !== undefined) {
+        const hasCharProps = style.fontColor !== undefined
+            || style.bold !== undefined
+            || style.italic !== undefined
+            || style.underline !== undefined
+            || style.strikethrough !== undefined
+            || style.fontSize !== undefined
+            || style.fontFamily !== undefined;
+        if (hasCharProps) {
             shape.Section = shape.Section.filter((s) => s['@_N'] !== 'Character');
             shape.Section.push((0, StyleHelpers_1.createCharacterSection)({
                 bold: style.bold,
+                italic: style.italic,
+                underline: style.underline,
+                strikethrough: style.strikethrough,
                 color: style.fontColor,
                 fontSize: style.fontSize,
                 fontFamily: style.fontFamily,
             }));
         }
-        // Update/Add Paragraph (Horizontal Alignment)
-        if (style.horzAlign !== undefined) {
+        // Update/Add Paragraph
+        const hasParagraphProps = style.horzAlign !== undefined
+            || style.spaceBefore !== undefined
+            || style.spaceAfter !== undefined
+            || style.lineSpacing !== undefined;
+        if (hasParagraphProps) {
             shape.Section = shape.Section.filter((s) => s['@_N'] !== 'Paragraph');
-            shape.Section.push((0, StyleHelpers_1.createParagraphSection)(style.horzAlign));
+            shape.Section.push((0, StyleHelpers_1.createParagraphSection)({
+                horzAlign: style.horzAlign,
+                spaceBefore: style.spaceBefore,
+                spaceAfter: style.spaceAfter,
+                lineSpacing: style.lineSpacing,
+            }));
+        }
+        // Update/Add TextBlock (text margins)
+        const hasTextBlockProps = style.textMarginTop !== undefined
+            || style.textMarginBottom !== undefined
+            || style.textMarginLeft !== undefined
+            || style.textMarginRight !== undefined;
+        if (hasTextBlockProps) {
+            shape.Section = shape.Section.filter((s) => s['@_N'] !== 'TextBlock');
+            shape.Section.push((0, StyleHelpers_1.createTextBlockSection)({
+                topMargin: style.textMarginTop,
+                bottomMargin: style.textMarginBottom,
+                leftMargin: style.textMarginLeft,
+                rightMargin: style.textMarginRight,
+            }));
         }
         // Update/Add VerticalAlign (top-level shape Cell)
         if (style.verticalAlign !== undefined) {

package/dist/shapes/ShapeBuilder.js

@@ -37,16 +37,47 @@ class ShapeBuilder {
                 weight: '0.01'
             }));
         }
-        if (props.fontColor || props.bold || props.fontSize !== undefined || props.fontFamily !== undefined) {
+        const hasCharProps = props.fontColor !== undefined
+            || props.bold !== undefined
+            || props.italic !== undefined
+            || props.underline !== undefined
+            || props.strikethrough !== undefined
+            || props.fontSize !== undefined
+            || props.fontFamily !== undefined;
+        if (hasCharProps) {
             shape.Section.push((0, StyleHelpers_1.createCharacterSection)({
                 bold: props.bold,
+                italic: props.italic,
+                underline: props.underline,
+                strikethrough: props.strikethrough,
                 color: props.fontColor,
                 fontSize: props.fontSize,
                 fontFamily: props.fontFamily,
             }));
         }
-        if (props.horzAlign !== undefined) {
-            shape.Section.push((0, StyleHelpers_1.createParagraphSection)(props.horzAlign));
+        const hasParagraphProps = props.horzAlign !== undefined
+            || props.spaceBefore !== undefined
+            || props.spaceAfter !== undefined
+            || props.lineSpacing !== undefined;
+        if (hasParagraphProps) {
+            shape.Section.push((0, StyleHelpers_1.createParagraphSection)({
+                horzAlign: props.horzAlign,
+                spaceBefore: props.spaceBefore,
+                spaceAfter: props.spaceAfter,
+                lineSpacing: props.lineSpacing,
+            }));
+        }
+        const hasTextBlockProps = props.textMarginTop !== undefined
+            || props.textMarginBottom !== undefined
+            || props.textMarginLeft !== undefined
+            || props.textMarginRight !== undefined;
+        if (hasTextBlockProps) {
+            shape.Section.push((0, StyleHelpers_1.createTextBlockSection)({
+                topMargin: props.textMarginTop,
+                bottomMargin: props.textMarginBottom,
+                leftMargin: props.textMarginLeft,
+                rightMargin: props.textMarginRight,
+            }));
         }
         if (props.verticalAlign !== undefined) {
             shape.Cell.push({ '@_N': 'VerticalAlign', '@_V': (0, StyleHelpers_1.vertAlignValue)(props.verticalAlign) });

package/dist/types/VisioTypes.d.ts

@@ -172,4 +172,24 @@ export interface NewShapeProps {
     masterId?: string;
     imgRelId?: string;
     lineColor?: string;
+    /** Italic text. */
+    italic?: boolean;
+    /** Underline text. */
+    underline?: boolean;
+    /** Strikethrough text. */
+    strikethrough?: boolean;
+    /** Space before each paragraph in **points**. */
+    spaceBefore?: number;
+    /** Space after each paragraph in **points**. */
+    spaceAfter?: number;
+    /** Line-height multiplier (1.0 = single, 1.5 = 1.5×, 2.0 = double). */
+    lineSpacing?: number;
+    /** Top text margin in inches. */
+    textMarginTop?: number;
+    /** Bottom text margin in inches. */
+    textMarginBottom?: number;
+    /** Left text margin in inches. */
+    textMarginLeft?: number;
+    /** Right text margin in inches. */
+    textMarginRight?: number;
 }

package/dist/utils/StyleHelpers.d.ts

@@ -32,13 +32,50 @@ export declare function horzAlignValue(align: HorzAlign): string;
 export declare function vertAlignValue(align: VertAlign): string;
 export declare function createCharacterSection(props: {
     bold?: boolean;
+    /** Italic text (Style bit 2). */
+    italic?: boolean;
+    /** Underline text (Style bit 4). */
+    underline?: boolean;
+    /** Strikethrough text (Style bit 8). */
+    strikethrough?: boolean;
     color?: string;
     /** Font size in points (e.g. 12 for 12pt). Stored internally as inches (pt / 72). */
     fontSize?: number;
     /** Font family name (e.g. "Arial"). Uses FONT() formula for portability. */
     fontFamily?: string;
 }): VisioSection;
-export declare function createParagraphSection(horzAlign: HorzAlign): VisioSection;
+export interface ParagraphProps {
+    /** Horizontal text alignment within the paragraph. */
+    horzAlign?: HorzAlign;
+    /**
+     * Space before each paragraph in **points**.
+     * Converted to inches internally (pt / 72).
+     */
+    spaceBefore?: number;
+    /**
+     * Space after each paragraph in **points**.
+     * Converted to inches internally (pt / 72).
+     */
+    spaceAfter?: number;
+    /**
+     * Line-height multiplier (1.0 = single, 1.5 = 1.5×, 2.0 = double).
+     * Stored as a negative value in Visio's `SpLine` cell (negative means
+     * proportional; positive means absolute in inches).
+     */
+    lineSpacing?: number;
+}
+export declare function createParagraphSection(props: ParagraphProps): VisioSection;
+export interface TextBlockProps {
+    /** Top text margin in inches. */
+    topMargin?: number;
+    /** Bottom text margin in inches. */
+    bottomMargin?: number;
+    /** Left text margin in inches. */
+    leftMargin?: number;
+    /** Right text margin in inches. */
+    rightMargin?: number;
+}
+export declare function createTextBlockSection(props: TextBlockProps): VisioSection;
 export declare function createLineSection(props: {
     color?: string;
     pattern?: string;

package/dist/utils/StyleHelpers.js

@@ -6,6 +6,7 @@ exports.horzAlignValue = horzAlignValue;
 exports.vertAlignValue = vertAlignValue;
 exports.createCharacterSection = createCharacterSection;
 exports.createParagraphSection = createParagraphSection;
+exports.createTextBlockSection = createTextBlockSection;
 exports.createLineSection = createLineSection;
 const hexToRgb = (hex) => {
     // Expand shorthand form (e.g. "03F") to full form (e.g. "0033FF")
@@ -57,9 +58,14 @@ function vertAlignValue(align) {
 }
 function createCharacterSection(props) {
     let styleVal = 0;
-    if (props.bold) {
-        styleVal += 1; // Bold bit
-    }
+    if (props.bold)
+        styleVal |= 1;
+    if (props.italic)
+        styleVal |= 2;
+    if (props.underline)
+        styleVal |= 4;
+    if (props.strikethrough)
+        styleVal |= 8;
     const colorVal = props.color || '#000000';
     const cells = [
         { '@_N': 'Color', '@_V': colorVal, '@_F': hexToRgb(colorVal) },
@@ -89,20 +95,47 @@ function createCharacterSection(props) {
         ]
     };
 }
-function createParagraphSection(horzAlign) {
+function createParagraphSection(props) {
+    const cells = [];
+    if (props.horzAlign !== undefined) {
+        cells.push({ '@_N': 'HorzAlign', '@_V': HORZ_ALIGN_VALUES[props.horzAlign] });
+    }
+    if (props.spaceBefore !== undefined) {
+        cells.push({ '@_N': 'SpBefore', '@_V': (props.spaceBefore / 72).toString(), '@_U': 'PT' });
+    }
+    if (props.spaceAfter !== undefined) {
+        cells.push({ '@_N': 'SpAfter', '@_V': (props.spaceAfter / 72).toString(), '@_U': 'PT' });
+    }
+    if (props.lineSpacing !== undefined) {
+        // Negative value = proportional multiplier; positive = absolute (inches)
+        cells.push({ '@_N': 'SpLine', '@_V': (-props.lineSpacing).toString() });
+    }
     return {
         '@_N': 'Paragraph',
         Row: [
             {
                 '@_T': 'Paragraph',
                 '@_IX': '0',
-                Cell: [
-                    { '@_N': 'HorzAlign', '@_V': HORZ_ALIGN_VALUES[horzAlign] },
-                ]
+                Cell: cells,
             }
         ]
     };
 }
+function createTextBlockSection(props) {
+    const cells = [];
+    if (props.topMargin !== undefined)
+        cells.push({ '@_N': 'TopMargin', '@_V': props.topMargin.toString(), '@_U': 'IN' });
+    if (props.bottomMargin !== undefined)
+        cells.push({ '@_N': 'BottomMargin', '@_V': props.bottomMargin.toString(), '@_U': 'IN' });
+    if (props.leftMargin !== undefined)
+        cells.push({ '@_N': 'LeftMargin', '@_V': props.leftMargin.toString(), '@_U': 'IN' });
+    if (props.rightMargin !== undefined)
+        cells.push({ '@_N': 'RightMargin', '@_V': props.rightMargin.toString(), '@_U': 'IN' });
+    return {
+        '@_N': 'TextBlock',
+        Cell: cells,
+    };
+}
 function createLineSection(props) {
     const cells = [
         { '@_N': 'LineColor', '@_V': props.color || '#000000' },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-visio",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {