figureone 0.15.10 → 1.0.0

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

@@ -0,0 +1,139 @@
+import { Point, Transform } from '../../tools/g2';
+import type { TypeColor } from '../../tools/types';
+import { FigureElementPrimitive, FigureElementCollection } from '../Element';
+import { Elements } from './Elements/Element';
+/**
+ * Horizontal Alignment
+ *
+ * `TypeHAlign = 'left' | 'right' | 'center' | number`
+ *
+ * Where `number` is a percentage of the width from the left. So
+ * `0` would be equivalent to `'left'`, 0.5 equivalent to
+ * `'center'` and 1 equivalent to `'right'`.
+ * @group Misc Shapes
+ */
+export type TypeHAlign = 'left' | 'right' | 'center' | number;
+/**
+ * Vertical Alignment
+ *
+ * `TypeHAlign = 'left' | 'right' | 'center' | 'baseline' | number`
+ *
+ * Where `number` is a percentage of the width from the left. So
+ * `0` would be equivalent to `'left'`, 0.5 equivalent to
+ * `'center'` and 1 equivalent to `'right'`.
+ * @group Misc Shapes
+ */
+export type TypeVAlign = 'top' | 'bottom' | 'middle' | 'baseline' | number;
+export type TypeEquationForm = {
+    collection: FigureElementCollection;
+    arrange: (scale: number, xAlign: TypeHAlign | null, yAlign: TypeVAlign | null, fixTo: FigureElementPrimitive | FigureElementCollection | Point) => void;
+    dissolveElements: (elements: Array<FigureElementPrimitive | FigureElementCollection>, dissolve: boolean, delay: number, time: number, callback: ((cancelled?: boolean) => void) | null) => void;
+    getElementsToShowAndHide: () => void;
+    showHide: (showTime: number, hideTime: number, callback: ((arg?: any) => void) | null) => void;
+    hideShow: (showTime: number, hideTime: number, callback: ((arg?: any) => void) | null) => void;
+    animatePositionsTo: (delay: number, callback: ((arg?: any) => void) | null) => void;
+    description: string | null;
+    modifiers: Record<string, any>;
+    type: string;
+    onShow: string | (() => void);
+    elementMods: {
+        [key: string]: {
+            element: FigureElementPrimitive | FigureElementCollection;
+            mods: Record<string, any>;
+        };
+    };
+    time: number | null;
+} & Elements;
+export type TypeCollectionMethods = {
+    getAllElements: () => Array<FigureElementPrimitive | FigureElementCollection>;
+    hideAll: () => void;
+    show: () => void;
+    showOnly: (elements: Array<FigureElementPrimitive | FigureElementCollection>) => void;
+    stop(cancelled?: boolean, forceSetToEndOfPlan?: boolean): void;
+    getElementTransforms: () => {
+        [key: string]: Transform;
+    };
+    getElementColors: (includeHidden: boolean) => {
+        [key: string]: TypeColor;
+    };
+    setElementTransforms: (transforms: {
+        [key: string]: Transform;
+    }) => void;
+    setElementColors: (colors: {
+        [key: string]: TypeColor;
+    }) => void;
+    animateToTransforms(elementTransforms: Record<string, any>, time?: number, delay?: number, rotDirection?: number, callback?: string | ((arg?: any) => void) | null, name?: string, easeFunction?: string | ((n: number) => number)): number;
+    animateToColors(elementColors: Record<string, any>, time?: number, delay?: number, callback?: string | ((arg?: any) => void) | null, name?: string, easeFunction?: string | ((n: number) => number)): number;
+};
+export type TypeElements = {
+    [key: string]: FigureElementCollection | FigureElementPrimitive;
+};
+export type TypeElementTranslationOptions = {
+    [key: string]: {
+        element: FigureElementPrimitive | FigureElementCollection;
+        direction?: 'up' | 'down';
+        style: 'curved' | 'linear';
+        mag: number;
+    };
+};
+export default class EquationForm extends Elements {
+    elements: {
+        [key: string]: FigureElementCollection | FigureElementPrimitive;
+    };
+    collectionMethods: TypeCollectionMethods;
+    name: string;
+    elementMods: {
+        [key: string]: {
+            element: FigureElementPrimitive | FigureElementCollection;
+            mods: Record<string, any>;
+        };
+    };
+    arranged: {
+        scale: number;
+        xAlign: TypeHAlign | null;
+        yAlign: TypeVAlign | null;
+        fixTo: FigureElementPrimitive | FigureElementCollection | Point;
+    };
+    description: string | null;
+    modifiers: Record<string, any>;
+    onTransition: null | string | (() => void);
+    onShow: null | string | (() => void);
+    duration: number | null | undefined;
+    translation: TypeElementTranslationOptions;
+    positionsSet: boolean;
+    layout: 'always' | 'lazy' | 'init';
+    ignoreColor: boolean;
+    fromForm: {
+        [key: string]: {
+            onTransition?: string | (() => void);
+            onShow?: string | (() => void);
+            duration?: number;
+            translation?: TypeElementTranslationOptions;
+            elementMods: {
+                [key: string]: {
+                    element: FigureElementPrimitive | FigureElementCollection;
+                    mods: Record<string, any>;
+                };
+            };
+        };
+    };
+    constructor(elements: TypeElements, collectionMethods: TypeCollectionMethods);
+    cleanup(): void;
+    getNamedElements(): Record<string, any>;
+    rearrange(): void;
+    setPositions(noArrange?: boolean): void;
+    _dup(elements?: TypeElements, collectionMethods?: TypeCollectionMethods): EquationForm;
+    arrange(scale?: number, xAlign?: TypeHAlign | null, yAlign?: TypeVAlign | null, fixTo?: FigureElementPrimitive | FigureElementCollection | Point): void;
+    lazyArrange(scale?: number, xAlign?: TypeHAlign | null, yAlign?: TypeVAlign | null, fixTo?: FigureElementPrimitive | FigureElementCollection | Point): void;
+    dissolveElements(elements: Array<FigureElementPrimitive | FigureElementCollection>, dissolve?: 'in' | 'out', delay?: number, time?: number, callback?: (string | ((cancelled: boolean) => void)) | null): void;
+    getElementsToShowAndHide(): {
+        show: (FigureElementCollection | FigureElementPrimitive)[];
+        hide: (FigureElementCollection | FigureElementPrimitive)[];
+    };
+    render(): void;
+    showHide(showTime?: number, hideTime?: number, callback?: ((arg?: any) => void) | null, animationStop?: boolean): void;
+    hideShow(showTime?: number, hideTime?: number, callback?: ((arg?: any) => void) | null, animationStop?: boolean): void;
+    allHideShow(delay?: number, hideTime?: number, blankTime?: number, showTime?: number, callback?: ((cancelled: boolean) => void) | null): void;
+    applyElementMods(fromWhere?: null | string): void;
+    animatePositionsTo(delay: number, dissolveOutTime: number, moveTime: number | null, dissolveInTime: number, callback?: (string | ((arg?: any) => void)) | null, fromWhere?: string | null | undefined, dissolveInBeforeMove?: boolean): number;
+}