figureone 0.15.10 → 1.0.0

package/types/js/figure/FigureCollections/Button.d.ts

@@ -0,0 +1,195 @@
+import { FigureElementCollection, FigureElementPrimitive } from '../Element';
+import type { OBJ_Collection, OBJ_LineStyleSimple } from '../FigurePrimitives/FigurePrimitiveTypes';
+import type { TypeColor, OBJ_Font, OBJ_CurvedCorner } from '../../tools/types';
+import type FigureCollections from './FigureCollections';
+import EquationLabel from './EquationLabel';
+import type { EQN_Equation, Equation } from '../Equation/Equation';
+/**
+ * Collections button label options object.
+ *
+ * A button can be annotated with a label using the `text` property and can be:
+ * - text (`string`, `Array<string>`)
+ * - an equation (`Equation`, `EQN_Equation`)
+ *
+ * In all cases, an actual {@link Equation} is created as the label. The
+ * equation can have multiple forms, which can be set using the `showForm`
+ * method.
+ *
+ * If `text`: `string`, then an equation with a single form named `base` will
+ * be created with a single element being the string text.
+ *
+ * If `text`: `Array<string>`, then an equation with a form for each element
+ * of the array is created. Each form is named '0', '1', '2'... corresponding
+ * with the index of the array. Each form is has a single element, being the
+ * text at that index.
+ *
+ * Use `text`: {@link Equation} or {@link EQN_Equation} to create completely
+ * custom equations with any forms desirable.
+ *
+ * @see {@link COL_Button}
+ *
+ * @property {null | string | Array<string> | Equation | EQN_Equation } text
+ * @property {OBJ_Font} [font] font to use
+ * @property {number} [scale] size of the label
+ * @property {TypeColor} [color]
+ * @interface
+ * @group Misc Shapes
+ */
+export type OBJ_ButtonLabel = {
+    text: null | string | Array<string> | Equation | EQN_Equation;
+    font?: OBJ_Font;
+    scale?: number;
+    color?: TypeColor;
+};
+/**
+ * Button state options object.
+ *
+ * @property {TypeColor} [colorLine]
+ * @property {TypeColor} [colorFill]
+ * @property {TypeColor} [colorLabel]
+ * @property {string} [label]
+ * @see {@link COL_Button}
+ * @interface
+ * @group Misc Shapes
+ */
+export type OBJ_ButtonColorState = {
+    colorLine?: TypeColor;
+    colorFill?: TypeColor;
+    colorLabel?: TypeColor;
+};
+/**
+ * Button state options object.
+ *
+ * The `label` can either be the label text, or it can be the name of the form
+ * of the equation label.
+ *
+ * @property {TypeColor} [colorLine]
+ * @property {TypeColor} [colorFill]
+ * @property {TypeColor} [colorLabel]
+ * @property {string} [label]
+ * @see {@link COL_Button}
+ * @interface
+ * @group Misc Shapes
+ */
+export type OBJ_ButtonState = {
+    colorLine?: TypeColor;
+    colorFill?: TypeColor;
+    colorLabel?: TypeColor;
+    label?: string;
+};
+/**
+ * {@link CollectionsButton} options object that extends {@link OBJ_Collection}
+ * options object (without `parent`).
+ *
+ * @property {number} [width] button width
+ * @property {number} [height] button height
+ * @property {OBJ_CurvedCorner} [corner] button corner
+ * @property {null | OBJ_LineStyleSimple} [line] button outline - use `null` to
+ * remove the default line
+ * @property {OBJ_ButtonLabel} [label] button label
+ * @property {TypeColor} [colorLine]
+ * @property {TypeColor} [colorFill]
+ * @property {TypeColor} [colorLabel]
+ * @property {OBJ_ButtonColorState>} [touchDown] set colors between a touch
+ * down and touch up
+ * @property {Array<OBJ_ButtonState | string>} [states]
+ *
+ * @extends OBJ_Collection
+ * @interface
+ * @group 2D Shape Collections
+ */
+export type COL_Button = {
+    width?: number;
+    height?: number;
+    corner?: OBJ_CurvedCorner;
+    line?: null | OBJ_LineStyleSimple;
+    label?: OBJ_ButtonLabel;
+    colorLine?: TypeColor;
+    colorFill?: TypeColor;
+    colorLabel?: TypeColor;
+    touchDown?: OBJ_ButtonColorState;
+    states?: Array<OBJ_ButtonState | string>;
+} & OBJ_Collection;
+declare class ButtonLabel extends EquationLabel {
+    constructor(collections: FigureCollections, labelText: string | Equation | EQN_Equation | Array<string>, color: TypeColor, scale?: number, font?: OBJ_Font | null | undefined);
+}
+/**
+ * {@link FigureElementCollection} representing a button.
+ *
+ * ![](./apiassets/button.png)
+ *
+ * ![](./apiassets/button1.gif)
+ *
+ * A button can be simple, or it can change state with each press.
+ *
+  * Notifications - The notification manager property `notifications` will
+ * publish the following events:
+ * - `touch`: button is pressed - the current state index is passed to the
+ *   subscriber
+ *
+ * See {@link COL_Button} for setup options.
+ *
+ * To test examples below, append them to the
+ * <a href="#drawing-boilerplate">boilerplate</a>
+ *
+ * @example
+ * // Simple button
+ * figure.add({
+ *   make: 'collections.button',
+ *   label: 'Start',
+ * });
+ *
+ * @example
+ * // Borderless button
+ * figure.add({
+ *   make: 'collections.button',
+ *   label: 'Start',
+ *   colorFill: [0.8, 0.8, 0.8, 1],
+ *   line: null,
+ * });
+ *
+ * @example
+ * // Button that changes state and has a touch buffer of 0.1 around it
+ * const button = figure.add({
+ *   make: 'collections.button',
+ *   states: ['Slow', 'Medium', 'Fast'],
+ *   width: 0.7,
+ *   height: 0.3,
+ *   touchBorder: 0.1,
+ * });
+ *
+ * button.notifications.add('touch', (index) => {
+ *   console.log(index);
+ * });
+ * @group 2D Shape Collections
+ */
+declare class CollectionsButton extends FigureElementCollection {
+    _fill: FigureElementPrimitive;
+    _line: FigureElementPrimitive | null;
+    label: ButtonLabel | null;
+    _label: Equation | null;
+    width: number;
+    height: number;
+    states: Array<OBJ_ButtonState>;
+    touchDown: OBJ_ButtonColorState;
+    /**
+     * @hideconstructor
+     */
+    constructor(collections: FigureCollections, optionsIn: COL_Button);
+    incrementState(): void;
+    /**
+     * Set the button state index.
+     * @param {number} index
+     */
+    setStateIndex(index: number): void;
+    /**
+     * Get the current button state index.
+     * @return {number}
+     */
+    getStateIndex(): any;
+    getStateProperty(propertyName: string): any;
+    updateState(): void;
+    updateStateForTouch(down: boolean): void;
+    setLabel(text: string): void;
+}
+export default CollectionsButton;

