@teachinglab/omd 0.3.0 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/docs/api/configuration-options.md +198 -198
  2. package/docs/api/eventManager.md +82 -82
  3. package/docs/api/focusFrameManager.md +144 -144
  4. package/docs/api/index.md +105 -105
  5. package/docs/api/main.md +62 -62
  6. package/docs/api/omdBinaryExpressionNode.md +86 -86
  7. package/docs/api/omdCanvas.md +83 -83
  8. package/docs/api/omdConfigManager.md +112 -112
  9. package/docs/api/omdConstantNode.md +52 -52
  10. package/docs/api/omdDisplay.md +87 -87
  11. package/docs/api/omdEquationNode.md +174 -174
  12. package/docs/api/omdEquationSequenceNode.md +258 -258
  13. package/docs/api/omdEquationStack.md +156 -156
  14. package/docs/api/omdFunctionNode.md +82 -82
  15. package/docs/api/omdGroupNode.md +78 -78
  16. package/docs/api/omdHelpers.md +87 -87
  17. package/docs/api/omdLeafNode.md +85 -85
  18. package/docs/api/omdNode.md +201 -201
  19. package/docs/api/omdOperationDisplayNode.md +117 -117
  20. package/docs/api/omdOperatorNode.md +91 -91
  21. package/docs/api/omdParenthesisNode.md +133 -133
  22. package/docs/api/omdPopup.md +191 -191
  23. package/docs/api/omdPowerNode.md +131 -131
  24. package/docs/api/omdRationalNode.md +144 -144
  25. package/docs/api/omdSimplification.md +78 -78
  26. package/docs/api/omdSqrtNode.md +144 -144
  27. package/docs/api/omdStepVisualizer.md +146 -146
  28. package/docs/api/omdStepVisualizerHighlighting.md +65 -65
  29. package/docs/api/omdStepVisualizerInteractiveSteps.md +108 -108
  30. package/docs/api/omdStepVisualizerLayout.md +70 -70
  31. package/docs/api/omdStepVisualizerTextBoxes.md +76 -76
  32. package/docs/api/omdTranscriptionService.md +95 -95
  33. package/docs/api/omdTreeDiff.md +169 -169
  34. package/docs/api/omdUnaryExpressionNode.md +137 -137
  35. package/docs/api/omdUtilities.md +82 -82
  36. package/docs/api/omdVariableNode.md +123 -123
  37. package/omd/nodes/omdConstantNode.js +141 -141
  38. package/omd/nodes/omdGroupNode.js +67 -67
  39. package/omd/nodes/omdLeafNode.js +76 -76
  40. package/omd/nodes/omdOperatorNode.js +108 -108
  41. package/omd/nodes/omdParenthesisNode.js +292 -292
  42. package/omd/nodes/omdPowerNode.js +235 -235
  43. package/omd/nodes/omdRationalNode.js +295 -295
  44. package/omd/nodes/omdVariableNode.js +122 -122
  45. package/omd/simplification/omdSimplification.js +140 -140
  46. package/omd/step-visualizer/omdStepVisualizer.js +947 -947
  47. package/omd/step-visualizer/omdStepVisualizerLayout.js +892 -892
  48. package/package.json +2 -1
  49. package/src/index.js +11 -0
  50. package/src/omdBalanceHanger.js +2 -1
  51. package/src/omdEquation.js +1 -1
  52. package/src/omdNumber.js +1 -1
  53. package/src/omdNumberLine.js +13 -7
  54. package/src/omdRatioChart.js +19 -0
  55. package/src/omdShapes.js +1 -1
  56. package/src/omdTapeDiagram.js +1 -1
  57. package/src/omdTerm.js +1 -1
