altium-toolkit 0.1.20 → 0.1.22

package/src/ui/SchematicNoteRenderer.mjs

@@ -51,11 +51,23 @@ export class SchematicNoteRenderer {
             '--schematic-note-border-color'
         )
         const noteStroke = text.showBorder ? borderColor : 'none'
+        const noteSourceLines = text.noteLines || []
+        const verticalTextMargin =
+            SchematicNoteRenderer.#resolveVerticalTextMargin(
+                textMargin,
+                height,
+                requestedTextSize
+            )
         const layout = SchematicNoteRenderer.#resolveTextLayout(
-            text.noteLines || [],
+            noteSourceLines,
             Math.max(width - textMargin * 2, requestedTextSize),
-            Math.max(height - textMargin * 2, requestedTextSize),
-            requestedTextSize
+            Math.max(height - verticalTextMargin * 2, requestedTextSize),
+            requestedTextSize,
+            SchematicNoteRenderer.#isCompactSingleLineNote(
+                noteSourceLines,
+                height,
+                requestedTextSize
+            )
         )
         const noteLines = layout.noteLines
         const textSize = layout.textSize
@@ -69,6 +81,7 @@ export class SchematicNoteRenderer {
                     right,
                     top,
                     textMargin,
+                    verticalTextMargin,
                     lineHeight,
                     textSize,
                     text
@@ -102,14 +115,33 @@ export class SchematicNoteRenderer {
      * @param {number} maxWidth
      * @param {number} maxHeight
      * @param {number} requestedTextSize
+     * @param {boolean} keepSingleLineSize
      * @returns {{ noteLines: string[], textSize: number, lineHeight: number }}
      */
     static #resolveTextLayout(
         noteLines,
         maxWidth,
         maxHeight,
-        requestedTextSize
+        requestedTextSize,
+        keepSingleLineSize = false
     ) {
+        if (keepSingleLineSize) {
+            const visibleLines = noteLines.filter((line) =>
+                String(line || '').trim()
+            )
+
+            return {
+                noteLines: visibleLines,
+                textSize: requestedTextSize,
+                lineHeight: SchematicNoteRenderer.#resolveLineHeight(
+                    requestedTextSize,
+                    maxHeight,
+                    0,
+                    visibleLines.length
+                )
+            }
+        }
+
         let textSize = requestedTextSize
         let wrappedLines = []
 
@@ -262,6 +294,36 @@ export class SchematicNoteRenderer {
         return wrappedLines
     }
 
+    /**
+     * Checks if a note is a tight one-line callout where Altium preserves the
+     * text size even when the note rectangle has little vertical padding.
+     * @param {string[]} noteLines
+     * @param {number} height
+     * @param {number} requestedTextSize
+     * @returns {boolean}
+     */
+    static #isCompactSingleLineNote(noteLines, height, requestedTextSize) {
+        const visibleLineCount = noteLines.filter((line) =>
+            String(line || '').trim()
+        ).length
+
+        return visibleLineCount === 1 && height <= requestedTextSize * 1.5
+    }
+
+    /**
+     * Reduces vertical padding for short note rectangles so readable text is
+     * centered instead of scaled down to satisfy the default margin.
+     * @param {number} textMargin
+     * @param {number} height
+     * @param {number} requestedTextSize
+     * @returns {number}
+     */
+    static #resolveVerticalTextMargin(textMargin, height, requestedTextSize) {
+        const centeredMargin = Math.max((height - requestedTextSize) / 2, 0)
+
+        return Math.min(textMargin, centeredMargin)
+    }
+
     /**
      * Splits one oversized token into smaller width-safe fragments.
      * @param {string} token
@@ -360,7 +422,8 @@ export class SchematicNoteRenderer {
      * @param {number} left
      * @param {number} right
      * @param {number} top
-     * @param {number} textMargin
+     * @param {number} horizontalTextMargin
+     * @param {number} verticalTextMargin
      * @param {number} lineHeight
      * @param {number} textSize
      * @param {{ color: string, fontFamily?: string, fontWeight?: number }} text
@@ -372,13 +435,14 @@ export class SchematicNoteRenderer {
         left,
         right,
         top,
-        textMargin,
+        horizontalTextMargin,
+        verticalTextMargin,
         lineHeight,
         textSize,
         text
     ) {
-        const x = left + textMargin
-        const y = top + textMargin + textSize + index * lineHeight
+        const x = left + horizontalTextMargin
+        const y = top + verticalTextMargin + textSize + index * lineHeight
 
         if (/^_+$/.test(String(line || '').trim())) {
             return (
@@ -387,7 +451,7 @@ export class SchematicNoteRenderer {
                 '" y1="' +
                 formatNumber(y - textSize * 0.35) +
                 '" x2="' +
-                formatNumber(right - textMargin) +
+                formatNumber(right - horizontalTextMargin) +
                 '" y2="' +
                 formatNumber(y - textSize * 0.35) +
                 '" stroke="' +

package/src/ui/SchematicPinSvgRenderer.mjs

@@ -49,7 +49,6 @@ export class SchematicPinSvgRenderer {
         const labelMode = pin.labelMode || 'name-and-number'
         const outerMarkerStyle =
             SchematicPinSvgRenderer.#resolveSchematicOuterPinMarkerStyle(pin)
-        const usesOuterMarker = outerMarkerStyle !== null
         const rotateTopNumber =
             pin.orientation === 'top' &&
             rotatedVerticalNumberOwners.has(String(pin.ownerIndex || ''))
@@ -65,7 +64,10 @@ export class SchematicPinSvgRenderer {
         if (pin.orientation === 'left') {
             if (labelMode !== 'hidden' && labelMode !== 'name-only') {
                 const defaultNumberX =
-                    geometry.bodyX - (usesOuterMarker ? 8 : 2)
+                    geometry.bodyX -
+                    SchematicPinSvgRenderer.#resolveHorizontalPinNumberClearance(
+                        outerMarkerStyle
+                    )
                 const numberX = hasExplicitOwnerPinName
                     ? SchematicOwnerPinLabelLayout.resolveExplicitOwnerPinNumberX(
                           pin,
@@ -110,7 +112,10 @@ export class SchematicPinSvgRenderer {
         if (pin.orientation === 'right') {
             if (labelMode !== 'hidden' && labelMode !== 'name-only') {
                 const defaultNumberX =
-                    geometry.bodyX + (usesOuterMarker ? 8 : 2)
+                    geometry.bodyX +
+                    SchematicPinSvgRenderer.#resolveHorizontalPinNumberClearance(
+                        outerMarkerStyle
+                    )
                 const numberX = hasExplicitOwnerPinName
                     ? SchematicOwnerPinLabelLayout.resolveExplicitOwnerPinNumberX(
                           pin,
@@ -357,6 +362,23 @@ export class SchematicPinSvgRenderer {
         )
     }
 
+    /**
+     * Returns the horizontal pin-number clearance needed by an authored marker.
+     * @param {'single-in' | 'single-out' | 'double' | null} markerStyle
+     * @returns {number}
+     */
+    static #resolveHorizontalPinNumberClearance(markerStyle) {
+        switch (markerStyle) {
+            case 'double':
+                return 17
+            case 'single-in':
+            case 'single-out':
+                return 8
+            default:
+                return 2
+        }
+    }
+
     /**
      * Builds one or two authored outer-marker polygons for one horizontal pin.
      * @param {number} bodyX

package/src/ui/SchematicPowerPortRenderer.mjs

@@ -56,7 +56,9 @@ export class SchematicPowerPortRenderer {
                     y,
                     fontSize,
                     labelOptions,
-                    resolvedColor
+                    resolvedColor,
+                    lines,
+                    sheetHeight
                 ) +
                 '</g>'
             )
@@ -77,7 +79,9 @@ export class SchematicPowerPortRenderer {
                 y,
                 fontSize,
                 labelOptions,
-                resolvedColor
+                resolvedColor,
+                lines,
+                sheetHeight
             ) +
             '</g>'
         )
@@ -514,6 +518,8 @@ export class SchematicPowerPortRenderer {
      * @param {number} fontSize
      * @param {{ fontSize?: number, fontFamily?: string, fontWeight?: number }} labelOptions
      * @param {string} color
+     * @param {{ x1: number, y1: number, x2: number, y2: number }[]} lines
+     * @param {number} sheetHeight
      * @returns {string}
      */
     static #buildDirectionalLabel(