package/types/js/figure/FigureCollections/EquationLabel.d.ts

@@ -0,0 +1,77 @@
+import { Point } from '../../tools/g2';
+import { Equation } from '../Equation/Equation';
+import type { TypeVAlign, TypeHAlign } from '../Equation/EquationForm';
+import type { EQN_Equation } from '../Equation/Equation';
+import type { TypeColor } from '../../tools/types';
+import type FigureCollections from './FigureCollections';
+export type TypeLabelOptions = {
+    label?: string | Equation | Array<string> | EQN_Equation;
+    color?: TypeColor;
+    scale?: number;
+    position?: Point;
+    form?: string;
+    yAlign?: TypeVAlign;
+    xAlign?: TypeHAlign;
+    font?: any;
+};
+/**
+ * Orientation of the label.
+ *
+ * `'horizontal' | 'toLine' | 'awayLine' | 'upright'`
+ *
+ * Where:
+ * - `'horizontal'`: Label will be horizontal
+ * - `'baseToLine'`: Label will have same angle as line with text base toward
+ *   the line
+ * - `'baseAway'`: Label will have same angle as line with text base away from
+ *   the line
+ * - `'upright'`: Label will have same angle as line with text being more
+ *   upright than upside down.
+ */
+export type TypeLabelOrientation = 'horizontal' | 'baseAway' | 'baseToLine' | 'upright';
+/**
+ * Label location relative to the line.
+ *
+ * `'top' | 'left' | 'bottom' | 'right' | 'start' | 'end' | 'positive' | 'negative'`
+ *
+ * '`top`' is in the positive y direction and `'right'` is in the positive
+ * x direction. '`bottom`' and '`left`' are the opposite sides respectively.
+ *
+ * `'positive'` is on the side of the line that the line rotates toward when
+ * rotating in the positive direction. `'negative'` is the opposite side.
+ *
+ * `'start'` is the start end of the line, while `'end'` is the opposide end
+ * of the line.
+ */
+export type TypeLabelLocation = 'top' | 'left' | 'bottom' | 'right' | 'start' | 'end' | 'outside' | 'inside' | 'positive' | 'negative';
+/**
+ * Label sub location relative to line.
+ *
+ * `'top' | 'left' | 'bottom' | 'right'`
+ *
+ * The label sub location is a fallback for when an invalid case is encountered
+ * by the primary location. When the primary location is `'top'` or `'bottom'`
+ * and the line is perfectly vertical, then the sub location would be used.
+ *
+ * Similarly, if the primary location is `'left'` or `'right'` and the line is
+ * perfectly horizontal, then the sub location would be used.
+ */
+export type TypeLabelSubLocation = 'top' | 'left' | 'bottom' | 'right';
+/**
+ * Equation label
+ * @group Misc Equation
+ */
+export default class EquationLabel {
+    eqn: Equation;
+    height: number;
+    width: number;
+    aOffset: number;
+    lastOffsetMag: number;
+    constructor(collections: FigureCollections, options?: TypeLabelOptions);
+    showForm(formName: string): void;
+    setText(text: string): void;
+    getText(): string;
+    updateRotation(position: Point, lineAngle: number, offsetMag: number, location: 'top' | 'bottom' | 'left' | 'right' | 'positive' | 'negative' | 'start' | 'end' | 'inside' | 'outside', subLocation: 'top' | 'bottom' | 'left' | 'right', orientation: 'horizontal' | 'baseAway' | 'baseToLine' | 'upright', parentAngleOffset?: number, style?: 'oval' | 'rectangle', relativeToLine?: boolean, startThetaAngle?: number, endThetaAngle?: number): void;
+    getOvalOffset(labelAngle: number, h: number, w: number, offsetMag: number, offsetAngle: number, change: boolean, location: 'top' | 'bottom' | 'left' | 'right' | 'positive' | 'negative' | 'start' | 'end' | 'inside' | 'outside', startThetaAngle?: number, endThetaAngle?: number): Point;
+}
+export type TypeEquationLabel = EquationLabel;

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