@@ -1,141 +1,141 @@
1
- # omdEquationStack
2
-
3
- A renderable component that bundles a sequence of mathematical equations with optional UI controls (toolbar). It extends `jsvgGroup` and acts as a node that can be rendered by an `omdDisplay`.
4
-
5
- ## Class Definition
6
-
7
- ```js
8
- import { omdEquationStack } from './omd/core/omdEquationStack.js';
9
- ```
10
-
11
- ## Constructor
12
-
13
- ### `new omdEquationStack(steps, options)`
14
-
15
- Creates a new `omdEquationStack` instance.
16
-
17
- - **`steps`** (`Array<omdNode>`, optional): An initial array of equation steps. Default: empty array.
18
- - **`options`** (`object`, optional): Configuration options:
19
- - **`toolbar`** (`boolean` | `object`): If `true`, creates a toolbar for equation operations. Can also be an object for more granular control:
20
- - `enabled` (`boolean`): Whether the toolbar is enabled. Default: `false`.
21
- - `position` (`string`): Where the toolbar should be positioned (`'bottom'`, `'overlay-bottom'`). Default: `'bottom'`.
22
- - `showUndoButton` (`boolean`): Whether to show an undo button. Default: `false`.
23
- - `onUndo` (`function`): Custom undo handler. If not provided, it attempts to call `window.onOMDToolbarUndo`.
24
- - `overlayPadding` (`number`): Padding from the bottom edge when `position` is `'overlay-bottom'`. Default: `34`.
25
- - **`stepVisualizer`** (`boolean`): If `true`, the underlying sequence will be an `omdStepVisualizer` instead of a plain `omdEquationSequenceNode`. Default: `false`.
26
- - **`styling`** (`object`): Styling options for the equation stack:
27
- - `equationBackground` (`object`): Default background style for equation steps (e.g., `{ backgroundColor: '#f0f0f0', cornerRadius: 8, pill: true }`).
28
-
29
- ## Public Properties
30
-
31
- - **`sequence`** (`omdEquationSequenceNode` | `omdStepVisualizer`): The underlying sequence component that manages the equation steps.
32
- - **`toolbar`** (`omdToolbar` | `undefined`): The toolbar component instance, if enabled.
33
- - **`layoutGroup`** (`jsvgLayoutGroup`): The internal layout container that arranges the sequence and toolbar vertically.
34
- - **`options`** (`object`): The merged configuration options passed to the constructor.
35
- - **`overlayPadding`** (`number`): The calculated padding for the toolbar when it's in an overlay position.
36
-
37
- ## Public Methods
38
-
39
- ### `updateLayout()`
40
-
41
- Updates the layout and positioning of internal components. This method ensures the sequence and toolbar are correctly arranged and that the toolbar is horizontally centered if it's in-flow.
42
-
43
- ### `getSequence()`
44
-
45
- Returns the underlying sequence instance (either `omdEquationSequenceNode` or `omdStepVisualizer`).
46
-
47
- - **Returns**: `omdEquationSequenceNode` | `omdStepVisualizer`.
48
-
49
- ### `getToolbar()`
50
-
51
- Returns the toolbar instance, if one was created during construction.
52
-
53
- - **Returns**: `omdToolbar` | `undefined`.
54
-
55
- ### `getOverlayPadding()`
56
-
57
- Returns the padding value used for positioning the toolbar when it's in an overlay mode.
58
-
59
- - **Returns**: `number`.
60
-
61
- ### `getToolbarVisualHeight()`
62
-
63
- Returns the unscaled visual height of the toolbar's background element, if the toolbar is present.
64
-
65
- - **Returns**: `number`.
66
-
67
- ### `isToolbarOverlay()`
68
-
69
- Checks if the toolbar is configured to be overlaid at the bottom of the container.
70
-
71
- - **Returns**: `boolean`.
72
-
73
- ### `positionToolbarOverlay(containerWidth, containerHeight, padding)`
74
-
75
- Positions the toolbar overlay at the bottom center of the container. This method is typically called by the `omdDisplay` to ensure the toolbar remains visible and correctly placed even when the main content scales.
76
-
77
- - **`containerWidth`** (`number`): The width of the parent container.
78
- - **`containerHeight`** (`number`): The height of the parent container.
79
- - **`padding`** (`number`, optional): Padding from the bottom edge. Default: `16`.
80
-
81
- ### `undoLastOperation()`
82
-
83
- Removes the last equation step and any preceding operation display node from the sequence. This method also triggers a re-layout and updates any associated step visualizer.
84
-
85
- - **Returns**: `boolean` - `true` if an operation was successfully undone, `false` otherwise.
86
-
87
- ## Usage
88
-
89
- The `omdEquationStack` component is a complete equation solving interface that combines an equation sequence with an optional toolbar. It automatically handles layout and positioning.
90
-
91
- ```javascript
92
- import { omdDisplay } from 'omd';
93
- import { omdEquationStack } from 'omd';
94
- import { omdEquationNode } from 'omd';
95
-
96
- // Create display
97
- const container = document.getElementById('math-display');
98
- const display = new omdDisplay(container);
99
-
100
- // Create equation steps
101
- const steps = [
102
- omdEquationNode.fromString('2x + 3 = 11'),
103
- omdEquationNode.fromString('2x = 8'),
104
- omdEquationNode.fromString('x = 4')
105
- ];
106
-
107
- // Basic equation stack with toolbar
108
- const stack = new omdEquationStack(steps, {
109
- toolbar: true
110
- });
111
-
112
- // Render the stack
113
- display.render(stack);
114
-
115
- // Alternative: Create with step visualizer and custom toolbar options
116
- const stackWithVisualizer = new omdEquationStack(steps, {
117
- toolbar: {
118
- enabled: true,
119
- showUndoButton: true,
120
- position: 'overlay-bottom'
121
- },
122
- stepVisualizer: true,
123
- styling: {
124
- equationBackground: {
125
- backgroundColor: '#e0f7fa',
126
- cornerRadius: 10,
127
- pill: true
128
- }
129
- }
130
- });
131
-
132
- display.render(stackWithVisualizer);
133
- ```
134
-
135
- ## Integration
136
-
137
- The equation stack integrates seamlessly with the step visualizer:
138
-
1
+ # omdEquationStack
2
+
3
+ A renderable component that bundles a sequence of mathematical equations with optional UI controls (toolbar). It extends `jsvgGroup` and acts as a node that can be rendered by an `omdDisplay`.
4
+
5
+ ## Class Definition
6
+
7
+ ```js
8
+ import { omdEquationStack } from './omd/core/omdEquationStack.js';
9
+ ```
10
+
11
+ ## Constructor
12
+
13
+ ### `new omdEquationStack(steps, options)`
14
+
15
+ Creates a new `omdEquationStack` instance.
16
+
17
+ - **`steps`** (`Array<omdNode>`, optional): An initial array of equation steps. Default: empty array.
18
+ - **`options`** (`object`, optional): Configuration options:
19
+ - **`toolbar`** (`boolean` | `object`): If `true`, creates a toolbar for equation operations. Can also be an object for more granular control:
20
+ - `enabled` (`boolean`): Whether the toolbar is enabled. Default: `false`.
21
+ - `position` (`string`): Where the toolbar should be positioned (`'bottom'`, `'overlay-bottom'`). Default: `'bottom'`.
22
+ - `showUndoButton` (`boolean`): Whether to show an undo button. Default: `false`.
23
+ - `onUndo` (`function`): Custom undo handler. If not provided, it attempts to call `window.onOMDToolbarUndo`.
24
+ - `overlayPadding` (`number`): Padding from the bottom edge when `position` is `'overlay-bottom'`. Default: `34`.
25
+ - **`stepVisualizer`** (`boolean`): If `true`, the underlying sequence will be an `omdStepVisualizer` instead of a plain `omdEquationSequenceNode`. Default: `false`.
26
+ - **`styling`** (`object`): Styling options for the equation stack:
27
+ - `equationBackground` (`object`): Default background style for equation steps (e.g., `{ backgroundColor: '#f0f0f0', cornerRadius: 8, pill: true }`).
28
+
29
+ ## Public Properties
30
+
31
+ - **`sequence`** (`omdEquationSequenceNode` | `omdStepVisualizer`): The underlying sequence component that manages the equation steps.
32
+ - **`toolbar`** (`omdToolbar` | `undefined`): The toolbar component instance, if enabled.
33
+ - **`layoutGroup`** (`jsvgLayoutGroup`): The internal layout container that arranges the sequence and toolbar vertically.
34
+ - **`options`** (`object`): The merged configuration options passed to the constructor.
35
+ - **`overlayPadding`** (`number`): The calculated padding for the toolbar when it's in an overlay position.
36
+
37
+ ## Public Methods
38
+
39
+ ### `updateLayout()`
40
+
41
+ Updates the layout and positioning of internal components. This method ensures the sequence and toolbar are correctly arranged and that the toolbar is horizontally centered if it's in-flow.
42
+
43
+ ### `getSequence()`
44
+
45
+ Returns the underlying sequence instance (either `omdEquationSequenceNode` or `omdStepVisualizer`).
46
+
47
+ - **Returns**: `omdEquationSequenceNode` | `omdStepVisualizer`.
48
+
49
+ ### `getToolbar()`
50
+
51
+ Returns the toolbar instance, if one was created during construction.
52
+
53
+ - **Returns**: `omdToolbar` | `undefined`.
54
+
55
+ ### `getOverlayPadding()`
56
+
57
+ Returns the padding value used for positioning the toolbar when it's in an overlay mode.
58
+
59
+ - **Returns**: `number`.
60
+
61
+ ### `getToolbarVisualHeight()`
62
+
63
+ Returns the unscaled visual height of the toolbar's background element, if the toolbar is present.
64
+
65
+ - **Returns**: `number`.
66
+
67
+ ### `isToolbarOverlay()`
68
+
69
+ Checks if the toolbar is configured to be overlaid at the bottom of the container.
70
+
71
+ - **Returns**: `boolean`.
72
+
73
+ ### `positionToolbarOverlay(containerWidth, containerHeight, padding)`
74
+
75
+ Positions the toolbar overlay at the bottom center of the container. This method is typically called by the `omdDisplay` to ensure the toolbar remains visible and correctly placed even when the main content scales.
76
+
77
+ - **`containerWidth`** (`number`): The width of the parent container.
78
+ - **`containerHeight`** (`number`): The height of the parent container.
79
+ - **`padding`** (`number`, optional): Padding from the bottom edge. Default: `16`.
80
+
81
+ ### `undoLastOperation()`
82
+
83
+ Removes the last equation step and any preceding operation display node from the sequence. This method also triggers a re-layout and updates any associated step visualizer.
84
+
85
+ - **Returns**: `boolean` - `true` if an operation was successfully undone, `false` otherwise.
86
+
87
+ ## Usage
88
+
89
+ The `omdEquationStack` component is a complete equation solving interface that combines an equation sequence with an optional toolbar. It automatically handles layout and positioning.
90
+
91
+ ```javascript
92
+ import { omdDisplay } from 'omd';
93
+ import { omdEquationStack } from 'omd';
94
+ import { omdEquationNode } from 'omd';
95
+
96
+ // Create display
97
+ const container = document.getElementById('math-display');
98
+ const display = new omdDisplay(container);
99
+
100
+ // Create equation steps
101
+ const steps = [
102
+ omdEquationNode.fromString('2x + 3 = 11'),
103
+ omdEquationNode.fromString('2x = 8'),
104
+ omdEquationNode.fromString('x = 4')
105
+ ];
106
+
107
+ // Basic equation stack with toolbar
108
+ const stack = new omdEquationStack(steps, {
109
+ toolbar: true
110
+ });
111
+
112
+ // Render the stack
113
+ display.render(stack);
114
+
115
+ // Alternative: Create with step visualizer and custom toolbar options
116
+ const stackWithVisualizer = new omdEquationStack(steps, {
117
+ toolbar: {
118
+ enabled: true,
119
+ showUndoButton: true,
120
+ position: 'overlay-bottom'
121
+ },
122
+ stepVisualizer: true,
123
+ styling: {
124
+ equationBackground: {
125
+ backgroundColor: '#e0f7fa',
126
+ cornerRadius: 10,
127
+ pill: true
128
+ }
129
+ }
130
+ });
131
+
132
+ display.render(stackWithVisualizer);
133
+ ```
134
+
135
+ ## Integration
136
+
137
+ The equation stack integrates seamlessly with the step visualizer:
138
+
139
139
  ```javascript
140
140
  import { omdEquationStack } from 'omd';
141
141
  import { omdEquationNode } from 'omd';
@@ -162,15 +162,15 @@ display.render(stack);
162
162
  // Access the visualizer for programmatic control
163
163
  const visualizer = stack.getSequence();
164
164
  // visualizer.nextStep(); // Progress through solution steps if interactive
165
- ```
166
-
167
- ## Layout Behavior
168
-
169
- The equation stack automatically manages its internal layout:
170
- - The sequence is positioned at the top
171
- - The toolbar (if present) is centered below the sequence
172
- - Layout updates automatically when content changes
173
-
165
+ ```
166
+
167
+ ## Layout Behavior
168
+
169
+ The equation stack automatically manages its internal layout:
170
+ - The sequence is positioned at the top
171
+ - The toolbar (if present) is centered below the sequence
172
+ - Layout updates automatically when content changes
173
+
174
174
  ```javascript
