Class DiagramPort
Inheritance
Namespace: Syncfusion.EJ2.Diagrams
Assembly: Syncfusion.EJ2.dll
Syntax
public class DiagramPort : EJTagHelper
Constructors
DiagramPort()
Declaration
public DiagramPort()
Properties
AddInfo
Allows the user to save custom information/data about a port
Declaration
public object AddInfo { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ConnectionDirection
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.
Declaration
public PortConnectionDirection ConnectionDirection { get; set; }
Property Value
Type | Description |
---|---|
PortConnectionDirection | The default value is PortConnectionDirection.Auto |
Constraints
Defines the constraints of port
Declaration
public PortConstraints Constraints { get; set; }
Property Value
Type | Description |
---|---|
PortConstraints | The default value is PortConstraints.Default |
Height
Sets the height of the port
Declaration
public double Height { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 12 |
HorizontalAlignment
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
Declaration
public HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
Type | Description |
---|---|
HorizontalAlignment | The default value is HorizontalAlignment.Center |
Id
Defines the unique id of the port
Declaration
public override string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Overrides
InEdges
Defines the collection of the objects that are connected to a particular port
Declaration
public string[] InEdges { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The default value is null |
Margin
Defines the space that the port has to be moved from its actual position
Declaration
public DiagramMargin Margin { get; set; }
Property Value
Type | Description |
---|---|
DiagramMargin | The default value is null |
Offset
Defines the position of the port with respect to the boundaries of nodes/connector
Declaration
public DiagramPoint Offset { get; set; }
Property Value
Type | Description |
---|---|
DiagramPoint | The default value is null |
OutEdges
Defines the collection of the objects that are connected to a particular port
Declaration
public string[] OutEdges { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The default value is null |
PathData
Defines the geometry of the port
Declaration
public string PathData { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Shape
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
Declaration
public PortShapes Shape { get; set; }
Property Value
Type | Description |
---|---|
PortShapes | The default value is PortShapes.Square |
Style
Defines the appearance of the port
Declaration
public DiagramShapeStyle Style { get; set; }
Property Value
Type | Description |
---|---|
DiagramShapeStyle | The default value is null |
Tooltip
defines the tooltip for the Ports
Declaration
public object Tooltip { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
VerticalAlignment
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
Declaration
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
Type | Description |
---|---|
VerticalAlignment | The default value is VerticalAlignment.Center |
Visibility
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
Declaration
public PortVisibility Visibility { get; set; }
Property Value
Type | Description |
---|---|
PortVisibility | The default value is PortVisibility.Connect |
Width
Sets the width of the port
Declaration
public double Width { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 12 |