figureone 0.15.10 → 1.0.0

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

@@ -0,0 +1,118 @@
+import { Point } from '../../../tools/g2';
+import Bounds from './Bounds';
+import type { ElementInterface } from './Element';
+import SymbolNew from '../Symbols/SymbolNew';
+import { FunctionMap } from '../../../tools/FunctionMap';
+import type { TypeColor } from '../../../tools/types';
+export type EQN_Annotation = {
+    xPosition: 'left' | 'center' | 'right' | number;
+    yPosition: 'bottom' | 'baseline' | 'middle' | 'top' | number;
+    xAlign: 'left' | 'center' | 'right' | number;
+    yAlign: 'bottom' | 'baseline' | 'middle' | 'top' | number;
+    offset: Point;
+    scale: number;
+    content: ElementInterface;
+    inSize: boolean;
+    fullContentBounds: boolean;
+    reference?: string;
+};
+export type EQN_EncompassGlyph = {
+    symbol?: string;
+    annotations?: Array<EQN_Annotation>;
+    space: number;
+    topSpace?: number;
+    leftSpace?: number;
+    bottomSpace?: number;
+    rightSpace?: number;
+};
+export type EQN_LineGlyph = {
+    symbol?: string;
+    annotationIndex: number;
+    content: {
+        xAlign: 'left' | 'center' | 'right' | number | string;
+        yAlign: 'bottom' | 'baseline' | 'middle' | 'top' | number | string;
+        space: number;
+    };
+    annotation: {
+        xAlign: 'left' | 'center' | 'right' | number | string;
+        yAlign: 'bottom' | 'baseline' | 'middle' | 'top' | number | string;
+        space: number;
+    };
+};
+export type EQN_LeftRightGlyph = {
+    symbol?: string;
+    annotations?: Array<EQN_Annotation>;
+    space: number;
+    overhang: number;
+    topSpace?: number;
+    bottomSpace?: number;
+    minContentHeight?: number;
+    minContentDescent?: number;
+    minContentAscent?: number;
+    descent?: number;
+    height?: number;
+    yOffset: number;
+    annotationsOverContent?: boolean;
+};
+export type EQN_TopBottomGlyph = {
+    symbol?: string;
+    annotations?: Array<EQN_Annotation>;
+    space: number;
+    overhang: number;
+    width?: number;
+    leftSpace?: number;
+    rightSpace?: number;
+    xOffset: number;
+    annotationsOverContent?: boolean;
+};
+export type TypeAnnotatedGlyph = {
+    glyph: SymbolNew;
+    annotations: Array<EQN_Annotation>;
+    width: number;
+    height: number;
+    location: Point;
+};
+export type EQN_Glyphs = {
+    left?: TypeAnnotatedGlyph & EQN_LeftRightGlyph;
+    right?: TypeAnnotatedGlyph & EQN_LeftRightGlyph;
+    top?: TypeAnnotatedGlyph & EQN_TopBottomGlyph;
+    bottom?: TypeAnnotatedGlyph & EQN_TopBottomGlyph;
+    encompass?: TypeAnnotatedGlyph & EQN_EncompassGlyph;
+    line?: TypeAnnotatedGlyph & EQN_LineGlyph;
+};
+export default class BaseAnnotationFunction implements ElementInterface {
+    ascent: number;
+    descent: number;
+    width: number;
+    location: Point;
+    height: number;
+    scale: number;
+    showContent: boolean;
+    color: TypeColor | null;
+    fullSize: {
+        leftOffset: number;
+        width: number;
+        descent: number;
+        ascent: number;
+        height: number;
+    };
+    fnMap: FunctionMap;
+    content: ElementInterface;
+    annotations: Array<EQN_Annotation>;
+    glyphs: EQN_Glyphs;
+    options: Record<string, any>;
+    constructor(content: ElementInterface, annotations: Array<EQN_Annotation>, glyphs: EQN_Glyphs, options: Record<string, any>, showContent?: boolean);
+    _dup(namedCollection?: Record<string, any>): any;
+    cleanup(): void;
+    getAllElements(includeHidden?: boolean): any[];
+    setPositions(): void;
+    setColor(colorIn?: TypeColor | null): void;
+    offsetLocation(offset?: Point): void;
+    calcSize(location: Point, scale: number): void;
+    setEncompassGlyph(scale: number, contentBoundsIn: Bounds): [Bounds, Bounds];
+    setLineGlyph(annotationBounds: Bounds, contentBounds: Bounds): void;
+    setVerticalGlyph(scale: number, contentBounds: Bounds, glyphName: 'left' | 'right'): [Bounds, Bounds];
+    setHorizontalGlyph(scale: number, contentBoundsIn: Bounds, glyphName: 'top' | 'bottom'): [Bounds, Bounds];
+    setAnnotationPosition(contentToAnnotateBounds: Bounds, annotation: EQN_Annotation, scale: number): void;
+    getBounds(useFullSize?: boolean): Bounds;
+}

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