175
175
  // Create a stack and let it handle layout automatically
176
176
  const stack = new omdEquationStack(steps, { toolbar: true });
@@ -181,13 +181,13 @@ stack.updateLayout();
181
181
  // Access components
182
182
  const sequence = stack.getSequence();
183
183
  const toolbar = stack.getToolbar();
184
- ```
185
-
186
- ---
187
-
188
- ### See Also
189
-
190
- - [`omdEquationSequenceNode`](./omdEquationSequenceNode.md)
191
- - [`omdStepVisualizer`](./omdStepVisualizer.md)
192
- - [`omdToolbar`](./omdToolbar.md)
184
+ ```
185
+
186
+ ---
187
+
188
+ ### See Also
189
+
190
+ - [`omdEquationSequenceNode`](./omdEquationSequenceNode.md)
191
+ - [`omdStepVisualizer`](./omdStepVisualizer.md)
192
+ - [`omdToolbar`](./omdToolbar.md)
193
193
  - [`jsvgGroup`](../../jsvg/jsvg.js)
@@ -1,83 +1,83 @@
1
- # omdFunctionNode
2
-
3
- Represents a mathematical function call, such as `sin(x)`, `sqrt(9)`, or `log(x, 10)`. This node handles the rendering of the function name, its arguments, and surrounding parentheses. It supports evaluation, simplification, and conversion to/from math.js AST.
4
-
5
- ## Class Definition
6
-
7
- ```javascript
8
- export class omdFunctionNode extends omdNode
9
- ```
10
-
11
- ## Constructor
12
-
13
- ### `new omdFunctionNode(astNodeData)`
14
-
15
- Creates a new `omdFunctionNode` instance.
16
-
17
- - **`astNodeData`** (`object`): The math.js AST node for the function. It should contain:
18
- - `fn.name` or `name`: The name of the function (e.g., `"sin"`, `"log"`).
19
- - `args`: An array of AST nodes for the function's arguments.
20
-
21
- ## Static Methods
22
-
23
- ### `fromString(functionString)`
24
-
25
- Creates an `omdFunctionNode` from a string representation of a function call. This method requires `window.math` (math.js library) to be available globally for parsing.
26
-
27
- - **`functionString`** (`string`): The function call as a string (e.g., `"sqrt(16)"`, `"log(100, 10)"`).
28
- - **Returns**: `omdFunctionNode` - A new instance of `omdFunctionNode`.
29
- - **Throws**: `Error` if `math.js` is not available, if the string cannot be parsed, or if it does not represent a valid function call.
30
-
31
- ## Public Properties
32
-
33
- - **`functionName`** (`string`): The name of the function (e.g., `"sin"`, `"log"`).
34
- - **`args`** (`Array<omdNode>`): An array of `omdNode` instances representing the arguments of the function.
35
-
36
- ## Public Methods
37
-
38
- ### `computeDimensions()`
39
-
40
- Calculates the bounding box of the function node, taking into account the dimensions of the function name, arguments, and parentheses. It also sets the font sizes for the function name and arguments (arguments are typically scaled down slightly).
41
-
42
- ### `updateLayout()`
43
-
44
- Positions the function name, arguments, and parentheses within the node's bounding box. It ensures proper spacing and vertical alignment of all elements.
45
-
46
- ### `highlightAll()`
47
-
48
- Applies a highlight to the function node itself (its background rectangle) and recursively highlights all of its argument nodes.
49
-
50
- ### `unhighlightAll()`
51
-
52
- Removes the highlight from the function node and recursively unhighlights all of its argument nodes.
53
-
54
- ### `clone()`
55
-
56
- Creates a deep, structural clone of the function node, including all its argument nodes and their associated SVG elements. The clone's provenance array is updated to include the original node's ID.
57
-
58
- - **Returns**: `omdFunctionNode` - A new, identical instance of the function node.
59
-
60
- ### `toMathJSNode()`
61
-
62
- Converts the `omdFunctionNode` back into its math.js AST representation. This includes converting its function name and all argument nodes.
63
-
64
- - **Returns**: `object` - A math.js-compatible `FunctionNode` AST object.
65
-
66
- ### `toString()`
67
-
68
- Converts the function node to its string representation (e.g., `"sqrt(x^2)"`, `"log(100, 10)"`).
69
-
70
- - **Returns**: `string` - The function as a string.
71
-
72
- ### `evaluate(variables)`
73
-
74
- Evaluates the function by first evaluating its arguments and then applying the function to the results. It primarily uses `window.math` (math.js) for evaluation. If `math.js` is not available, it falls back to standard JavaScript `Math` functions for common cases (e.g., `sin`, `cos`, `sqrt`).
75
-
76
- - **`variables`** (`object`, optional): A map of variable names to their numeric values (e.g., `{ x: 2 }`).
77
- - **Returns**: `number` - The result of the function evaluation.
78
- - **Throws**: `Error` if the function is unknown or cannot be evaluated.
79
-
80
- ## Internal Methods
81
-
82
- - **`createTextElements()`**: Creates `jsvgTextLine` elements for the function name and parentheses.
1
+ # omdFunctionNode
2
+
3
+ Represents a mathematical function call, such as `sin(x)`, `sqrt(9)`, or `log(x, 10)`. This node handles the rendering of the function name, its arguments, and surrounding parentheses. It supports evaluation, simplification, and conversion to/from math.js AST.
4
+
5
+ ## Class Definition
6
+
7
+ ```javascript
8
+ export class omdFunctionNode extends omdNode
9
+ ```
10
+
11
+ ## Constructor
12
+
13
+ ### `new omdFunctionNode(astNodeData)`
14
+
15
+ Creates a new `omdFunctionNode` instance.
16
+
17
+ - **`astNodeData`** (`object`): The math.js AST node for the function. It should contain:
18
+ - `fn.name` or `name`: The name of the function (e.g., `"sin"`, `"log"`).
19
+ - `args`: An array of AST nodes for the function's arguments.
20
+
21
+ ## Static Methods
22
+
23
+ ### `fromString(functionString)`
24
+
25
+ Creates an `omdFunctionNode` from a string representation of a function call. This method requires `window.math` (math.js library) to be available globally for parsing.
26
+
27
+ - **`functionString`** (`string`): The function call as a string (e.g., `"sqrt(16)"`, `"log(100, 10)"`).
28
+ - **Returns**: `omdFunctionNode` - A new instance of `omdFunctionNode`.
29
+ - **Throws**: `Error` if `math.js` is not available, if the string cannot be parsed, or if it does not represent a valid function call.
30
+
31
+ ## Public Properties
32
+
33
+ - **`functionName`** (`string`): The name of the function (e.g., `"sin"`, `"log"`).
34
+ - **`args`** (`Array<omdNode>`): An array of `omdNode` instances representing the arguments of the function.
35
+
36
+ ## Public Methods
37
+
38
+ ### `computeDimensions()`
39
+
40
+ Calculates the bounding box of the function node, taking into account the dimensions of the function name, arguments, and parentheses. It also sets the font sizes for the function name and arguments (arguments are typically scaled down slightly).
41
+
42
+ ### `updateLayout()`
43
+
44
+ Positions the function name, arguments, and parentheses within the node's bounding box. It ensures proper spacing and vertical alignment of all elements.
45
+
46
+ ### `highlightAll()`
47
+
48
+ Applies a highlight to the function node itself (its background rectangle) and recursively highlights all of its argument nodes.
49
+
50
+ ### `unhighlightAll()`
51
+
52
+ Removes the highlight from the function node and recursively unhighlights all of its argument nodes.
53
+
54
+ ### `clone()`
55
+
56
+ Creates a deep, structural clone of the function node, including all its argument nodes and their associated SVG elements. The clone's provenance array is updated to include the original node's ID.
57
+
58
+ - **Returns**: `omdFunctionNode` - A new, identical instance of the function node.
59
+
60
+ ### `toMathJSNode()`
61
+
62
+ Converts the `omdFunctionNode` back into its math.js AST representation. This includes converting its function name and all argument nodes.
63
+
64
+ - **Returns**: `object` - A math.js-compatible `FunctionNode` AST object.
65
+
66
+ ### `toString()`
67
+
68
+ Converts the function node to its string representation (e.g., `"sqrt(x^2)"`, `"log(100, 10)"`).
69
+
70
+ - **Returns**: `string` - The function as a string.
71
+
72
+ ### `evaluate(variables)`
73
+
74
+ Evaluates the function by first evaluating its arguments and then applying the function to the results. It primarily uses `window.math` (math.js) for evaluation. If `math.js` is not available, it falls back to standard JavaScript `Math` functions for common cases (e.g., `sin`, `cos`, `sqrt`).
75
+
76
+ - **`variables`** (`object`, optional): A map of variable names to their numeric values (e.g., `{ x: 2 }`).
77
+ - **Returns**: `number` - The result of the function evaluation.
78
+ - **Throws**: `Error` if the function is unknown or cannot be evaluated.
79
+
80
+ ## Internal Methods
81
+
82
+ - **`createTextElements()`**: Creates `jsvgTextLine` elements for the function name and parentheses.
83
83
  - **`createArgumentNodes()`**: Iterates through the AST arguments, creates corresponding `omdNode` instances for each, and adds them as children.