@@ -523,52 +529,193 @@ export class SchematicPowerPortRenderer {
         y,
         fontSize,
         labelOptions,
-        color
+        color,
+        lines = [],
+        sheetHeight = 0
+    ) {
+        const placement = SchematicPowerPortRenderer.#resolveLabelPlacement(
+            text,
+            direction,
+            x,
+            y,
+            fontSize,
+            lines,
+            sheetHeight
+        )
+
+        return createSvgText(
+            'schematic-power-port-label',
+            placement.x,
+            placement.y,
+            text.text,
+            color,
+            placement.anchor,
+            labelOptions
+        )
+    }
+
+    /**
+     * Resolves label placement and avoids nearby horizontal net-line overlap
+     * for upward rail labels in dense schematic areas.
+     * @param {{ text: string, style?: number }} text
+     * @param {'up' | 'down' | 'left' | 'right'} direction
+     * @param {number} x
+     * @param {number} y
+     * @param {number} fontSize
+     * @param {{ x1: number, y1: number, x2: number, y2: number }[]} lines
+     * @param {number} sheetHeight
+     * @returns {{ x: number, y: number, anchor: 'start' | 'middle' | 'end' }}
+     */
+    static #resolveLabelPlacement(
+        text,
+        direction,
+        x,
+        y,
+        fontSize,
+        lines,
+        sheetHeight
     ) {
         if (direction === 'up') {
-            return createSvgText(
-                'schematic-power-port-label',
+            return {
                 x,
-                y - 16,
-                text.text,
-                color,
-                'middle',
-                labelOptions
-            )
+                y: SchematicPowerPortRenderer.#resolveUpwardRailLabelY(
+                    text,
+                    x,
+                    y,
+                    y - 16,
+                    fontSize,
+                    lines,
+                    sheetHeight
+                ),
+                anchor: 'middle'
+            }
         }
 
         if (direction === 'right') {
-            return createSvgText(
-                'schematic-power-port-label',
-                x + 18,
-                y + fontSize * 0.36,
-                text.text,
-                color,
-                'start',
-                labelOptions
-            )
+            return { x: x + 18, y: y + fontSize * 0.36, anchor: 'start' }
         }
 
         if (direction === 'left') {
-            return createSvgText(
-                'schematic-power-port-label',
-                x - 18,
-                y + fontSize * 0.36,
-                text.text,
-                color,
-                'end',
-                labelOptions
+            return { x: x - 18, y: y + fontSize * 0.36, anchor: 'end' }
+        }
+
+        return { x, y: y + 25, anchor: 'middle' }
+    }
+
+    /**
+     * Shifts an upward rail label below close parallel net lines when the
+     * default placement would draw text through an existing wire.
+     * @param {{ text: string, style?: number }} text
+     * @param {number} x
+     * @param {number} connectionY
+     * @param {number} defaultY
+     * @param {number} fontSize
+     * @param {{ x1: number, y1: number, x2: number, y2: number }[]} lines
+     * @param {number} sheetHeight
+     * @returns {number}
+     */
+    static #resolveUpwardRailLabelY(
+        text,
+        x,
+        connectionY,
+        defaultY,
+        fontSize,
+        lines,
+        sheetHeight
+    ) {
+        if (Number(text.style || 0) === 4) {
+            return defaultY
+        }
+
+        let labelY = defaultY
+
+        for (const line of lines) {
+            const horizontalLine =
+                SchematicPowerPortRenderer.#projectHorizontalLine(
+                    line,
+                    sheetHeight
+                )
+
+            if (!horizontalLine) {
+                continue
+            }
+
+            if (
+                !SchematicPowerPortRenderer.#horizontalLineIntersectsLabel(
+                    horizontalLine,
+                    text.text,
+                    x,
+                    labelY,
+                    fontSize
+                )
+            ) {
+                continue
+            }
+
+            labelY = Math.min(
+                connectionY - 4,
+                Math.max(labelY, horizontalLine.y + fontSize + 4)
             )
         }
 
