figureone 1.2.1 → 1.4.0

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

@@ -170,6 +170,9 @@ export type TypeEquationPhrase = string | number | {
  * @property {boolean} [fullContentBounds] - (`false`)
  * @property {boolean} [showContent] - if `false`, a container will be created
  * 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`)
  *
  * @see To test examples, append them to the
  * <a href="#drawing-boilerplate">boilerplate</a>
@@ -236,6 +239,7 @@ export type EQN_Container = {
     scale?: number;
     fullContentBounds?: boolean;
     showContent?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     (number | null | undefined),
@@ -288,6 +292,7 @@ export type EQN_Offset = {
     offset?: TypeParsablePoint;
     inSize?: boolean;
     fullContentBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     (TypeParsablePoint | null | undefined),
@@ -411,6 +416,7 @@ export type EQN_Fraction = {
     offsetY?: number;
     baseline?: 'numerator' | 'denominator' | 'vinculum';
     fullContentBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     string,
@@ -486,6 +492,7 @@ export type EQN_Scale = {
     content: TypeEquationPhrase;
     scale?: number;
     fullContentBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     (number | null | undefined),
@@ -564,6 +571,7 @@ export type EQN_Color = {
     content: TypeEquationPhrase;
     color: TypeColor;
     fullContentBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     TypeColor,
@@ -677,6 +685,7 @@ export type EQN_Bracket = {
     descent?: number;
     fullContentBounds?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     string,
     TypeEquationPhrase,
@@ -812,6 +821,7 @@ export type EQN_Root = {
     rootScale?: number;
     fullContentBounds?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     string,
     TypeEquationPhrase,
@@ -928,6 +938,7 @@ export type EQN_Strike = {
     leftSpace?: number;
     fullContentBounds?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     string,
@@ -1045,6 +1056,7 @@ export type EQN_Box = {
     leftSpace?: number;
     fullContentBounds?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     string,
@@ -1092,6 +1104,7 @@ export type EQN_TouchBox = {
     rightSpace?: number;
     bottomSpace?: number;
     leftSpace?: number;
+    name?: string;
 } | [
     TypeEquationPhrase,
     string,
@@ -1232,6 +1245,7 @@ export type EQN_Bar = {
     descent?: number;
     fullContentBounds?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     (string | null | undefined),
@@ -1403,6 +1417,7 @@ export type EQN_Integral = {
     toYAlign?: 'bottom' | 'top' | 'middle' | 'baseline' | number;
     fullBoundsContent?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     (string | null | undefined),
     (TypeEquationPhrase | null | undefined),
@@ -1543,6 +1558,7 @@ export type EQN_SumOf = {
     toOffset?: TypeParsablePoint;
     fullBoundsContent?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     (string | null | undefined),
     TypeEquationPhrase,
@@ -1675,6 +1691,7 @@ export type EQN_ProdOf = {
     toOffset?: TypeParsablePoint;
     fullBoundsContent?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     (string | null | undefined),
     TypeEquationPhrase,
@@ -1764,6 +1781,7 @@ export type EQN_Subscript = {
     scale?: number;
     offset?: TypeParsablePoint;
     inSize: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     TypeEquationPhrase,
@@ -1831,6 +1849,7 @@ export type EQN_Superscript = {
     scale?: number;
     offset?: TypeParsablePoint;
     inSize: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     TypeEquationPhrase,
@@ -1900,6 +1919,7 @@ export type EQN_SuperscriptSubscript = {
     superscriptOffset?: TypeParsablePoint;
     subscriptOffset?: TypeParsablePoint;
     inSize?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     TypeEquationPhrase,
@@ -2012,6 +2032,7 @@ export type EQN_Comment = {
     inSize?: boolean;
     fullContentBounds?: boolean;
     useFullBounds?: boolean;
+    name?: string;
 } | [
     TypeEquationPhrase,
     TypeEquationPhrase,
@@ -2108,6 +2129,7 @@ export type EQN_StrikeComment = {
     space?: number;
     scale?: number;
     commentSpace?: number;
+    name?: string;
 } | [
     (TypeEquationPhrase | null | undefined),
     (string | null | undefined),
@@ -2184,6 +2206,7 @@ export type EQN_Pad = {
     right?: number;
     bottom?: number;
     left?: number;
+    name?: string;
 } | [
     TypeEquationPhrase,
     (number | null | undefined),
@@ -2306,6 +2329,7 @@ export type EQN_Matrix = {
     yAlign?: 'baseline' | 'middle';
     brac?: EQN_Bracket;
     fullContentBounds?: boolean;
+    name?: string;
 } | [
     ([number, number] | null | undefined),
     (string | null | undefined),
@@ -2460,6 +2484,7 @@ export type EQN_Lines = {
     space?: number;
     yAlign?: 'bottom' | 'top' | 'middle' | number;
     fullContentBounds?: boolean;
+    name?: string;
 };
 /**
  * Annotation options object.
@@ -3214,6 +3239,7 @@ export type EQN_Annotate = {
     leftSpace?: number;
     rightSpace?: number;
     contentScale?: number;
+    name?: string;
 };
 /**
  * Equation Functions.
@@ -3247,6 +3273,7 @@ export declare class EquationFunctions {
     parseContent(content: TypeEquationPhrase | null | undefined): any;
     contentToElement(content: TypeEquationPhrase | Elements | FigureElementPrimitive | FigureElementCollection): Elements;
     eqnMethod(name: string, params: any): BaseAnnotationFunction | Fraction | Matrix | Lines | Scale | Container | Offset | Color | null;
+    dispatchEqnMethod(name: string, params: any): BaseAnnotationFunction | Fraction | Matrix | Lines | Scale | Container | Offset | Color | null;
     /**
      * Equation container function
      * @see {@link EQN_Container} for description and examples