@syncfusion/ej2-diagrams
Version:
Feature-rich diagram control to create diagrams like flow charts, organizational charts, mind maps, and BPMN diagrams. Its rich feature set includes built-in shapes, editing, serializing, exporting, printing, overview, data binding, and automatic layouts.
213 lines (187 loc) • 6.23 kB
TypeScript
import { Property, Complex, ChildProperty } from '@syncfusion/ej2-base';import { ShapeStyle, Margin } from '../core/appearance';import { ShapeStyleModel, MarginModel } from '../core/appearance-model';import { Point } from '../primitives/point';import { PointModel } from '../primitives/point-model';import { HorizontalAlignment, VerticalAlignment, PortShapes, PortConstraints, PortVisibility, PortAlignment, PortConnectionDirection } from '../enum/enum';import { DiagramTooltip } from './tooltip';import { DiagramTooltipModel } from './tooltip-model';
/**
* Interface for a class Port
*/
export interface PortModel {
/**
* Defines the unique id of the port
*
* @default ''
*/
id?: string;
/**
* Sets the horizontal alignment of the port with respect to its immediate parent(node/connector)
* * Stretch - Stretches the diagram element throughout its immediate parent
* * Left - Aligns the diagram element at the left of its immediate parent
* * Right - Aligns the diagram element at the right of its immediate parent
* * Center - Aligns the diagram element at the center of its immediate parent
* * Auto - Aligns the diagram element based on the characteristics of its immediate parent
*
* @default 'Center'
*/
horizontalAlignment?: HorizontalAlignment;
/**
* Sets the vertical alignment of the port with respect to its immediate parent(node/connector)
* * Stretch - Stretches the diagram element throughout its immediate parent
* * Top - Aligns the diagram element at the top of its immediate parent
* * Bottom - Aligns the diagram element at the bottom of its immediate parent
* * Center - Aligns the diagram element at the center of its immediate parent
* * Auto - Aligns the diagram element based on the characteristics of its immediate parent
*
* @default 'Center'
*/
verticalAlignment?: VerticalAlignment;
/**
* Defines the space that the port has to be moved from its actual position
*
* @default new Margin(0,0,0,0)
*/
margin?: MarginModel;
/**
* Sets the width of the port
*
* @default 12
*/
width?: number;
/**
* Sets the height of the port
*
* @default 12
*/
height?: number;
/**
* Defines the appearance of the port
* ```html
* <div id='diagram'></div>
* ```
* ```typescript
* let port: PointPortModel[] =
* [{ id: 'port1', visibility: PortVisibility.Visible, shape: 'Circle', offset: { x: 0, y: 0 } },];
* let nodes: NodeModel[] = [{
* id: 'node1', width: 100, height: 100, offsetX: 100, offsetY: 100,
* }];
* nodes.ports = port;
* let diagram: Diagram = new Diagram({
* ...
* nodes : nodes,
* ...
* });
* diagram.appendTo('#diagram');
* ```
*
* @default {}
*/
style?: ShapeStyleModel;
/**
* Defines the type of the port shape
* * X - Sets the decorator shape as X
* * Circle - Sets the decorator shape as Circle
* * Square - Sets the decorator shape as Square
* * Custom - Sets the decorator shape as Custom
*
* @default 'Square'
*/
shape?: PortShapes;
/**
* Defines the allowed direction for connections to the port
* * Auto - Maintains the default behavior of automatic direction calculation.
* * Left - Restricts connections to only connect to the left side of the port.
* * Top - Restricts connections to only connect to the top side of the port.
* * Right - Restricts connections to only connect to the right side of the port.
* * Bottom - Restricts connections to only connect to the bottom side of the port.
*
* @default 'Auto'
*/
connectionDirection?: PortConnectionDirection;
/**
* Defines the type of the port visibility
* * Visible - Always shows the port
* * Hidden - Always hides the port
* * Hover - Shows the port when the mouse hovers over a node
* * Connect - Shows the port when a connection end point is dragged over a node
*
* @default 'Connect'
* @aspNumberEnum
*/
visibility?: PortVisibility;
/**
* Defines the geometry of the port
*
* @default ''
*/
pathData?: string;
/**
* Defines the constraints of port
*
* @default 'Default'
* @aspNumberEnum
*/
constraints?: PortConstraints;
/**
* Allows the user to save custom information/data about a port
*
* @aspDefaultValueIgnore
* @default undefined
*/
addInfo?: Object;
/**
* Defines the collection of the objects that are connected to a particular port
*
* @default undefined
* @blazorDefaultValue new string[] { }
*/
outEdges?: string[];
/**
* Defines the collection of the objects that are connected to a particular port
*
* @default undefined
* @blazorDefaultValue new string[] { }
*/
inEdges?: string[];
/**
* defines the tooltip for the Ports
*
* @default new DiagramToolTip();
*/
tooltip?: DiagramTooltipModel;
}
/**
* Interface for a class PointPort
*/
export interface PointPortModel extends PortModel{
/**
* Defines the position of the port with respect to the boundaries of nodes/connector
*
* @default new Point(0.5,0.5)
* @blazorType NodePortOffset
*/
offset?: PointModel;
}
/**
* Interface for a class PathPort
*/
export interface PathPortModel extends PortModel{
/**
* Sets the segment offset of port
*
* @default 0.5
*/
offset?: number;
/**
* Sets the displacement of an ports from its actual position
*
* @aspDefaultValueIgnore
* @blazorDefaultValueIgnore
* @default undefined
*/
displacement?: PointModel;
/**
* Sets the segment alignment of ports
* * Center - Aligns the ports at the center of a connector segment
* * Before - Aligns the ports before a connector segment
* * After - Aligns the ports after a connector segment
*
* @default Center
*/
alignment?: PortAlignment;
}