-        return createSvgText(
-            'schematic-power-port-label',
-            x,
-            y + 25,
-            text.text,
-            color,
-            'middle',
-            labelOptions
+        return labelY
+    }
+
+    /**
+     * Projects one source horizontal line into SVG coordinates.
+     * @param {{ x1: number, y1: number, x2: number, y2: number }} line
+     * @param {number} sheetHeight
+     * @returns {{ y: number, minX: number, maxX: number } | null}
+     */
+    static #projectHorizontalLine(line, sheetHeight) {
+        const y1 = projectSchematicY(sheetHeight, line.y1)
+        const y2 = projectSchematicY(sheetHeight, line.y2)
+
+        if (Math.abs(y1 - y2) > 0.01) {
+            return null
+        }
+
+        return {
+            y: y1,
+            minX: Math.min(line.x1, line.x2),
+            maxX: Math.max(line.x1, line.x2)
+        }
+    }
+
+    /**
+     * Checks whether a projected horizontal line crosses an estimated text box.
+     * @param {{ y: number, minX: number, maxX: number }} line
+     * @param {string} label
+     * @param {number} x
+     * @param {number} labelY
+     * @param {number} fontSize
+     * @returns {boolean}
+     */
+    static #horizontalLineIntersectsLabel(line, label, x, labelY, fontSize) {
+        const textWidth = SchematicPowerPortRenderer.#estimateLabelWidth(
+            label,
+            fontSize
+        )
+        const textMinX = x - textWidth / 2
+        const textMaxX = x + textWidth / 2
+        const textTopY = labelY - fontSize
+        const textBottomY = labelY + fontSize * 0.25
+
+        return (
+            line.maxX >= textMinX &&
+            line.minX <= textMaxX &&
+            line.y >= textTopY &&
+            line.y <= textBottomY
         )
     }
