figureone 1.4.0 → 1.4.1

package/index.js

@@ -17227,7 +17227,7 @@ function offsetLocationForGlyphs(glyphs, offset) {
 var BaseAnnotationFunction = /*#__PURE__*/function () {
   // Optional caller-supplied identifier, assigned post-dispatch by
   // EquationFunctions.eqnMethod. Has no layout effect; used by
-  // Equation.getElementsInForm to look up the contents of a sub-tree.
+  // Equation.getFunctionElements to look up the contents of a sub-tree.
 
   function BaseAnnotationFunction(content, annotations, glyphs, options) {
     var showContent = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : true;
@@ -17877,7 +17877,7 @@ function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf
 var BaseEquationFunction = /*#__PURE__*/function (_Elements) {
   // Optional caller-supplied identifier, assigned post-dispatch by
   // EquationFunctions.eqnMethod. Has no layout effect; used by
-  // Equation.getElementsInForm to look up the contents of a sub-tree.
+  // Equation.getFunctionElements to look up the contents of a sub-tree.
 
   function BaseEquationFunction(content, glyph, options) {
     var _this;
@@ -21282,34 +21282,37 @@ var Equation = /*#__PURE__*/function (_FigureElementCollect) {
     }
 
     /**
-     * Return all the elements inside the named equation function within a given
-     * form.
+     * Return all the elements inside the named equation function within a form.
      *
      * Any equation function (container, fraction, matrix, etc.) can be tagged
      * with a `name` property in its options — this has no layout effect, but
      * makes the function's sub-tree addressable here.
      *
-     * With `mode: 'first'` (default), returns the elements inside the first
-     * matching function found by a depth-first traversal. With `mode: 'all'`,
-     * walks the entire tree, collects every matching function (including those
-     * nested inside other matches), and returns the de-duplicated union of
-     * their elements.
+     * With `mode: 'all'` (default), walks the entire tree, collects every
+     * matching function (including those nested inside other matches), and
+     * returns the de-duplicated union of their elements. With `mode: 'first'`,
+     * returns only the elements inside the first matching function found by a
+     * depth-first traversal.
+     *
+     * If `formName` is `null` (default), the current form is used.
      *
      * Returns an empty array if the form does not exist, or no matching
      * function is found.
      *
-     * @param {string} formName
      * @param {string} name
-     * @param {'first' | 'all'} [mode] (`'first'`)
+     * @param {string | null} [formName] (`null` — uses current form)
+     * @param {'first' | 'all'} [mode] (`'all'`)
      * @param {boolean} [includeHidden] (`false`)
      * @return {Array<FigureElement>}
      */
   }, {
-    key: "getElementsInForm",
-    value: function getElementsInForm(formName, name) {
-      var mode = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'first';
+    key: "getFunctionElements",
+    value: function getFunctionElements(name) {
+      var formName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
+      var mode = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'all';
       var includeHidden = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
-      var form = this.eqn.forms[formName];
+      var resolvedFormName = formName == null ? this.eqn.currentForm : formName;
+      var form = this.eqn.forms[resolvedFormName];
       if (form == null) {
         return [];
       }
@@ -22990,7 +22993,7 @@ function getFigureElement(elementsObject, name) {
  * around the content, but the content will not be shown (`true`)
  * @property {string} [name] - optional identifier (available on every equation
  * function). Has no effect on layout, but allows the function's contents to be
- * looked up later with {@link Equation.getElementsInForm} (`null`)
+ * looked up later with {@link Equation.getFunctionElements} (`null`)
  *
  * @see To test examples, append them to the
  * <a href="#drawing-boilerplate">boilerplate</a>
@@ -25630,7 +25633,7 @@ var EquationFunctions = /*#__PURE__*/function () {
       var result = this.dispatchEqnMethod(name, params);
       // Allow any equation function to be tagged with a caller-supplied
       // `name` via its options object. The tag has no layout effect; it's
-      // used by Equation.getElementsInForm to look up the function's sub-tree.
+      // used by Equation.getFunctionElements to look up the function's sub-tree.
       if (result != null && params != null && !Array.isArray(params) && _typeof(params) === 'object' && params.name != null && (result instanceof _Elements_BaseEquationFunction__WEBPACK_IMPORTED_MODULE_10__["default"] || result instanceof _Elements_BaseAnnotationFunction__WEBPACK_IMPORTED_MODULE_9__["default"])) {
         result.functionName = params.name;
       }
@@ -80792,8 +80795,8 @@ var tools = {
  */
 
 var Fig = {
-  version: "1.4.0",
-  gitHash: "77f124c53",
+  version: "1.4.1",
+  gitHash: "2fa15b061",
   tools: tools,
   Figure: _js_figure_Figure__WEBPACK_IMPORTED_MODULE_5__["default"],
   Recorder: _js_figure_Recorder_Recorder__WEBPACK_IMPORTED_MODULE_7__.Recorder,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "figureone",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Draw, animate and interact with shapes, text, plots and equations in Javascript. Create interactive slide shows, and interactive videos.",
   "main": "index.js",
   "types": "types/index.d.ts",

package/types/js/figure/Equation/Equation.d.ts

@@ -907,29 +907,30 @@ export declare class Equation extends FigureElementCollection {
      */
     getFormElements(form: string, includeHidden?: boolean): (FigureElementCollection | FigureElementPrimitive | ElementInterface)[];
     /**
-     * Return all the elements inside the named equation function within a given
-     * form.
+     * Return all the elements inside the named equation function within a form.
      *
      * Any equation function (container, fraction, matrix, etc.) can be tagged
      * with a `name` property in its options — this has no layout effect, but
      * makes the function's sub-tree addressable here.
      *
-     * With `mode: 'first'` (default), returns the elements inside the first
-     * matching function found by a depth-first traversal. With `mode: 'all'`,
-     * walks the entire tree, collects every matching function (including those
-     * nested inside other matches), and returns the de-duplicated union of
-     * their elements.
+     * With `mode: 'all'` (default), walks the entire tree, collects every
+     * matching function (including those nested inside other matches), and
+     * returns the de-duplicated union of their elements. With `mode: 'first'`,
+     * returns only the elements inside the first matching function found by a
+     * depth-first traversal.
+     *
+     * If `formName` is `null` (default), the current form is used.
      *
      * Returns an empty array if the form does not exist, or no matching
      * function is found.
      *
-     * @param {string} formName
      * @param {string} name
-     * @param {'first' | 'all'} [mode] (`'first'`)
+     * @param {string | null} [formName] (`null` — uses current form)
+     * @param {'first' | 'all'} [mode] (`'all'`)
      * @param {boolean} [includeHidden] (`false`)
      * @return {Array<FigureElement>}
      */
-    getElementsInForm(formName: string, name: string, mode?: 'first' | 'all', includeHidden?: boolean): any[];
+    getFunctionElements(name: string, formName?: string | null, mode?: 'first' | 'all', includeHidden?: boolean): any[];
     /**
      * Return all the elements that are used in an equation phrase.
      * @param {TypeEquationPhrase} phrase

package/types/js/figure/Equation/EquationFunctions.d.ts

@@ -172,7 +172,7 @@ export type TypeEquationPhrase = string | number | {
  * around the content, but the content will not be shown (`true`)
  * @property {string} [name] - optional identifier (available on every equation
  * function). Has no effect on layout, but allows the function's contents to be
- * looked up later with {@link Equation.getElementsInForm} (`null`)
+ * looked up later with {@link Equation.getFunctionElements} (`null`)
  *
  * @see To test examples, append them to the
  * <a href="#drawing-boilerplate">boilerplate</a>