@@ -1,79 +1,79 @@
1
- # omdGroupNode
2
-
3
- Represents a single grouping symbol, such as `(` or `)`, as a leaf node in the expression tree. This node is primarily used for visual representation and layout, rather than mathematical operations.
4
-
5
- ## Class Definition
6
-
7
- ```javascript
8
- export class omdGroupNode extends omdLeafNode
9
- ```
10
-
11
- ## Constructor
12
-
13
- ### `new omdGroupNode(nodeData)`
14
-
15
- Creates a new `omdGroupNode` instance.
16
-
17
- - **`nodeData`** (`string`): The single character string representing the grouping symbol (e.g., `'('`, `')'`, `'['`, `']'`).
18
-
19
- ## Public Properties
20
-
21
- - **`symbol`** (`string`): The grouping symbol character (e.g., `'('`).
22
- - **`type`** (`string`): Always `"parenthesis"` for this node type.
23
- - **`textElement`** (`jsvgTextLine`): The internal `jsvgTextLine` instance responsible for rendering the symbol.
24
-
25
- ## Public Methods
26
-
27
- ### `clone()`
28
-
29
- Creates a deep clone of the group node. The new node's `provenance` array is updated to include the original node's ID.
30
-
31
- - **Returns**: `omdGroupNode` - A new, identical instance of the group node.
32
-
33
- ### `computeDimensions()`
34
-
35
- Calculates the dimensions of the node based on its text content. Unlike other leaf nodes, `omdGroupNode` does *not* add extra padding around the symbol, allowing for tighter visual integration.
36
-
37
- - **Overrides**: `omdLeafNode.computeDimensions()`.
38
-
39
- ### `updateLayout()`
40
-
41
- Updates the position of the node's internal text element. This method primarily calls the superclass's `updateLayout`.
42
-
43
- - **Overrides**: `omdLeafNode.updateLayout()`.
44
-
45
- ### `toMathJSNode()`
46
-
47
- Converts the `omdGroupNode` to a math.js-compatible AST format. It represents the grouping symbol as a `SymbolNode`.
48
-
49
- - **Returns**: `object` - A math.js-compatible AST node with `type: "SymbolNode"` and `name` set to the grouping symbol. The returned object also includes a `clone` method for compatibility.
50
-
51
- ## Internal Methods
52
-
53
- - **`parseSymbol(nodeData)`**: Extracts the symbol from the constructor's `nodeData`. Returns the input string unchanged.
54
- - **`parseType()`**: Sets the node's type. Always returns `"parenthesis"`.
55
-
56
- ## Example
57
-
58
- ```javascript
59
- // Create grouping symbols
60
- const leftParen = new omdGroupNode('(');
61
- const rightParen = new omdGroupNode(')');
62
- const leftBracket = new omdGroupNode('[');
63
-
64
- // Render a symbol
65
- const node = new omdGroupNode('(');
66
- node.setFontSize(24);
67
- node.initialize(); // Computes dimensions and layout
68
-
69
- // Add to an SVG container to display
70
- // const svgContainer = new jsvgContainer();
71
- // svgContainer.addChild(node);
72
- // document.body.appendChild(svgContainer.svgObject);
73
- ```
74
-
75
- ## See Also
76
-
77
- - [`omdLeafNode`](./omdLeafNode.md) - The parent class for all leaf nodes.
78
- - [`omdNode`](./omdNode.md) - The base class for all OMD nodes.
1
+ # omdGroupNode
2
+
3
+ Represents a single grouping symbol, such as `(` or `)`, as a leaf node in the expression tree. This node is primarily used for visual representation and layout, rather than mathematical operations.
4
+
5
+ ## Class Definition
6
+
7
+ ```javascript
8
+ export class omdGroupNode extends omdLeafNode
9
+ ```
10
+
11
+ ## Constructor
12
+
13
+ ### `new omdGroupNode(nodeData)`
14
+
15
+ Creates a new `omdGroupNode` instance.
16
+
17
+ - **`nodeData`** (`string`): The single character string representing the grouping symbol (e.g., `'('`, `')'`, `'['`, `']'`).
18
+
19
+ ## Public Properties
20
+
21
+ - **`symbol`** (`string`): The grouping symbol character (e.g., `'('`).
22
+ - **`type`** (`string`): Always `"parenthesis"` for this node type.
23
+ - **`textElement`** (`jsvgTextLine`): The internal `jsvgTextLine` instance responsible for rendering the symbol.
24
+
25
+ ## Public Methods
26
+
27
+ ### `clone()`
28
+
29
+ Creates a deep clone of the group node. The new node's `provenance` array is updated to include the original node's ID.
30
+
31
+ - **Returns**: `omdGroupNode` - A new, identical instance of the group node.
32
+
33
+ ### `computeDimensions()`
34
+
35
+ Calculates the dimensions of the node based on its text content. Unlike other leaf nodes, `omdGroupNode` does *not* add extra padding around the symbol, allowing for tighter visual integration.
36
+
37
+ - **Overrides**: `omdLeafNode.computeDimensions()`.
38
+
39
+ ### `updateLayout()`
40
+
41
+ Updates the position of the node's internal text element. This method primarily calls the superclass's `updateLayout`.
42
+
43
+ - **Overrides**: `omdLeafNode.updateLayout()`.
44
+
45
+ ### `toMathJSNode()`
46
+
47
+ Converts the `omdGroupNode` to a math.js-compatible AST format. It represents the grouping symbol as a `SymbolNode`.
48
+
49
+ - **Returns**: `object` - A math.js-compatible AST node with `type: "SymbolNode"` and `name` set to the grouping symbol. The returned object also includes a `clone` method for compatibility.
50
+
51
+ ## Internal Methods
52
+
53
+ - **`parseSymbol(nodeData)`**: Extracts the symbol from the constructor's `nodeData`. Returns the input string unchanged.
54
+ - **`parseType()`**: Sets the node's type. Always returns `"parenthesis"`.
55
+
56
+ ## Example
57
+
58
+ ```javascript
59
+ // Create grouping symbols
60
+ const leftParen = new omdGroupNode('(');
61
+ const rightParen = new omdGroupNode(')');
62
+ const leftBracket = new omdGroupNode('[');
63
+
64
+ // Render a symbol
65
+ const node = new omdGroupNode('(');
66
+ node.setFontSize(24);
67
+ node.initialize(); // Computes dimensions and layout
68
+
69
+ // Add to an SVG container to display
70
+ // const svgContainer = new jsvgContainer();
71
+ // svgContainer.addChild(node);
72
+ // document.body.appendChild(svgContainer.svgObject);
73
+ ```
74
+
75
+ ## See Also
76
+
77
+ - [`omdLeafNode`](./omdLeafNode.md) - The parent class for all leaf nodes.
78
+ - [`omdNode`](./omdNode.md) - The base class for all OMD nodes.
79
79
  - [`omdParenthesisNode`](./omdParenthesisNode.md) - For complete parenthetical expressions that contain other nodes.