react-design-editor
Version:
Design Editor Tools with React.js + ant.design + fabric.js
107 lines • 2.59 kB
TypeScript
import { LinkObject } from '../objects';
import { PortObject } from '../objects/Port';
import Handler from './Handler';
export interface LinkOption {
/**
* Link Type
* @type {string}
*/
type: string;
/**
* FromNode id of Link
* @type {string}
*/
fromNodeId?: string;
/**
* FromPort id of Link
* @type {string}
*/
fromPortId?: string;
/**
* ToNode id of Link
* @type {string}
*/
toNodeId?: string;
/**
* ToPort id of Link
* @type {string}
*/
toPortId?: string;
}
/**
* Link Handler Class
* @author salgum1114
* @class LinkHandler
*/
declare class LinkHandler {
private port;
handler: Handler;
constructor(handler: Handler);
/**
* On source port click, start link
* @param {PortObject} port
*/
init: (port: PortObject) => void;
/**
* End drawing link.
*/
finish: (link?: LinkObject) => void;
/**
* On dest port click, finish link
* @param {PortObject} port
*/
generate: (port: PortObject) => void;
/**
* Add link in Canvas
* @param {LinkOption} option
* @param {boolean} [loaded=false]
* @returns
*/
create: (option: LinkOption, loaded?: boolean) => LinkObject;
/**
* When the link is deleted, linked FromNode delete
* @param {LinkObject} link
*/
removeFrom: (link: LinkObject) => void;
/**
* When the link is deleted, linked ToNode delete
* @param {LinkObject} link
*/
removeTo: (link: LinkObject) => void;
/**
* When the link is deleted, linked node delete
* @param {LinkObject} link
*/
removeAll: (link: LinkObject) => void;
/**
* Remove link in canvas
* @param {LinkObject} link
* @param {string} [type]
*/
remove: (link: LinkObject, type?: string) => void;
/**
* Check if there is a port connected
* @param {PortObject} port
* @returns
*/
isConnected: (port: PortObject) => boolean;
/**
* Check if select same node
* @param {PortObject} port
* @returns
*/
isSameNode: (port: PortObject) => boolean;
/**
* Check if select same node
* @param {PortObject} port
* @returns
*/
isDuplicate: (port: PortObject) => boolean;
/**
* Check if draw the link
* @returns
*/
isDrawing: () => any;
}
export default LinkHandler;
//# sourceMappingURL=LinkHandler.d.ts.map