@teachinglab/omd 0.6.0 → 0.6.2

package/src/omdExpression.js

@@ -1,116 +1,116 @@
-
-
-import { omdColor } from "./omdColor.js";
-import { jsvgLayoutGroup } from "@teachinglab/jsvg";
-import { omdTerm } from "./omdTerm.js";
-import { omdOperator } from "./omdOperator.js";
-import { omdNumber } from "./omdNumber.js";
-import { omdVariable } from "./omdVariable.js";
-import { omdMetaExpression } from "./omdMetaExpression.js"
-import { parseExpressionString } from "./omdUtils.js";
-
-export class omdExpression extends omdMetaExpression
-{
-    constructor()
-    {
-        // initialization
-        super();
-
-        this.type = "omdExpression";
-        this.termSet = [];
-        this.operatorSet = [];
-        
-        this.inset = 5;
-
-        this.expressionStack = new jsvgLayoutGroup();
-        this.expressionStack.setPosition( this.inset, 0 );
-        this.expressionStack.setSpacer(-6);
-        this.addChild( this.expressionStack );
-    }
-
-    loadFromJSON( data )
-    {
-        // Accept either structured object or a plain expression string
-        if ( typeof data === 'string' ) {
-            const parsed = parseExpressionString(data);
-            if ( parsed ) data = parsed;
-        }
-
-        if ( typeof data.termsAndOpers != "undefined" )
-        {
-            for( var i=0; i<data.termsAndOpers.length; i++ )
-            {
-                var elem = data.termsAndOpers[i];
-                if ( elem.omdType == "term" )
-                {
-                    var T = new omdTerm();
-                    T.loadFromJSON( elem );
-                    T.hideBackgroundByDefault();
-                    this.termSet.push( T );
-                    this.expressionStack.addChild( T );
-                }
-                else if ( elem.omdType == "variable" )
-                {
-                    var T = new omdVariable();
-                    T.loadFromJSON( elem );
-                    T.hideBackgroundByDefault();
-                    this.termSet.push( T );
-                    this.expressionStack.addChild( T );
-                }
-                else if ( elem.omdType == "number" )
-                {
-                    var T = new omdNumber();
-                    T.loadFromJSON( elem );
-                    T.hideBackgroundByDefault();
-                    this.termSet.push( T );
-                    this.expressionStack.addChild( T );
-                }
-                else if ( elem.omdType == "operator" )
-                {
-                    var P = new omdOperator();
-                    P.loadFromJSON( elem );
-                    P.hideBackgroundByDefault();
-                    this.operatorSet.push( P );
-                    this.expressionStack.addChild( P );
-                }
-            }
-        }
-
-        this.updateLayout();
-    }
-
-    addTerm( coefficient, variable='', exponent='1' )
-    {
-        var T = new omdTerm( coefficient, variable, exponent );
-        this.termSet.push( T );
-        this.expressionStack.addChild( T );
-        this.updateLayout();
-
-        T.hideBackgroundByDefault();
-    }
-
-    addOperator( oper )
-    {
-        var P = new omdOperator(oper);
-        this.operatorSet.push( P );
-        this.expressionStack.addChild( P );
-        this.updateLayout();
-
-        P.hideBackgroundByDefault();
-    }
-
-    updateLayout()
-    {
-        this.expressionStack.doHorizontalLayout();
-
-        var W = this.expressionStack.width;
-        this.backRect.setWidthAndHeight( W + this.inset*2, 30 );
-
-        this.setWidthAndHeight( this.backRect.width, this.backRect.height );
-
-        // Set individual width/height properties and viewBox for API compatibility
-        this.width = this.backRect.width;
-        this.height = this.backRect.height;
-        this.svgObject.setAttribute('viewBox', `0 0 ${this.width} ${this.height}`);
-    }
+
+
+import { omdColor } from "./omdColor.js";
+import { jsvgLayoutGroup } from "@teachinglab/jsvg";
+import { omdTerm } from "./omdTerm.js";
+import { omdOperator } from "./omdOperator.js";
+import { omdNumber } from "./omdNumber.js";
+import { omdVariable } from "./omdVariable.js";
+import { omdMetaExpression } from "./omdMetaExpression.js"
+import { parseExpressionString } from "./omdUtils.js";
+
+export class omdExpression extends omdMetaExpression
+{
+    constructor()
+    {
+        // initialization
+        super();
+
+        this.type = "omdExpression";
+        this.termSet = [];
+        this.operatorSet = [];
+        
+        this.inset = 5;
+
+        this.expressionStack = new jsvgLayoutGroup();
+        this.expressionStack.setPosition( this.inset, 0 );
+        this.expressionStack.setSpacer(-6);
+        this.addChild( this.expressionStack );
+    }
+
+    loadFromJSON( data )
+    {
+        // Accept either structured object or a plain expression string
+        if ( typeof data === 'string' ) {
+            const parsed = parseExpressionString(data);
+            if ( parsed ) data = parsed;
+        }
+
+        if ( typeof data.termsAndOpers != "undefined" )
+        {
+            for( var i=0; i<data.termsAndOpers.length; i++ )
+            {
+                var elem = data.termsAndOpers[i];
+                if ( elem.omdType == "term" )
+                {
+                    var T = new omdTerm();
+                    T.loadFromJSON( elem );
+                    T.hideBackgroundByDefault();
+                    this.termSet.push( T );
+                    this.expressionStack.addChild( T );
+                }
+                else if ( elem.omdType == "variable" )
+                {
+                    var T = new omdVariable();
+                    T.loadFromJSON( elem );
+                    T.hideBackgroundByDefault();
+                    this.termSet.push( T );
+                    this.expressionStack.addChild( T );
+                }
+                else if ( elem.omdType == "number" )
+                {
+                    var T = new omdNumber();
+                    T.loadFromJSON( elem );
+                    T.hideBackgroundByDefault();
+                    this.termSet.push( T );
+                    this.expressionStack.addChild( T );
+                }
+                else if ( elem.omdType == "operator" )
+                {
+                    var P = new omdOperator();
+                    P.loadFromJSON( elem );
+                    P.hideBackgroundByDefault();
+                    this.operatorSet.push( P );
+                    this.expressionStack.addChild( P );
+                }
+            }
+        }
+
+        this.updateLayout();
+    }
+
+    addTerm( coefficient, variable='', exponent='1' )
+    {
+        var T = new omdTerm( coefficient, variable, exponent );
+        this.termSet.push( T );
+        this.expressionStack.addChild( T );
+        this.updateLayout();
+
+        T.hideBackgroundByDefault();
+    }
+
+    addOperator( oper )
+    {
+        var P = new omdOperator(oper);
+        this.operatorSet.push( P );
+        this.expressionStack.addChild( P );
+        this.updateLayout();
+
+        P.hideBackgroundByDefault();
+    }
+
+    updateLayout()
+    {
+        this.expressionStack.doHorizontalLayout();
+
+        var W = this.expressionStack.width;
+        this.backRect.setWidthAndHeight( W + this.inset*2, 30 );
+
+        this.setWidthAndHeight( this.backRect.width, this.backRect.height );
+
+        // Set individual width/height properties and viewBox for API compatibility
+        this.width = this.backRect.width;
+        this.height = this.backRect.height;
+        this.svgObject.setAttribute('viewBox', `0 0 ${this.width} ${this.height}`);
+    }
 }

package/src/omdFactory.js

@@ -1,150 +1,150 @@
-/**
- * OMD Factory - Creates OMD objects from JSON data
- * 
- * This factory function creates the appropriate OMD object based on the omdType
- * field in the JSON data, eliminating the need for large switch statements.
- * 
- * Usage:
- * import { createFromJSON } from '@teachinglab/omd';
- * 
- * const jsonData = { omdType: 'numberLine', min: 0, max: 10 };
- * const omdObject = createFromJSON(jsonData);
- * 
- * // Optionally load into existing container
- * const svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
- * svg.appendChild(omdObject.svgObject);
- */
-
-import { omdBalanceHanger } from './omdBalanceHanger.js';
-import { omdTable } from './omdTable.js';
-import { omdTapeDiagram } from './omdTapeDiagram.js';
-import { omdCoordinatePlane } from './omdCoordinatePlane.js';
-import { omdNumberLine } from './omdNumberLine.js';
-import { omdNumberTile } from './omdNumberTile.js';
-import { omdRatioChart } from './omdRatioChart.js';
-import { omdTileEquation } from './omdTileEquation.js';
-import { omdSpinner } from './omdSpinner.js';
-import { omdEquation } from './omdEquation.js';
-import { omdExpression } from './omdExpression.js';
-import { omdTerm } from './omdTerm.js';
-import { omdNumber } from './omdNumber.js';
-import { omdVariable } from './omdVariable.js';
-import { omdPowerExpression } from './omdPowerExpression.js';
-import { omdRationalExpression } from './omdRationalExpression.js';
-import { omdFunction } from './omdFunction.js';
-import { 
-    omdRightTriangle,
-    omdIsoscelesTriangle,
-    omdRectangle,
-    omdEllipse,
-    omdCircle,
-    omdRegularPolygon
-} from './omdShapes.js';
-
-/**
- * Map of omdType strings to their corresponding class constructors
- */
-const OMD_TYPE_MAP = {
-    'balanceHanger': omdBalanceHanger,
-    'table': omdTable,
-    'tapeDiagram': omdTapeDiagram,
-    'coordinatePlane': omdCoordinatePlane,
-    'numberLine': omdNumberLine,
-    'numberTile': omdNumberTile,
-    'ratioChart': omdRatioChart,
-    'tileEquation': omdTileEquation,
-    'spinner': omdSpinner,
-    'equation': omdEquation,
-    'expression': omdExpression,
-    'term': omdTerm,
-    'number': omdNumber,
-    'variable': omdVariable,
-    'powerExpression': omdPowerExpression,
-    'rationalExpression': omdRationalExpression,
-    'function': omdFunction,
-    'rightTriangle': omdRightTriangle,
-    'isoscelesTriangle': omdIsoscelesTriangle,
-    'rectangle': omdRectangle,
-    'ellipse': omdEllipse,
-    'circle': omdCircle,
-    'regularPolygon': omdRegularPolygon
-};
-
-/**
- * Creates an OMD object from JSON data
- * 
- * @param {object} jsonData - The JSON data with an omdType field
- * @returns {object} The created OMD object with data loaded
- * @throws {Error} If omdType is missing or unsupported
- * 
- * @example
- * // Create a number line
- * const numberLine = createFromJSON({
- *     omdType: 'numberLine',
- *     min: 0,
- *     max: 10,
- *     dotValues: [2, 5, 8]
- * });
- * 
- * @example
- * // Create a coordinate plane
- * const plane = createFromJSON({
- *     omdType: 'coordinatePlane',
- *     xMin: -10,
- *     xMax: 10,
- *     yMin: -10,
- *     yMax: 10,
- *     graphEquations: [
- *         { equation: 'y = x^2', color: '#e11d48' }
- *     ]
- * });
- * 
- * @example
- * // Create an equation
- * const equation = createFromJSON({
- *     omdType: 'equation',
- *     equation: '2x + 3 = 11'
- * });
- */
-export function createFromJSON(jsonData) {
-    if (!jsonData || typeof jsonData !== 'object') {
-        throw new Error('createFromJSON requires a valid JSON object');
-    }
-    
-    const omdType = jsonData.omdType;
-    
-    if (!omdType) {
-        throw new Error('JSON data must include an "omdType" field');
-    }
-    
-    const Constructor = OMD_TYPE_MAP[omdType];
-    
-    if (!Constructor) {
-        throw new Error(`Unsupported omdType: "${omdType}". Supported types: ${Object.keys(OMD_TYPE_MAP).join(', ')}`);
-    }
-    
-    // Create instance and load data
-    const omdObject = new Constructor();
-    omdObject.loadFromJSON(jsonData);
-    
-    return omdObject;
-}
-
-/**
- * Gets the list of supported OMD types
- * 
- * @returns {string[]} Array of supported omdType strings
- */
-export function getSupportedTypes() {
-    return Object.keys(OMD_TYPE_MAP);
-}
-
-/**
- * Checks if an omdType is supported
- * 
- * @param {string} omdType - The type to check
- * @returns {boolean} True if the type is supported
- */
-export function isTypeSupported(omdType) {
-    return omdType in OMD_TYPE_MAP;
-}
+/**
+ * OMD Factory - Creates OMD objects from JSON data
+ * 
+ * This factory function creates the appropriate OMD object based on the omdType
+ * field in the JSON data, eliminating the need for large switch statements.
+ * 
+ * Usage:
+ * import { createFromJSON } from '@teachinglab/omd';
+ * 
+ * const jsonData = { omdType: 'numberLine', min: 0, max: 10 };
+ * const omdObject = createFromJSON(jsonData);
+ * 
+ * // Optionally load into existing container
+ * const svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
+ * svg.appendChild(omdObject.svgObject);
+ */
+
+import { omdBalanceHanger } from './omdBalanceHanger.js';
+import { omdTable } from './omdTable.js';
+import { omdTapeDiagram } from './omdTapeDiagram.js';
+import { omdCoordinatePlane } from './omdCoordinatePlane.js';
+import { omdNumberLine } from './omdNumberLine.js';
+import { omdNumberTile } from './omdNumberTile.js';
+import { omdRatioChart } from './omdRatioChart.js';
+import { omdTileEquation } from './omdTileEquation.js';
+import { omdSpinner } from './omdSpinner.js';
+import { omdEquation } from './omdEquation.js';
+import { omdExpression } from './omdExpression.js';
+import { omdTerm } from './omdTerm.js';
+import { omdNumber } from './omdNumber.js';
+import { omdVariable } from './omdVariable.js';
+import { omdPowerExpression } from './omdPowerExpression.js';
+import { omdRationalExpression } from './omdRationalExpression.js';
+import { omdFunction } from './omdFunction.js';
+import { 
+    omdRightTriangle,
+    omdIsoscelesTriangle,
+    omdRectangle,
+    omdEllipse,
+    omdCircle,
+    omdRegularPolygon
+} from './omdShapes.js';
+
+/**
+ * Map of omdType strings to their corresponding class constructors
+ */
+const OMD_TYPE_MAP = {
+    'balanceHanger': omdBalanceHanger,
+    'table': omdTable,
+    'tapeDiagram': omdTapeDiagram,
+    'coordinatePlane': omdCoordinatePlane,
+    'numberLine': omdNumberLine,
+    'numberTile': omdNumberTile,
+    'ratioChart': omdRatioChart,
+    'tileEquation': omdTileEquation,
+    'spinner': omdSpinner,
+    'equation': omdEquation,
+    'expression': omdExpression,
+    'term': omdTerm,
+    'number': omdNumber,
+    'variable': omdVariable,
+    'powerExpression': omdPowerExpression,
+    'rationalExpression': omdRationalExpression,
+    'function': omdFunction,
+    'rightTriangle': omdRightTriangle,
+    'isoscelesTriangle': omdIsoscelesTriangle,
+    'rectangle': omdRectangle,
+    'ellipse': omdEllipse,
+    'circle': omdCircle,
+    'regularPolygon': omdRegularPolygon
+};
+
+/**
+ * Creates an OMD object from JSON data
+ * 
+ * @param {object} jsonData - The JSON data with an omdType field
+ * @returns {object} The created OMD object with data loaded
+ * @throws {Error} If omdType is missing or unsupported
+ * 
+ * @example
+ * // Create a number line
+ * const numberLine = createFromJSON({
+ *     omdType: 'numberLine',
+ *     min: 0,
+ *     max: 10,
+ *     dotValues: [2, 5, 8]
+ * });
+ * 
+ * @example
+ * // Create a coordinate plane
+ * const plane = createFromJSON({
+ *     omdType: 'coordinatePlane',
+ *     xMin: -10,
+ *     xMax: 10,
+ *     yMin: -10,
+ *     yMax: 10,
+ *     graphEquations: [
+ *         { equation: 'y = x^2', color: '#e11d48' }
+ *     ]
+ * });
+ * 
+ * @example
+ * // Create an equation
+ * const equation = createFromJSON({
+ *     omdType: 'equation',
+ *     equation: '2x + 3 = 11'
+ * });
+ */
+export function createFromJSON(jsonData) {
+    if (!jsonData || typeof jsonData !== 'object') {
+        throw new Error('createFromJSON requires a valid JSON object');
+    }
+    
+    const omdType = jsonData.omdType;
+    
+    if (!omdType) {
+        throw new Error('JSON data must include an "omdType" field');
+    }
+    
+    const Constructor = OMD_TYPE_MAP[omdType];
+    
+    if (!Constructor) {
+        throw new Error(`Unsupported omdType: "${omdType}". Supported types: ${Object.keys(OMD_TYPE_MAP).join(', ')}`);
+    }
+    
+    // Create instance and load data
+    const omdObject = new Constructor();
+    omdObject.loadFromJSON(jsonData);
+    
+    return omdObject;
+}
+
+/**
+ * Gets the list of supported OMD types
+ * 
+ * @returns {string[]} Array of supported omdType strings
+ */
+export function getSupportedTypes() {
+    return Object.keys(OMD_TYPE_MAP);
+}
+
+/**
+ * Checks if an omdType is supported
+ * 
+ * @param {string} omdType - The type to check
+ * @returns {boolean} True if the type is supported
+ */
+export function isTypeSupported(omdType) {
+    return omdType in OMD_TYPE_MAP;
+}