@teachinglab/omd 0.3.0 → 0.3.1

package/docs/api/omdVariableNode.md

@@ -1,123 +1,123 @@
-# omdVariableNode
-
-Represents a variable (like `x`, `y`, `a`, `b`) in mathematical expressions. This node handles the visual representation of variables, their evaluation, and conversion to math.js AST.
-
-## Class Definition
-
-```javascript
-export class omdVariableNode extends omdLeafNode
-```
-
-## Constructor
-
-### `new omdVariableNode(nodeData)`
-
-Creates a new `omdVariableNode` instance.
-
--   **`nodeData`** (`object` | `string`): The AST node data (from math.js, typically a `SymbolNode` with a `name` property) or the variable name as a string (e.g., `"x"`). The constructor extracts the variable `name` and creates the `textElement` for display.
-
-## Static Methods
-
-### `fromName(name)`
-
-Creates a variable node directly from a given name string. This is a convenience method for creating simple variable nodes without needing to construct a full AST object.
-
--   **`name`** (`string`): The variable name (e.g., `"x"`, `"theta"`).
--   **Returns**: `omdVariableNode` - A new instance of `omdVariableNode`.
-
-## Public Properties
-
--   **`name`** (`string`): The name of the variable (e.g., `'x'`, `'y'`, `'theta'`).
--   **`type`** (`string`): Always `"omdVariableNode"`.
--   **`textElement`** (`jsvgTextLine`): The internal `jsvgTextLine` instance that displays the variable name.
-
-## Public Methods
-
-### `computeDimensions()`
-
-Calculates the dimensions of the node based on its text content, adding a small amount of padding around the variable name to improve visual spacing.
-
--   **Overrides**: `omdLeafNode.computeDimensions()`.
-
-### `updateLayout()`
-
-Updates the layout of the node. This method primarily calls the superclass's `updateLayout`.
-
--   **Overrides**: `omdLeafNode.updateLayout()`.
-
-### `toMathJSNode()`
-
-Converts the `omdVariableNode` to a math.js-compatible AST format. It creates a `SymbolNode` with the variable's `name`, `id`, and `provenance`.
-
--   **Returns**: `object` - A math.js-compatible AST node with `type: "SymbolNode"` and `name` set to the variable name. The returned object also includes `id`, `provenance`, and a `clone` method for compatibility.
-
-### `highlight(color)`
-
-Applies a highlight to the node's background and sets the variable's text color to white for better contrast. This method respects the `isExplainHighlighted` lock.
-
--   **`color`** (`string`): The color of the highlight.
-
-### `clearProvenanceHighlights()`
-
-Clears any provenance-related highlights from the node and resets the variable's text color to its default (black).
-
-### `toString()`
-
-Converts the variable node to its string representation, which is simply its `name`.
-
--   **Returns**: `string` - The variable name.
-
-### `evaluate(variables)`
-
-Evaluates the variable by looking up its value in the provided `variables` map. If the variable is not defined in the map, it throws an error.
-
--   **`variables`** (`object`): A map of variable names to their numeric values.
--   **Returns**: `number` - The value of the variable.
--   **Throws**: `Error` if the variable is not defined in the map.
-
-## Internal Methods
-
--   **`parseName(nodeData)`**: Extracts the variable name from the constructor's `nodeData`. It handles both string input and AST objects with a `name` property.
--   **`parseType()`**: Sets the node's type. Always returns `"variable"`.
-
-## Examples
-
-#### Creating Variables
-
-```javascript
-import { omdVariableNode } from '@teachinglab/omd';
-import * as math from 'mathjs';
-
-// From a name string
-const nodeX = omdVariableNode.fromName('x');
-const nodeTheta = omdVariableNode.fromName('θ');
-
-// From AST data (e.g., from math.js parse result)
-const astNode = math.parse('y');
-const nodeY = new omdVariableNode(astNode);
-
-// Direct string name (less common, but supported)
-const nodeZ = new omdVariableNode('z');
-```
-
-#### Rendering Variables
-
-```javascript
-import { omdVariableNode } from '@teachinglab/omd';
-// import { jsvgContainer } from '@teachinglab/jsvg'; // if rendering directly
-
-const node = omdVariableNode.fromName('x');
-node.setFontSize(24);
-node.initialize(); // Computes dimensions and layout
-
-// To render, typically add to a parent node or an omdDisplay
-// const svgContainer = new jsvgContainer();
-// svgContainer.addChild(node);
-// document.body.appendChild(svgContainer.svgObject);
-```
-
-## See Also
-
--   [`omdLeafNode`](./omdLeafNode.md) - Parent class.
--   [`omdNode`](./omdNode.md) - Base class.
--   [`omdConstantNode`](./omdConstantNode.md) - For numeric values.
+# omdVariableNode
+
+Represents a variable (like `x`, `y`, `a`, `b`) in mathematical expressions. This node handles the visual representation of variables, their evaluation, and conversion to math.js AST.
+
+## Class Definition
+
+```javascript
+export class omdVariableNode extends omdLeafNode
+```
+
+## Constructor
+
+### `new omdVariableNode(nodeData)`
+
+Creates a new `omdVariableNode` instance.
+
+-   **`nodeData`** (`object` | `string`): The AST node data (from math.js, typically a `SymbolNode` with a `name` property) or the variable name as a string (e.g., `"x"`). The constructor extracts the variable `name` and creates the `textElement` for display.
+
+## Static Methods
+
+### `fromName(name)`
+
+Creates a variable node directly from a given name string. This is a convenience method for creating simple variable nodes without needing to construct a full AST object.
+
+-   **`name`** (`string`): The variable name (e.g., `"x"`, `"theta"`).
+-   **Returns**: `omdVariableNode` - A new instance of `omdVariableNode`.
+
+## Public Properties
+
+-   **`name`** (`string`): The name of the variable (e.g., `'x'`, `'y'`, `'theta'`).
+-   **`type`** (`string`): Always `"omdVariableNode"`.
+-   **`textElement`** (`jsvgTextLine`): The internal `jsvgTextLine` instance that displays the variable name.
+
+## Public Methods
+
+### `computeDimensions()`
+
+Calculates the dimensions of the node based on its text content, adding a small amount of padding around the variable name to improve visual spacing.
+
+-   **Overrides**: `omdLeafNode.computeDimensions()`.
+
+### `updateLayout()`
+
+Updates the layout of the node. This method primarily calls the superclass's `updateLayout`.
+
+-   **Overrides**: `omdLeafNode.updateLayout()`.
+
+### `toMathJSNode()`
+
+Converts the `omdVariableNode` to a math.js-compatible AST format. It creates a `SymbolNode` with the variable's `name`, `id`, and `provenance`.
+
+-   **Returns**: `object` - A math.js-compatible AST node with `type: "SymbolNode"` and `name` set to the variable name. The returned object also includes `id`, `provenance`, and a `clone` method for compatibility.
+
+### `highlight(color)`
+
+Applies a highlight to the node's background and sets the variable's text color to white for better contrast. This method respects the `isExplainHighlighted` lock.
+
+-   **`color`** (`string`): The color of the highlight.
+
+### `clearProvenanceHighlights()`
+
+Clears any provenance-related highlights from the node and resets the variable's text color to its default (black).
+
+### `toString()`
+
+Converts the variable node to its string representation, which is simply its `name`.
+
+-   **Returns**: `string` - The variable name.
+
+### `evaluate(variables)`
+
+Evaluates the variable by looking up its value in the provided `variables` map. If the variable is not defined in the map, it throws an error.
+
+-   **`variables`** (`object`): A map of variable names to their numeric values.
+-   **Returns**: `number` - The value of the variable.
+-   **Throws**: `Error` if the variable is not defined in the map.
+
+## Internal Methods
+
+-   **`parseName(nodeData)`**: Extracts the variable name from the constructor's `nodeData`. It handles both string input and AST objects with a `name` property.
+-   **`parseType()`**: Sets the node's type. Always returns `"variable"`.
+
+## Examples
+
+#### Creating Variables
+
+```javascript
+import { omdVariableNode } from '@teachinglab/omd';
+import * as math from 'mathjs';
+
+// From a name string
+const nodeX = omdVariableNode.fromName('x');
+const nodeTheta = omdVariableNode.fromName('θ');
+
+// From AST data (e.g., from math.js parse result)
+const astNode = math.parse('y');
+const nodeY = new omdVariableNode(astNode);
+
+// Direct string name (less common, but supported)
+const nodeZ = new omdVariableNode('z');
+```
+
+#### Rendering Variables
+
+```javascript
+import { omdVariableNode } from '@teachinglab/omd';
+// import { jsvgContainer } from '@teachinglab/jsvg'; // if rendering directly
+
+const node = omdVariableNode.fromName('x');
+node.setFontSize(24);
+node.initialize(); // Computes dimensions and layout
+
+// To render, typically add to a parent node or an omdDisplay
+// const svgContainer = new jsvgContainer();
+// svgContainer.addChild(node);
+// document.body.appendChild(svgContainer.svgObject);
+```
+
+## See Also
+
+-   [`omdLeafNode`](./omdLeafNode.md) - Parent class.
+-   [`omdNode`](./omdNode.md) - Base class.
+-   [`omdConstantNode`](./omdConstantNode.md) - For numeric values.