@@ -0,0 +1,122 @@
+import WebGLInstance from '../webgl/webgl';
+import { Transform, Point } from '../../tools/g2';
+import DrawContext2D from '../DrawContext2D';
+import CollectionsLine from './Line';
+import CollectionsAngle from './Angle';
+import CollectionsPolyline from './PolyLine';
+import CollectionsAxis from './Axis';
+import CollectionsAxis3 from './Axis3';
+import CollectionsTrace from './Trace';
+import CollectionsToggle from './Toggle';
+import CollectionsSlider from './Slider';
+import CollectionsButton from './Button';
+import type { COL_Toggle } from './Toggle';
+import type { COL_Slider } from './Slider';
+import type { COL_Button } from './Button';
+import type { COL_Line } from './Line';
+import type { COL_Angle } from './Angle';
+import type { TypeLabelOptions } from './EquationLabel';
+import type { COL_Polyline } from './PolyLine';
+import type { COL_Axis } from './Axis';
+import type { COL_Axis3 } from './Axis3';
+import type { COL_Trace } from './Trace';
+import type { COL_Plot } from './Plot';
+import type { COL_Rectangle } from './Rectangle';
+import EquationLabel from './EquationLabel';
+import CollectionsPlot from './Plot';
+import CollectionsPlotLegend from './Legend';
+import CollectionsRectangle from './Rectangle';
+import type { EQN_Equation } from '../Equation/Equation';
+import { Equation } from '../Equation/Equation';
+import type { OBJ_Collection } from '../FigurePrimitives/FigurePrimitiveTypes';
+import SlideNavigator from './SlideNavigator';
+import type { COL_SlideNavigator } from './SlideNavigator';
+import { FigureElementCollection } from '../Element';
+import type { TypeColor } from '../../tools/types';
+import CollectionsText from './Text';
+import type { OBJ_FormattedText } from './Text';
+/**
+ * Built in figure collections.
+ *
+ * Provides advanced primitives the specific methods, animations and interactivity.
+ * @group Misc Shapes
+ */
+export default class FigureCollections {
+    webgl: Array<WebGLInstance>;
+    draw2D: DrawContext2D;
+    primitives: any;
+    isTouchDevice: boolean;
+    animateNextFrame: () => void;
+    /**
+      * @hideconstructor
+      */
+    constructor(primitives: any, isTouchDevice: boolean, animateNextFrame: () => void);
+    /**
+     * Create a {@link FigureElementCollection}.
+     */
+    collection(transformOrPointOrOptions?: Transform | Point | OBJ_Collection, ...moreOptions: Array<OBJ_Collection>): FigureElementCollection;
+    /**
+     * Create a {@link CollectionsLine}.
+     */
+    line(...options: Array<COL_Line>): CollectionsLine;
+    /**
+     * Create a {@link CollectionsAngle}.
+     */
+    angle(...options: Array<COL_Angle>): CollectionsAngle;
+    label(...options: Array<TypeLabelOptions>): EquationLabel;
+    text(...options: Array<OBJ_FormattedText>): CollectionsText;
+    /**
+     * Create a {@link CollectionsPolyline}.
+     */
+    polyline(...options: Array<COL_Polyline>): CollectionsPolyline;
+    /**
+     * Create a {@link CollectionsRectangle}.
+     */
+    rectangle(...options: Array<COL_Rectangle>): CollectionsRectangle;
+    /**
+     * Create a {@link CollectionSlideNavigator}
+     */
+    slideNavigator(...options: Array<COL_SlideNavigator>): SlideNavigator;
+    /**
+     * Create a {@link CollectionsAixs}.
+     */
+    axis(...options: Array<COL_Axis>): CollectionsAxis;
+    /**
+     * Create a {@link CollectionsAixs3}.
+     */
+    axis3(...options: Array<COL_Axis3>): CollectionsAxis3;
+    /**
+     * Create a {@link CollectionToggle}.
+     */
+    toggle(...options: Array<COL_Toggle>): CollectionsToggle;
+    /**
+     * Create a {@link CollectionSlider}.
+     */
+    slider(...options: Array<COL_Slider>): CollectionsSlider;
+    /**
+     * Create a {@link CollectionSlider}.
+     */
+    button(...options: Array<COL_Button>): CollectionsButton;
+    /**
+     * Create a {@link CollectionsTrace}.
+     */
+    trace(...options: Array<COL_Trace>): CollectionsTrace;
+    /**
+     * Create a {@link CollectionsPlot}.
+     */
+    plot(...options: Array<COL_Plot>): CollectionsPlot;
+    /**
+     * Create a {@link CollectionsLegend}.
+     */
+    plotLegend(...options: Array<COL_Plot>): CollectionsPlotLegend;
+    /**
+     * Create a {@link Equation}.
+     */
+    equation(options: EQN_Equation): Equation;
+    addEquation(parent: FigureElementCollection, name: string, options?: EQN_Equation): Equation;
+    cursor(optionsIn: {
+        color: TypeColor;
+        width: number;
+        radius: number;
+    }): FigureElementCollection;
+}

