@teachinglab/omd 0.2.10 → 0.3.1

package/docs/api/omdHelpers.md

@@ -1,88 +1,88 @@
-# omdHelpers
-
-`omdHelpers` is a collection of convenience functions designed to simplify common tasks when working with the OMD library. These helpers abstract away underlying complexities, making it easier to create and manipulate mathematical expressions and visualizations.
-
-## Overview
-
-The `omdHelpers` object is exported from the main `omd/core/index.js` entry point, making its functions readily available for use in your project.
-
-## Functions
-
-### `createNodeFromExpression(expression, mathInstance)`
-
-Creates an `omdNode` instance from a string representation of a mathematical expression. This function parses the expression using the provided math.js instance and instantiates the appropriate `omdNode` subclass.
-
--   **`expression`** (`string`): The mathematical expression as a string (e.g., `"x^2 + 2x + 1"`).
--   **`mathInstance`** (`object`): The math.js instance to use for parsing the expression (e.g., `window.math`).
--   **Returns**: `omdNode` - The root `omdNode` of the created expression tree.
-
-```javascript
-import { omdHelpers } from '@teachinglab/omd';
-// Assuming math.js is loaded globally as window.math
-
-const expressionNode = omdHelpers.createNodeFromExpression('2x + 5', window.math);
-// expressionNode will be an instance of omdBinaryExpressionNode or another omdNode subclass
-```
-
-### `createEquation(equationString)`
-
-Creates an `omdEquationNode` instance from a string representation of an equation. This is a specialized helper for equations, ensuring proper parsing and node creation.
-
--   **`equationString`** (`string`): The equation as a string (e.g., `"x + 2 = 5"`).
--   **Returns**: `omdEquationNode` - The created `omdEquationNode`.
-
-```javascript
-import { omdHelpers } from '@teachinglab/omd';
-
-const equation = omdHelpers.createEquation('3y - 7 = 14');
-// equation will be an instance of omdEquationNode
-```
-
-### `createStepVisualizer(equationStrings)`
-
-Creates an `omdStepVisualizer` instance from an array of equation strings. This is useful for quickly setting up a step-by-step solution display.
-
--   **`equationStrings`** (`Array<string>`): An array of strings, where each string represents an equation step (e.g., `["2x = 10", "x = 5"]`).
--   **Returns**: `omdStepVisualizer` - The created `omdStepVisualizer` instance.
-
-```javascript
-import { omdHelpers } from '@teachinglab/omd';
-
-const steps = [
-    '4x + 8 = 20',
-    '4x = 12',
-    'x = 3'
-];
-const visualizer = omdHelpers.createStepVisualizer(steps);
-// visualizer will be an instance of omdStepVisualizer
-```
-
-## Example Usage
-
-```javascript
-import { omdDisplay, omdHelpers } from '@teachinglab/omd';
-// Assuming math.js is loaded globally as window.math
-
-// Get a container element (assuming it exists in your HTML)
-const container = document.getElementById('math-display-area');
-
-// Create an expression node using a helper
-const expression = omdHelpers.createNodeFromExpression('a^2 + b^2', window.math);
-
-// Create an equation using a helper
-const equation = omdHelpers.createEquation('E = mc^2');
-
-// Create a step visualizer using a helper
-const solutionSteps = [
-    'x + 5 = 10',
-    'x = 5'
-];
-const stepVisualizer = omdHelpers.createStepVisualizer(solutionSteps);
-
-// You can then render these nodes using omdDisplay or omdCanvas
-const display = new omdDisplay(container);
-display.render(expression);
-
-// Or for the step visualizer
-// display.render(stepVisualizer);
+# omdHelpers
+
+`omdHelpers` is a collection of convenience functions designed to simplify common tasks when working with the OMD library. These helpers abstract away underlying complexities, making it easier to create and manipulate mathematical expressions and visualizations.
+
+## Overview
+
+The `omdHelpers` object is exported from the main `omd/core/index.js` entry point, making its functions readily available for use in your project.
+
+## Functions
+
+### `createNodeFromExpression(expression, mathInstance)`
+
+Creates an `omdNode` instance from a string representation of a mathematical expression. This function parses the expression using the provided math.js instance and instantiates the appropriate `omdNode` subclass.
+
+-   **`expression`** (`string`): The mathematical expression as a string (e.g., `"x^2 + 2x + 1"`).
+-   **`mathInstance`** (`object`): The math.js instance to use for parsing the expression (e.g., `window.math`).
+-   **Returns**: `omdNode` - The root `omdNode` of the created expression tree.
+
+```javascript
+import { omdHelpers } from '@teachinglab/omd';
+// Assuming math.js is loaded globally as window.math
+
+const expressionNode = omdHelpers.createNodeFromExpression('2x + 5', window.math);
+// expressionNode will be an instance of omdBinaryExpressionNode or another omdNode subclass
+```
+
+### `createEquation(equationString)`
+
+Creates an `omdEquationNode` instance from a string representation of an equation. This is a specialized helper for equations, ensuring proper parsing and node creation.
+
+-   **`equationString`** (`string`): The equation as a string (e.g., `"x + 2 = 5"`).
+-   **Returns**: `omdEquationNode` - The created `omdEquationNode`.
+
+```javascript
+import { omdHelpers } from '@teachinglab/omd';
+
+const equation = omdHelpers.createEquation('3y - 7 = 14');
+// equation will be an instance of omdEquationNode
+```
+
+### `createStepVisualizer(equationStrings)`
+
+Creates an `omdStepVisualizer` instance from an array of equation strings. This is useful for quickly setting up a step-by-step solution display.
+
+-   **`equationStrings`** (`Array<string>`): An array of strings, where each string represents an equation step (e.g., `["2x = 10", "x = 5"]`).
+-   **Returns**: `omdStepVisualizer` - The created `omdStepVisualizer` instance.
+
+```javascript
+import { omdHelpers } from '@teachinglab/omd';
+
+const steps = [
+    '4x + 8 = 20',
+    '4x = 12',
+    'x = 3'
+];
+const visualizer = omdHelpers.createStepVisualizer(steps);
+// visualizer will be an instance of omdStepVisualizer
+```
+
+## Example Usage
+
+```javascript
+import { omdDisplay, omdHelpers } from '@teachinglab/omd';
+// Assuming math.js is loaded globally as window.math
+
+// Get a container element (assuming it exists in your HTML)
+const container = document.getElementById('math-display-area');
+
+// Create an expression node using a helper
+const expression = omdHelpers.createNodeFromExpression('a^2 + b^2', window.math);
+
+// Create an equation using a helper
+const equation = omdHelpers.createEquation('E = mc^2');
+
+// Create a step visualizer using a helper
+const solutionSteps = [
+    'x + 5 = 10',
+    'x = 5'
+];
+const stepVisualizer = omdHelpers.createStepVisualizer(solutionSteps);
+
+// You can then render these nodes using omdDisplay or omdCanvas
+const display = new omdDisplay(container);
+display.render(expression);
+
+// Or for the step visualizer
+// display.render(stepVisualizer);
 ```

package/docs/api/omdLeafNode.md

@@ -1,86 +1,86 @@
-# omdLeafNode
-
-Represents a base class for all leaf nodes in the OMD expression tree, such as constants, variables, operators, and grouping symbols. This class provides fundamental functionalities for handling text content, computing dimensions, and managing layout for single-element nodes.
-
-## Class Definition
-
-```javascript
-export class omdLeafNode extends omdNode
-```
-
-## Constructor
-
-### `new omdLeafNode(astNodeData)`
-
-Creates a new `omdLeafNode` instance. This is an abstract base class; you should use its concrete subclasses (e.g., `omdConstantNode`, `omdVariableNode`) instead.
-
--   **`astNodeData`** (`object`): The abstract syntax tree (AST) node data from a parser like math.js, containing information relevant to the leaf node.
-
-## Public Properties
-
--   **`textElement`** (`jsvgTextLine`): The internal `jsvgTextLine` instance that renders the text content of the leaf node.
-
-## Public Methods
-
-### `clone()`
-
-Creates a deep clone of the leaf node. This method uses the original node's constructor to create a new instance, ensuring that the correct subclass is instantiated. The clone's `provenance` array is updated to include the original node's ID.
-
--   **Returns**: `omdLeafNode` - A new instance of the specific leaf node subclass.
-
-### `updateTextElement(text)`
-
-Updates the text content displayed by the node's `textElement`. After updating the text, you typically need to call `computeDimensions()` and `updateLayout()` to reflect the change visually.
-
--   **`text`** (`string` | `number`): The new text content to display.
-
-### `computeDimensions()`
-
-Calculates the dimensions (width and height) of the node based on its text content and current font size. It uses the `getTextBounds` utility function to accurately measure the text. This method also updates the font size of the internal `textElement`.
-
--   **Overrides**: `omdNode.computeDimensions()`.
-
-### `updateLayout()`
-
-Updates the position of the node's internal text element to center it within the node's bounding box. This method primarily calls the internal `updateTextPosition()`.
-
--   **Overrides**: `omdNode.updateLayout()`.
-
-## Internal Methods
-
--   **`createTextElement(text)`**: Creates and initializes a `jsvgTextLine` element with the given text. It sets the text anchor to `'middle'` and dominant baseline to `'middle'` for proper centering, and adds it as a child of this node.
-    -   **Returns**: `jsvgTextLine` - The created text element.
--   **`updateTextPosition()`**: Positions the `textElement` at the center of the node's calculated width and height.
-
-## Example
-
-```javascript
-// omdLeafNode is an abstract class—use concrete subclasses
-import { omdConstantNode } from './omdConstantNode.js';
-import { omdVariableNode } from './omdVariableNode.js';
-import { omdOperatorNode } from './omdOperatorNode.js';
-
-const constant = new omdConstantNode({ value: 5 });
-const variable = new omdVariableNode({ name: 'x' });
-const operator = new omdOperatorNode({ op: '+' });
-
-// All leaf nodes handle text rendering and layout similarly
-constant.initialize(); // Computes dimensions and layout
-variable.initialize();
-operator.initialize();
-
-// You can then add these to an omdDisplay or other container
-```
-
-## See Also
-
-Concrete implementations:
-
--   [`omdConstantNode`](./omdConstantNode.md) - For numeric values.
--   [`omdVariableNode`](./omdVariableNode.md) - For variables.
--   [`omdOperatorNode`](./omdOperatorNode.md) - For operators.
--   [`omdGroupNode`](./omdGroupNode.md) - For grouping symbols.
-
-Base class:
-
+# omdLeafNode
+
+Represents a base class for all leaf nodes in the OMD expression tree, such as constants, variables, operators, and grouping symbols. This class provides fundamental functionalities for handling text content, computing dimensions, and managing layout for single-element nodes.
+
+## Class Definition
+
+```javascript
+export class omdLeafNode extends omdNode
+```
+
+## Constructor
+
+### `new omdLeafNode(astNodeData)`
+
+Creates a new `omdLeafNode` instance. This is an abstract base class; you should use its concrete subclasses (e.g., `omdConstantNode`, `omdVariableNode`) instead.
+
+-   **`astNodeData`** (`object`): The abstract syntax tree (AST) node data from a parser like math.js, containing information relevant to the leaf node.
+
+## Public Properties
+
+-   **`textElement`** (`jsvgTextLine`): The internal `jsvgTextLine` instance that renders the text content of the leaf node.
+
+## Public Methods
+
+### `clone()`
+
+Creates a deep clone of the leaf node. This method uses the original node's constructor to create a new instance, ensuring that the correct subclass is instantiated. The clone's `provenance` array is updated to include the original node's ID.
+
+-   **Returns**: `omdLeafNode` - A new instance of the specific leaf node subclass.
+
+### `updateTextElement(text)`
+
+Updates the text content displayed by the node's `textElement`. After updating the text, you typically need to call `computeDimensions()` and `updateLayout()` to reflect the change visually.
+
+-   **`text`** (`string` | `number`): The new text content to display.
+
+### `computeDimensions()`
+
+Calculates the dimensions (width and height) of the node based on its text content and current font size. It uses the `getTextBounds` utility function to accurately measure the text. This method also updates the font size of the internal `textElement`.
+
+-   **Overrides**: `omdNode.computeDimensions()`.
+
+### `updateLayout()`
+
+Updates the position of the node's internal text element to center it within the node's bounding box. This method primarily calls the internal `updateTextPosition()`.
+
+-   **Overrides**: `omdNode.updateLayout()`.
+
+## Internal Methods
+
+-   **`createTextElement(text)`**: Creates and initializes a `jsvgTextLine` element with the given text. It sets the text anchor to `'middle'` and dominant baseline to `'middle'` for proper centering, and adds it as a child of this node.
+    -   **Returns**: `jsvgTextLine` - The created text element.
+-   **`updateTextPosition()`**: Positions the `textElement` at the center of the node's calculated width and height.
+
+## Example
+
+```javascript
+// omdLeafNode is an abstract class—use concrete subclasses
+import { omdConstantNode } from './omdConstantNode.js';
+import { omdVariableNode } from './omdVariableNode.js';
+import { omdOperatorNode } from './omdOperatorNode.js';
+
+const constant = new omdConstantNode({ value: 5 });
+const variable = new omdVariableNode({ name: 'x' });
+const operator = new omdOperatorNode({ op: '+' });
+
+// All leaf nodes handle text rendering and layout similarly
+constant.initialize(); // Computes dimensions and layout
+variable.initialize();
+operator.initialize();
+
+// You can then add these to an omdDisplay or other container
+```
+
+## See Also
+
+Concrete implementations:
+
+-   [`omdConstantNode`](./omdConstantNode.md) - For numeric values.
+-   [`omdVariableNode`](./omdVariableNode.md) - For variables.
+-   [`omdOperatorNode`](./omdOperatorNode.md) - For operators.
+-   [`omdGroupNode`](./omdGroupNode.md) - For grouping symbols.
+
+Base class:
+
 -   [`omdNode`](./omdNode.md) - The fundamental base class for all OMD nodes.