@@ -0,0 +1,20 @@
+import { Point } from '../../../tools/g2';
+import { Elements } from './Element';
+import Symbol from '../Symbols/SymbolNew';
+import type { TypeColor } from '../../../tools/types';
+export default class BaseEquationFunction extends Elements {
+    contents: Array<Elements | null>;
+    glyphs: Array<Symbol | null | undefined>;
+    glyphLocations: Array<Point>;
+    glyphWidths: Array<number>;
+    glyphHeights: Array<number>;
+    showContent: boolean;
+    options: Record<string, any>;
+    constructor(content: Elements | null | Array<Elements | null>, glyph: Symbol | null | undefined | Array<Symbol | null | undefined>, options: Record<string, any>, showContent?: boolean);
+    _dup(namedCollection?: Record<string, any>): any;
+    getAllElements(includeHidden?: boolean): any[];
+    setPositions(): void;
+    setColor(colorIn?: TypeColor | null): void;
+    offsetLocation(offset?: Point): void;
+    calcSize(location: Point, scale: number): void;
+}

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

@@ -0,0 +1,49 @@
+import { Point, Rect } from '../../../tools/g2';
+type TypeBounds = {
+    width: number;
+    height: number;
+    ascent: number;
+    descent: number;
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+    annotations?: {
+        [referenceName: string]: {
+            xPosition: 'left' | 'center' | 'right' | number;
+            yPosition: 'bottom' | 'baseline' | 'middle' | 'top' | number;
+            xAlign: 'left' | 'center' | 'right' | number;
+            yAlign: 'bottom' | 'baseline' | 'middle' | 'top' | number;
+            offset?: Point;
+        };
+    };
+};
+export default class Bounds {
+    width: number;
+    height: number;
+    ascent: number;
+    descent: number;
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+    constructor(boundsIn?: {
+        width?: number;
+        height?: number;
+        ascent?: number;
+        descent?: number;
+        top?: number;
+        bottom?: number;
+        left?: number;
+        right?: number;
+    });
+    toRect(): Rect;
+    copyFrom(from: Record<string, any>): void;
+    leftOffset(leftDelta: number): void;
+    rightOffset(rightDelta: number): void;
+    topOffset(topDelta: number): void;
+    bottomOffset(bottomDelta: number): void;
+    offset(top: number, right: number, bottom: number, left: number): void;
+    growWithSameBaseline(newBounds: TypeBounds): void;
+}
+export {};

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

@@ -0,0 +1,7 @@
+import { Point } from '../../../tools/g2';
+import BaseEquationFunction from './BaseEquationFunction';
+import type { TypeColor } from '../../../tools/types';
+export default class Color extends BaseEquationFunction {
+    color: TypeColor | null;
+    calcSize(location: Point, scale: number): void;
+}

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

@@ -0,0 +1,5 @@
+import { Point } from '../../../tools/g2';
+import BaseEquationFunction from './BaseEquationFunction';
+export default class Container extends BaseEquationFunction {
+    calcSize(location: Point, scale: number): void;
+}

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