package/types/js/figure/FigureCollections/Legend.d.ts

@@ -0,0 +1,270 @@
+import { Point } from '../../tools/g2';
+import type { TypeParsablePoint } from '../../tools/g2';
+import { FigureElementCollection } from '../Element';
+import type { COL_Trace } from './Trace';
+import type CollectionsTrace from './Trace';
+import type { OBJ_Font, OBJ_Font_Fixed } from '../../tools/types';
+import type { OBJ_Collection } from '../FigurePrimitives/FigurePrimitiveTypes';
+import type { OBJ_PlotFrame } from './Plot';
+import type FigureCollections from './FigureCollections';
+import type CollectionsRectangle from './Rectangle';
+import type { OBJ_FormattedText } from './Text';
+/**
+ * Legend customization for a single trace sample in the legend.
+ *
+ * @property {OBJ_Font} [font] default font
+ * @property {number} [length] length of the line sample
+ * @property {TypeParsablePoint} [offset] offset of this trace sample from
+ * the last trace sample
+ * @property {number} [space] space between line sample and text
+ * @property {boolean} [fontColorIsLineColor] use line color as font color
+ * @property {OBJ_TextLines | 'string'} [text] custom text
+ * @property {TypeParsablePoint} [position] position of the trace sample
+ * @interface
+ * @group Misc Shapes
+ */
+export type OBJ_PlotLegendCustomTrace = {
+    font?: OBJ_Font;
+    length?: number;
+    offset?: TypeParsablePoint;
+    space?: number;
+    fontColorIsLineColor?: boolean;
+    text?: OBJ_FormattedText | 'string';
+    position?: TypeParsablePoint;
+};
+/**
+ * Legend customization options object
+ *
+ * Allows customization of specific trace samples in the legend.
+ * `_arrayIndexOrName` represents a generic key that should actually
+ * be the array index of the specific trace defined in {@link COL_PlotLegend}
+ * or the name of the trace. See examples in {@link CollectionsPlotLegend} for use.
+ *
+ * @property {OBJ_PlotLegendCustomTrace} [_arrayIndexOrName]
+ * @interface
+ * @group Misc Shapes
+ */
+export type OBJ_PlotLegendCustom = {
+    [_arrayIndexOrName: string]: OBJ_PlotLegendCustomTrace;
+};
+/**
+ * {@link CollectionsPlotLegend} options object that extends {@link OBJ_Collection}
+ * options object (without `parent`).
+ *
+ * A legend consists of a number of trace samples and their corresponding names,
+ * and may have an encompassing frame with a border and fill.
+ *
+ * @extends OBJ_Collection
+ *
+ * @property {TypeParsablePoint} [position] position of the first trace in the
+ * legend
+ * @property {number} [length] length of the line sample
+ * @property {number} [space] space between the line and the text
+ * @property {Array<TypeParsablePoint> | TypeParsablePoint} [offset] offset
+ * between trace samples - can be used to space out a legend, or make it
+ * horizontal
+ * @property {OBJ_Font} [font] default font for trace sample text
+ * @property {boolean} [fontColorIsLineColor] set the trace sample text color to
+ * the same as the line sample
+ * @property {Array<number> | OBJ_PlotFrame} [frame] frame around the legend -
+ * specifying just a color will create a solid fill rectangle of that color
+ * @property {Array<number>} [show] array of which trace indeces to show if only
+ * some should be shown
+ * @property {Array<number>} [hide] array of which trace indeces to hide if some
+ * should be hidden
+ * @property {OBJ_PlotLegendCustom} [custom] customizations to specific trace
+ * samples
+ * @property {Array<COL_Trace>} [traces] the traces from the plot that this
+ * legend will display. This is used by {@link CollectionsPlot} and should not be
+ * used by the user.
+ * @interface
+ * @group Misc Shapes
+ */
+export type COL_PlotLegend = {
+    position?: TypeParsablePoint;
+    length?: number;
+    space?: number;
+    offset?: Array<TypeParsablePoint> | TypeParsablePoint;
+    font?: OBJ_Font;
+    fontColorIsLineColor?: boolean;
+    frame?: Array<number> | OBJ_PlotFrame;
+    show?: Array<number>;
+    hide?: Array<number>;
+    custom?: OBJ_PlotLegendCustom;
+    traces: Array<COL_Trace>;
+} & OBJ_Collection;
+/**
+ * {@link FigureElementCollection} representing an legend.
+ *
+ * ![](./apiassets/advlegend_ex1.png)
+ * ![](./apiassets/advlegend_ex2.png)
+ *
+ * ![](./apiassets/advlegend_ex3.png)
+ * ![](./apiassets/advlegend_ex4.png)
+ *
+ * ![](./apiassets/advlegend_ex5.png)
+ *
+ * This object defines a legend in an {@link CollectionsPlot}.
+ *
+ * The legend includes traces, trace names and a frame. Each can be customized
+ * using the {@link COL_PlotLegend} options object.
+ *
+ * To test examples below, append them to the
+ * <a href="#drawing-boilerplate">boilerplate</a>.
+ *
+ * All examples below also use this power function to generate the traces:
+ * ```javascript
+ * const pow = (pow = 2, start = 0, stop = 10, step = 0.05) => {
+ *   const xValues = Fig.range(start, stop, step);
+ *   return xValues.map(x => new Fig.Point(x, x ** pow));
+ * }
+ * ```
+ *
+ * @example
+ * // By default, the legend will appear in the top right corner
+ * figure.add({
+ *   name: 'plot',
+ *   make: 'collections.plot',
+ *   trace: [
+ *     { points: pow(2), name: 'Power 2' },
+ *     { points: pow(2.5), name: 'Power 2.5' },
+ *     {
+ *       points: pow(3, 0, 10, 0.5),
+ *       name: 'Power 3',
+ *       markers: { radius: 0.03, sides: 10 },
+ *     },
+ *   ],
+ *   legend: true,
+ * });
+ *
+ * @example
+ * // Change the line length, position and use a frame on the legend
+ * figure.add({
+ *   name: 'plot',
+ *   make: 'collections.plot',
+ *   trace: [
+ *     { points: pow(2), name: 'Power 2' },
+ *     { points: pow(2.5), name: 'Power 2.5' },
+ *     {
+ *       points: pow(3, 0, 10, 0.5),
+ *       name: 'Power 3',
+ *       markers: { radius: 0.03, sides: 10 },
+ *     },
+ *   ],
+ *   legend: {
+ *     length: 0.5,
+ *     frame: [0.95, 0.95, 0.95, 1],
+ *     position: [0.2, 1.8],
+ *   },
+ * });
+ *
+ * @example
+ * // Make a horizontal legend
+ * figure.add({
+ *   name: 'plot',
+ *   make: 'collections.plot',
+ *   trace: [
+ *     { points: pow(2), name: 'Power 2' },
+ *     { points: pow(2.5), name: 'Power 2.5' },
+ *     {
+ *       points: pow(3, 0, 10, 0.5),
+ *       name: 'Power 3',
+ *       markers: { radius: 0.03, sides: 10 },
+ *     },
+ *   ],
+ *   legend: {
+ *     offset: [0.9, 0],
+ *     position: [-0.3, -0.5],
+ *     frame: {
+ *       line: { width: 0.005 },
+ *       corner: { radius: 0.05, sides: 10 },
+ *     },
+ *   },
+ * });
+ *
+ * @example
+ * // Customize legend trace text
+ * figure.add({
+ *   name: 'plot',
+ *   make: 'collections.plot',
+ *   trace: [
+ *     { points: pow(2), name: 'Power 2' },
+ *     { points: pow(2.5), name: 'Power 2.5' },
+ *     {
+ *       points: pow(3, 0, 10, 0.5),
+ *       name: 'Power 3',
+ *       markers: { radius: 0.03, sides: 10 },
+ *     },
+ *   ],
+ *   legend: {
+ *     offset: [0, -0.2],
+ *     custom: {
+ *       1: {
+ *         font: { size: 0.1, style: 'italic', color: [1, 0, 0, 1] },
+ *         text: {
+ *           text: [
+ *             'Power 2.5',
+ *             {
+ *               text: 'Reference Trace',
+ *               font: { size: 0.06 },
+ *               lineSpace: 0.06,
+ *             },
+ *           ],
+ *           justify: 'left',
+ *         },
+ *       },
+ *     },
+ *   },
+ * });
+ *
+ * @example
+ * // Customize legend
+ * figure.add({
+ *   name: 'plot',
+ *   make: 'collections.plot',
+ *   trace: [
+ *     { points: pow(2), name: 'Power 2' },
+ *     { points: pow(2.5), name: 'Power 2.5' },
+ *     {
+ *       points: pow(3, 10, 0.5),
+ *       name: 'Power 3',
+ *       markers: { radius: 0.03, sides: 10 },
+ *     },
+ *   ],
+ *   legend: {
+ *     fontColorIsLineColor: true,
+ *     length: 0,
+ *     custom: {
+ *       0: { position: [2, 0.2] },
+ *       1: { position: [2, 0.7] },
+ *       'Power 3': { position: [2, 2] },
+ *     }
+ *   },
+ * });
+ * @group Misc Shapes
+ */
+declare class CollectionsPlotLegend extends FigureElementCollection {
+    _frame: CollectionsRectangle | null | undefined;
+    defaultFont: OBJ_Font_Fixed;
+    traces: Array<CollectionsTrace>;
+    offset: Array<Point>;
+    toShow: Array<number>;
+    frameSpace: number;
+    /**
+     * @hideconstructor
+     */
+    constructor(collections: FigureCollections, optionsIn: COL_PlotLegend);
+    getTraceIndex(name: string | number): number;
+    getTracesToShow(o: {
+        show?: any;
+        hide?: any;
+    }): number[];
+    getOffset(o: {
+        offset: Array<TypeParsablePoint> | TypeParsablePoint;
+    }): Point[];
+    addTraces(o: COL_PlotLegend): void;
+    addFrame(optionsIn: Record<string, any> | boolean | Array<number>): void;
+    fontUpdated(): void;
+    update(): void;
+}
+export default CollectionsPlotLegend;