package/omd/nodes/omdConstantNode.js

@@ -1,142 +1,142 @@
-import { omdLeafNode } from "./omdLeafNode.js";
-import { omdColor } from "../../src/omdColor.js";
-
-/**
- * Leaf node that represents a numerical constant.
- * @extends omdLeafNode
- */
-export class omdConstantNode extends omdLeafNode {
-    /**
-     * Creates object from AST data.
-     * @param {Object} astNodeData - The AST node containing leaf information.
-     */
-    constructor(nodeData) {
-        super(nodeData);
-        this.type = "omdConstantNode";
-
-        this.number = this.parseNumber(nodeData);
-
-        this.textElement = super.createTextElement(this.number);
-    }
-
-    parseNumber(nodeData) {
-        if (typeof nodeData === "number")
-            return nodeData;
-
-        return nodeData.value;
-    }
-    
-    parseType() {
-        return "constant";
-    }
-
-    /**
-     * Calculates the dimensions of the node.
-     * Adds padding around the node.
-     * @override
-     */
-    computeDimensions() {
-        super.computeDimensions();
-
-        const ratio = this.getFontSize() / this.getRootFontSize();
-        const padding = 4 * ratio;
-        let paddedWidth = this.width + padding;
-        let paddedHeight = this.height + padding;
-        this.setWidthAndHeight(paddedWidth, paddedHeight);
-    }
-
-    /**
-     * Updates the layout of the node.
-     * @override
-     */
-    updateLayout() {
-        super.updateLayout();
-    }
-
-    /**
-     * A constant node is constant if its value is a number.
-     * @returns {boolean}
-     */
-    isConstant() {
-        return typeof this.number === 'number';
-    }
-
-    /**
-     * The value of a constant node is its own value.
-     * @returns {number}
-     */
-    getValue() {
-        return this.number;
-    }
-
-    /**
-     * Converts the constant node to a string.
-     * @returns {string} The string value of the constant.
-     */
-    toString() {
-        return this.number.toString();
-    }
-
-    /**
-     * Evaluates the constant node.
-     * @returns {number} The numeric value of the constant.
-     */
-    evaluate() {
-        return this.number;
-    }
-
-    /**
-     * Retrieves the rational value of the node as a numerator/denominator pair.
-     * @returns {{num: number, den: number}}
-     */
-    getRationalValue() {
-        return { num: this.getValue(), den: 1 };
-    }
-
-    /**
-     * Converts the omdConstantNode to a math.js AST node.
-     * @returns {Object} A math.js-compatible AST node.
-     */
-    toMathJSNode() {
-        const astNode = { 
-            type: 'ConstantNode', 
-            value: this.number,
-            id: this.id,
-            provenance: this.provenance 
-        };
-        // Add a clone method to maintain compatibility with math.js's expectations.
-        astNode.clone = function() {
-            return { ...this };
-        };
-        return astNode;
-    }
-
-    highlight(color) {
-        super.highlight(color);
-        if (this.textElement) {
-            this.textElement.setFillColor(omdColor.white);
-        }
-    }
-
-    clearProvenanceHighlights() {
-        super.clearProvenanceHighlights();
-        if (this.textElement) {
-            this.textElement.setFillColor(omdColor.text);
-        }
-    }
-    
-    /**
-     * Create a constant node from a numeric value.
-     * @param {number} value - The numeric value
-     * @returns {omdConstantNode}
-     * @static
-     */
-    static fromValue(value) {
-        // Create a minimal AST-like object for the constructor
-        const astNodeData = {
-            type: 'ConstantNode',
-            value: value
-        };
-        return new omdConstantNode(astNodeData);
-    }
+import { omdLeafNode } from "./omdLeafNode.js";
+import { omdColor } from "../../src/omdColor.js";
+
+/**
+ * Leaf node that represents a numerical constant.
+ * @extends omdLeafNode
+ */
+export class omdConstantNode extends omdLeafNode {
+    /**
+     * Creates object from AST data.
+     * @param {Object} astNodeData - The AST node containing leaf information.
+     */
+    constructor(nodeData) {
+        super(nodeData);
+        this.type = "omdConstantNode";
+
+        this.number = this.parseNumber(nodeData);
+
+        this.textElement = super.createTextElement(this.number);
+    }
+
+    parseNumber(nodeData) {
+        if (typeof nodeData === "number")
+            return nodeData;
+
+        return nodeData.value;
+    }
+    
+    parseType() {
+        return "constant";
+    }
+
+    /**
+     * Calculates the dimensions of the node.
+     * Adds padding around the node.
+     * @override
+     */
+    computeDimensions() {
+        super.computeDimensions();
+
+        const ratio = this.getFontSize() / this.getRootFontSize();
+        const padding = 4 * ratio;
+        let paddedWidth = this.width + padding;
+        let paddedHeight = this.height + padding;
+        this.setWidthAndHeight(paddedWidth, paddedHeight);
+    }
+
+    /**
+     * Updates the layout of the node.
+     * @override
+     */
+    updateLayout() {
+        super.updateLayout();
+    }
+
+    /**
+     * A constant node is constant if its value is a number.
+     * @returns {boolean}
+     */
+    isConstant() {
+        return typeof this.number === 'number';
+    }
+
+    /**
+     * The value of a constant node is its own value.
+     * @returns {number}
+     */
+    getValue() {
+        return this.number;
+    }
+
+    /**
+     * Converts the constant node to a string.
+     * @returns {string} The string value of the constant.
+     */
+    toString() {
+        return this.number.toString();
+    }
+
+    /**
+     * Evaluates the constant node.
+     * @returns {number} The numeric value of the constant.
+     */
+    evaluate() {
+        return this.number;
+    }
+
+    /**
+     * Retrieves the rational value of the node as a numerator/denominator pair.
+     * @returns {{num: number, den: number}}
+     */
+    getRationalValue() {
+        return { num: this.getValue(), den: 1 };
+    }
+
+    /**
+     * Converts the omdConstantNode to a math.js AST node.
+     * @returns {Object} A math.js-compatible AST node.
+     */
+    toMathJSNode() {
+        const astNode = { 
+            type: 'ConstantNode', 
+            value: this.number,
+            id: this.id,
+            provenance: this.provenance 
+        };
+        // Add a clone method to maintain compatibility with math.js's expectations.
+        astNode.clone = function() {
+            return { ...this };
+        };
+        return astNode;
+    }
+
+    highlight(color) {
+        super.highlight(color);
+        if (this.textElement) {
+            this.textElement.setFillColor(omdColor.white);
+        }
+    }
+
+    clearProvenanceHighlights() {
+        super.clearProvenanceHighlights();
+        if (this.textElement) {
+            this.textElement.setFillColor(omdColor.text);
+        }
+    }
+    
+    /**
+     * Create a constant node from a numeric value.
+     * @param {number} value - The numeric value
+     * @returns {omdConstantNode}
+     * @static
+     */
+    static fromValue(value) {
+        // Create a minimal AST-like object for the constructor
+        const astNodeData = {
+            type: 'ConstantNode',
+            value: value
+        };
+        return new omdConstantNode(astNodeData);
+    }
 }

package/omd/nodes/omdGroupNode.js

@@ -1,68 +1,68 @@
-import { omdLeafNode } from "./omdLeafNode.js";
-
-/**
- * Leaf node that represents a variable.
- * @extends omdLeafNode
- */
-export class omdGroupNode extends omdLeafNode {
-    /**
-     * Creates a leaf node from the AST data.
-     * @param {Object} astNodeData - The AST node containing leaf information.
-     * @param {String} groupingSymbol - A character representing the grouping symbol, e.g. ( or )
-     */
-    constructor(nodeData) {
-        super(nodeData);
-        this.type = "omdGroupNode";
-
-        this.symbol = this.parseSymbol(nodeData);
-        
-        this.textElement = super.createTextElement(this.symbol);
-    }
-
-    parseSymbol(nodeData) {
-        return nodeData;
-    }
-    
-    parseType() {
-        return "parenthesis";
-    }
-
-    clone() {
-        const clone = new omdGroupNode(this.text);
-        
-        // The crucial step: link the clone to its origin
-        clone.provenance.push(this.id);
-        
-        return clone;
-    }
-
-    /**
-     * Calculates the dimensions of the node.
-     * Does NOT add padding, unlike other leaf nodes.
-     * @override
-     */
-    computeDimensions() {
-        super.computeDimensions();
-    }
-
-    /**
-     * Updates the layout of the node.
-     * @override
-     */
-    updateLayout() {
-        super.updateLayout();
-    }
-
-    /**
-     * Converts the omdGroupNode to a math.js AST node.
-     * @returns {Object} A math.js-compatible AST node.
-     */
-    toMathJSNode() {
-        // This node is purely visual (like parentheses); it's represented by its symbol.
-        const astNode = { type: 'SymbolNode', name: this.symbol };
-        astNode.clone = function() {
-            return { ...this };
-        };
-        return astNode;
-    }
+import { omdLeafNode } from "./omdLeafNode.js";
+
+/**
+ * Leaf node that represents a variable.
+ * @extends omdLeafNode
+ */
+export class omdGroupNode extends omdLeafNode {
+    /**
+     * Creates a leaf node from the AST data.
+     * @param {Object} astNodeData - The AST node containing leaf information.
+     * @param {String} groupingSymbol - A character representing the grouping symbol, e.g. ( or )
+     */
+    constructor(nodeData) {
+        super(nodeData);
+        this.type = "omdGroupNode";
+
+        this.symbol = this.parseSymbol(nodeData);
+        
+        this.textElement = super.createTextElement(this.symbol);
+    }
+
+    parseSymbol(nodeData) {
+        return nodeData;
+    }
+    
+    parseType() {
+        return "parenthesis";
+    }
+
+    clone() {
+        const clone = new omdGroupNode(this.text);
+        
+        // The crucial step: link the clone to its origin
+        clone.provenance.push(this.id);
+        
+        return clone;
+    }
+
+    /**
+     * Calculates the dimensions of the node.
+     * Does NOT add padding, unlike other leaf nodes.
+     * @override
+     */
+    computeDimensions() {
+        super.computeDimensions();
+    }
+
+    /**
+     * Updates the layout of the node.
+     * @override
+     */
+    updateLayout() {
+        super.updateLayout();
+    }
+
+    /**
+     * Converts the omdGroupNode to a math.js AST node.
+     * @returns {Object} A math.js-compatible AST node.
+     */
+    toMathJSNode() {
+        // This node is purely visual (like parentheses); it's represented by its symbol.
+        const astNode = { type: 'SymbolNode', name: this.symbol };
+        astNode.clone = function() {
+            return { ...this };
+        };
+        return astNode;
+    }
 }