+
+    /**
+     * Estimates one power-port label width for clearance checks.
+     * @param {string} label
+     * @param {number} fontSize
+     * @returns {number}
+     */
+    static #estimateLabelWidth(label, fontSize) {
+        return String(label || '').length * fontSize * 0.56
+    }
 }

package/src/ui/SchematicSvgRenderer.mjs

@@ -28,7 +28,7 @@ const { createSvgText, escapeHtml, formatNumber, projectSchematicY } =
 export class SchematicSvgRenderer {
     /**
      * Renders a normalized schematic model into SVG markup.
-     * @param {{ fileName?: string, summary: { title?: string }, schematic?: { sheet: { width: number, height: number, sourceWidth?: number, sourceHeight?: number, paperSize?: string, borderOn?: boolean, titleBlockOn?: boolean, marginWidth?: number, xZones?: number, yZones?: number, titleBlock?: { title?: string, revision?: string, documentNumber?: string, sheetNumber?: string, sheetTotal?: string, date?: string, drawnBy?: string } }, lines: { x1: number, y1: number, x2: number, y2: number, color: string, width: number, lineStyle?: number, isBus?: boolean, ownerIndex?: string, renderOrder?: number }[], polygons?: { points: { x: number, y: number }[], color: string, fill: string, isSolid: boolean, transparent: boolean, lineWidth: number, ownerIndex?: string, renderOrder?: number }[], rectangles?: { x: number, y: number, width: number, height: number, color: string, fill: string, isSolid: boolean, transparent: boolean, lineWidth: number, ownerIndex?: string, renderOrder?: number }[], regions?: { x: number, y: number, width: number, height: number, color: string, fill: string, renderOrder?: number }[], ellipses?: { x: number, y: number, radiusX: number, radiusY: number, color: string, fill: string, isSolid: boolean, transparent: boolean, lineWidth: number, ownerIndex?: string, renderOrder?: number }[], arcs?: { x: number, y: number, radius: number, startAngle: number, endAngle: number, color: string, width: number, ownerIndex?: string, renderOrder?: number }[], directives?: { x: number, y: number, color: string, name: string, orientation?: number }[], texts: { x: number, y: number, text: string, color: string, recordType?: string, style?: number, fontSize?: number, fontFamily?: string, fontWeight?: number, rotation?: number, sourceOrientation?: number, isMirrored?: boolean, anchor?: 'start' | 'middle' | 'end', powerPortDirection?: 'up' | 'down' | 'left' | 'right', cornerX?: number, cornerY?: number, fill?: string, borderColor?: string, isSolid?: boolean, showBorder?: boolean, textMargin?: number, noteLines?: string[] }[], components: { x: number, y: number, designator: string }[], pins?: { x: number, y: number, length: number, name: string, nameSegments?: { text: string, overline: boolean }[], designator: string, orientation: 'left' | 'right' | 'top' | 'bottom', electrical?: number, symbolOuter?: number, color: string, labelColor?: string, labelMode?: 'hidden' | 'number-only' | 'name-only' | 'name-and-number', ownerIndex?: string }[], ports?: { x: number, y: number, width: number, height: number, name: string, fill: string, color: string, direction?: 'left' | 'right' | 'up' | 'down', shape?: 'single' | 'double' | 'plain' }[], crosses?: { x: number, y: number, size: number, color: string }[] } }} documentModel
+     * @param {{ fileName?: string, summary: { title?: string }, schematic?: { sheet: { width: number, height: number, sourceWidth?: number, sourceHeight?: number, paperSize?: string, borderOn?: boolean, titleBlockOn?: boolean, marginWidth?: number, xZones?: number, yZones?: number, titleBlock?: { title?: string, revision?: string, documentNumber?: string, sheetNumber?: string, sheetTotal?: string, date?: string, drawnBy?: string } }, lines: { x1: number, y1: number, x2: number, y2: number, color: string, width: number, lineStyle?: number, isBus?: boolean, ownerIndex?: string, renderOrder?: number, recordType?: string }[], polygons?: { points: { x: number, y: number }[], color: string, fill: string, isSolid: boolean, transparent: boolean, lineWidth: number, ownerIndex?: string, renderOrder?: number }[], rectangles?: { x: number, y: number, width: number, height: number, color: string, fill: string, isSolid: boolean, transparent: boolean, lineWidth: number, ownerIndex?: string, renderOrder?: number }[], regions?: { x: number, y: number, width: number, height: number, color: string, fill: string, renderOrder?: number }[], ellipses?: { x: number, y: number, radiusX: number, radiusY: number, color: string, fill: string, isSolid: boolean, transparent: boolean, lineWidth: number, ownerIndex?: string, renderOrder?: number }[], arcs?: { x: number, y: number, radius: number, startAngle: number, endAngle: number, color: string, width: number, ownerIndex?: string, renderOrder?: number }[], directives?: { x: number, y: number, color: string, name: string, orientation?: number }[], texts: { x: number, y: number, text: string, color: string, recordType?: string, style?: number, fontSize?: number, fontFamily?: string, fontWeight?: number, rotation?: number, sourceOrientation?: number, isMirrored?: boolean, anchor?: 'start' | 'middle' | 'end', powerPortDirection?: 'up' | 'down' | 'left' | 'right', cornerX?: number, cornerY?: number, fill?: string, borderColor?: string, isSolid?: boolean, showBorder?: boolean, textMargin?: number, noteLines?: string[] }[], components: { x: number, y: number, designator: string }[], pins?: { x: number, y: number, length: number, name: string, nameSegments?: { text: string, overline: boolean }[], designator: string, orientation: 'left' | 'right' | 'top' | 'bottom', electrical?: number, symbolOuter?: number, color: string, labelColor?: string, labelMode?: 'hidden' | 'number-only' | 'name-only' | 'name-and-number', ownerIndex?: string }[], ports?: { x: number, y: number, width: number, height: number, name: string, fill: string, color: string, direction?: 'left' | 'right' | 'up' | 'down', shape?: 'single' | 'double' | 'plain' }[], crosses?: { x: number, y: number, size: number, color: string }[] } }} documentModel
      * @returns {string}
      */
     static render(documentModel) {
@@ -461,7 +461,7 @@ export class SchematicSvgRenderer {
     /**
      * Builds one schematic line segment, preserving dashed line styles when
      * the source primitive requests them.
-     * @param {{ x1: number, y1: number, x2: number, y2: number, color: string, width: number, lineStyle?: number, isBus?: boolean }} line
+     * @param {{ x1: number, y1: number, x2: number, y2: number, color: string, width: number, lineStyle?: number, isBus?: boolean, recordType?: string }} line
      * @param {number} sheetHeight
      * @returns {string}
      */