Files
react-diagrams/dist/src/Common.d.ts
Dylan Vorster f36a8cf304 + Cleaned up documentation
+ Added new events to the LinkModel for when ports change
+ Added properties allowing the canvas to lock its zoom and panning
+ Added option for disabling loose links
+ depreciated but did not remove the controlsUpdated event
2017-03-23 11:43:03 +02:00

169 lines
4.2 KiB
TypeScript

import { BaseEntity, BaseListener } from "./BaseEntity";
export interface BaseModelListener extends BaseListener {
selectionChanged?(item: BaseModel<BaseModelListener>, isSelected: boolean): void;
entityRemoved?(item: any): void;
}
/**
* @author Dylan Vorster
*/
export declare class BaseModel<T extends BaseModelListener> extends BaseEntity<BaseModelListener> {
selected: boolean;
constructor();
deSerialize(ob: any): void;
serialize(): {
id: string;
} & {
_class: string;
selected: boolean;
};
getID(): string;
isSelected(): boolean;
setSelected(selected?: boolean): void;
remove(): void;
}
export declare class PointModel extends BaseModel<BaseModelListener> {
x: number;
y: number;
link: LinkModel;
constructor(link: LinkModel, points: {
x: number;
y: number;
});
deSerialize(ob: any): void;
serialize(): {
id: string;
} & {
_class: string;
selected: boolean;
} & {
x: number;
y: number;
};
remove(): void;
updateLocation(points: {
x: number;
y: number;
}): void;
getX(): number;
getY(): number;
getLink(): LinkModel;
}
export interface LinkModelListener extends BaseModelListener {
sourcePortChanged?(item: LinkModel, target: null | PortModel): void;
targetPortChanged?(item: LinkModel, target: null | PortModel): void;
}
export declare class LinkModel extends BaseModel<LinkModelListener> {
linkType: string;
sourcePort: PortModel | null;
targetPort: PortModel | null;
points: PointModel[];
extras: {};
constructor();
deSerialize(ob: any): void;
serialize(): {
id: string;
} & {
_class: string;
selected: boolean;
} & {
type: string;
source: string;
sourcePort: string;
target: string;
targetPort: string;
points: ({
id: string;
} & {
_class: string;
selected: boolean;
} & {
x: number;
y: number;
})[];
extras: {};
};
remove(): void;
isLastPoint(point: PointModel): boolean;
getPointIndex(point: PointModel): number;
getPointModel(id: string): PointModel | null;
getFirstPoint(): PointModel;
getLastPoint(): PointModel;
setSourcePort(port: PortModel): void;
getSourcePort(): PortModel;
getTargetPort(): PortModel;
setTargetPort(port: PortModel): void;
getPoints(): PointModel[];
setPoints(points: PointModel[]): void;
removePoint(pointModel: PointModel): void;
addPoint(pointModel: PointModel, index?: number): void;
getType(): string;
}
export declare class PortModel extends BaseModel<BaseModelListener> {
name: string;
parentNode: NodeModel;
links: {
[id: string]: LinkModel;
};
deSerialize(ob: any): void;
serialize(): {
id: string;
} & {
_class: string;
selected: boolean;
} & {
name: string;
parentNode: string;
links: string[];
};
constructor(name: string);
getName(): string;
getParent(): NodeModel;
setParentNode(node: NodeModel): void;
removeLink(link: LinkModel): void;
addLink(link: LinkModel): void;
getLinks(): {
[id: string]: LinkModel;
};
}
export declare class NodeModel extends BaseModel<BaseModelListener> {
nodeType: string;
x: number;
y: number;
extras: {};
ports: {
[s: string]: PortModel;
};
constructor(nodeType?: string);
deSerialize(ob: any): void;
serialize(): {
id: string;
} & {
_class: string;
selected: boolean;
} & {
type: string;
x: number;
y: number;
extras: {};
ports: ({
id: string;
} & {
_class: string;
selected: boolean;
} & {
name: string;
parentNode: string;
links: string[];
})[];
};
remove(): void;
getPortFromID(id: any): PortModel | null;
getPort(name: string): PortModel | null;
getPorts(): {
[s: string]: PortModel;
};
removePort(port: PortModel): void;
addPort(port: PortModel): PortModel;
getType(): string;
}