ecljs/dist/lib/container.d.ts

electric circuits library

import { Rect } from "dabbjs/dist/lib/rect";
import { IBaseComponent, IContainerDefaults, Base, BondDir, IUnbondNodeData, IUnbondData } from "./interfaces";
import { Bond } from "./bonds";
import { ItemBoard } from "./itemsBoard";
import { Wire } from "./wire";
import { CompStore } from "./components";
export declare abstract class Container<T extends ItemBoard> extends Base {
    protected $: IContainerDefaults<T>;
    abstract get name(): string;
    abstract get dir(): boolean;
    abstract createItem(options: {
        [x: string]: any;
    }): T;
    get selected(): (T | Wire)[];
    get items(): T[];
    get wires(): Wire[];
    get all(): (T | Wire)[];
    get empty(): boolean;
    get size(): number;
    get store(): CompStore;
    /**
     * @description gets the component
     * @param id component's id
     */
    get(id: string): T | Wire | undefined;
    /**
     * @description creates a library component container
     * @param options configurable options, see below:
     *
     * - store: CompStore;  component store
     */
    constructor(options: {
        [x: string]: any;
    });
    defaults(): IContainerDefaults<T>;
    root(name: string): IBaseComponent | undefined;
    hasItem(id: string): boolean;
    selectAll(value: boolean): (T | Wire)[];
    toggleSelect(comp: T): void;
    selectThis(comp: T | Wire): boolean;
    unselectThis(comp: T): void;
    selectRect(rect: Rect): void;
    deleteSelected(): number;
    destroy(): void;
    boundariesRect(): Rect;
    /**
     * @description adds a new component to this container
     * @param options disctionary of options
     */
    add(options: {
        [x: string]: any;
    }): T | Wire;
    /**
     * @description deletes a component from the board, and unbonds all nodes
     * @param comp component
     */
    delete(comp: T | Wire): boolean;
    /**
     * @description gets all bonds of a component
     * @param item component
     */
    itemBonds(item: T | Wire): Bond[] | undefined;
    /**
     * @description returns the bonds of a node
     * @param item board component
     * @param node 0-based node
     */
    nodeBonds(item: T | Wire, node: number): Bond | undefined;
    /**
     * @description bonds two components two-way
     * @param thisObj start component
     * @param node 0-based node
     * @param ic component to bond to
     * @param icNode component node
     */
    bond(thisObj: T | Wire, thisNode: number, ic: T | Wire, icNode: number): boolean;
    protected bondOneWay(thisObj: T | Wire, thisNode: number, ic: T | Wire, icNode: number, dir: BondDir): boolean;
    /**
       * @description unbonds a node from a component
       * @param thisObj component to unbond
       * @param node 0-base node to unbond
       * @param id component to unbond from
       */
    unbond(thisObj: T | Wire, node: number, id: string): IUnbondData | undefined;
    /**
     * @description unbonds a component node
     * @param thisObj component to be unbonded
     * @param node 0-based node
     * @returns undefined if not bonded, otherwise thisObj::Bond.dir and list of disconnected wire ids
     */
    unbondNode(thisObj: T | Wire, node: number): IUnbondNodeData | undefined;
    /**
     * @description removes all bonds of a component
     * @param comp component to disconnect
     * @returns list of removed component's id
     */
    disconnect(comp: T | Wire): string[];
    getAllBonds(): string[];
    moveBond(id: string, node: number, newIndex: number): void;
}