@@ -0,0 +1,95 @@
+import { Point } from '../../../tools/g2';
+import Bounds from './Bounds';
+import { FigureElementPrimitive, FigureElementCollection } from '../../Element';
+import { FunctionMap } from '../../../tools/FunctionMap';
+import type { TypeColor } from '../../../tools/types';
+export interface ElementInterface {
+    ascent: number;
+    descent: number;
+    width: number;
+    location: Point;
+    height: number;
+    showContent: boolean;
+    fullSize: {
+        leftOffset: number;
+        width: number;
+        descent: number;
+        ascent: number;
+        height: number;
+    };
+    fnMap: FunctionMap;
+    calcSize(location: Point, scale: number): void;
+    _dup(namedCollection?: Record<string, any>): ElementInterface;
+    getAllElements(includeHidden?: boolean): Array<ElementInterface | FigureElementPrimitive | FigureElementCollection>;
+    setPositions(): void;
+    offsetLocation(offset: Point): void;
+    getBounds(useFullSize?: boolean): Bounds;
+    cleanup(): void;
+    setColor(colorIn: TypeColor | null): void;
+}
+declare class BlankElement {
+    ascent: number;
+    descent: number;
+    width: number;
+    height: number;
+    color: TypeColor;
+    constructor(width?: number, ascent?: number, descent?: number);
+    _dup(): BlankElement;
+}
+declare class Element implements ElementInterface {
+    content: FigureElementPrimitive | FigureElementCollection | BlankElement;
+    ascent: number;
+    descent: number;
+    width: number;
+    location: Point;
+    height: number;
+    scale: number;
+    fnMap: FunctionMap;
+    showContent: boolean;
+    color: TypeColor | null;
+    defaultColor: TypeColor;
+    fullSize: {
+        leftOffset: number;
+        width: number;
+        height: number;
+        ascent: number;
+        descent: number;
+    };
+    constructor(content: FigureElementPrimitive | FigureElementCollection | BlankElement);
+    cleanup(): void;
+    calcSize(location: Point, scale: number): void;
+    _dup(namedCollection?: Record<string, any>): Element;
+    getAllElements(includeHidden?: boolean): (FigureElementCollection | FigureElementPrimitive)[];
+    setPositions(): void;
+    setColor(colorIn?: TypeColor | null): void;
+    offsetLocation(offset?: Point): void;
+    getBounds(useFullSize?: boolean): Bounds;
+}
+declare class Elements implements ElementInterface {
+    content: Array<ElementInterface>;
+    ascent: number;
+    descent: number;
+    width: number;
+    location: Point;
+    height: number;
+    fnMap: FunctionMap;
+    showContent: boolean;
+    color: TypeColor | null;
+    fullSize: {
+        leftOffset: number;
+        width: number;
+        height: number;
+        ascent: number;
+        descent: number;
+    };
+    constructor(content: Array<ElementInterface | null>);
+    cleanup(): void;
+    _dup(namedCollection?: Record<string, any>): Elements;
+    calcSize(location: Point, scale: number): void;
+    getAllElements(includeHidden?: boolean): (FigureElementCollection | FigureElementPrimitive | ElementInterface)[];
+    setPositions(): void;
+    setColor(colorIn?: TypeColor | null): void;
+    offsetLocation(offset?: Point): void;
+    getBounds(useFullSize?: boolean): Bounds;
+}
+export { BlankElement, Element, Elements };

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

@@ -0,0 +1,5 @@
+import { Point } from '../../../tools/g2';
+import BaseEquationFunction from './BaseEquationFunction';
+export default class Fraction extends BaseEquationFunction {
+    calcSize(location: Point, incomingScale: number): void;
+}

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

@@ -0,0 +1,5 @@
+import { Point } from '../../../tools/g2';
+import BaseEquationFunction from './BaseEquationFunction';
+export default class Lines extends BaseEquationFunction {
+    calcSize(location: Point, scale: number): void;
+}

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

@@ -0,0 +1,5 @@
+import { Point } from '../../../tools/g2';
+import BaseEquationFunction from './BaseEquationFunction';
+export default class Matrix extends BaseEquationFunction {
+    calcSize(location: Point, scale: number): void;
+}

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

@@ -0,0 +1,5 @@
+import { Point } from '../../../tools/g2';
+import BaseEquationFunction from './BaseEquationFunction';
+export default class Offset extends BaseEquationFunction {
+    calcSize(location: Point, scale: number): void;
+}

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

@@ -0,0 +1,5 @@
+import { Point } from '../../../tools/g2';
+import BaseEquationFunction from './BaseEquationFunction';
+export default class Scale extends BaseEquationFunction {
+    calcSize(location: Point, scale: number): void;
+}