documentationfor yFiles for HTML 3.0.0.3

Usages of IPortOwner

Properties

sourcePortOwnerin EdgeEventArgsGets the owner of the source port the edge was connected to before the event happened.
targetPortOwnerin EdgeEventArgsGets the owner of the target port the edge was connected to before the event happened.
ownerin IPortGets the owner of this port.
ownerin PortEventArgsGets the owner of the port that was connected to before the event happened.
ownerin SimplePortGets or sets the owner of this port.
ownerin IPortCandidateGets the possible owner of the port to be created for this candidate.
transformedPortOwnersin OrthogonalEdgeEditingContextGets the enumeration of IPortOwner instances that are being transformed during the edit.
ownerin PortCandidateGets or sets the owner of the port to be created.
isValidPortOwnerPredicatein PortDropInputModeGets or sets the callback for testing whether an existing port owner in the graph can be used as owner for the currently dragged port.

Fields

portOwnerin PortsHandleProviderThe owner of the ports.

Method Return Values

getTargetPortOwner (ClipboardOperationContext, IPort)in GraphClipboardProvides an IPortOwner where the given sourcePort can be added to.
opposite (IPortOwner)in IEdgeGets the opposite port owner of an IEdge.
getEndPortOwner (Point)in CreateEdgeInputModeFinds the end port owner at the specified location.
getPortOwner (Point)in CreateEdgeInputModeRetrieves the port owner at a given position in world coordinates.
getPortOwners ()in CreateEdgeInputModeRetrieves the port owners from the graph in the order of their importance.
getStartPortOwner (Point)in CreateEdgeInputModeFinds the start port owner at the specified location.
getCurrentOwner (IInputModeContext, Point)in PortRelocationHandleGets the IPortOwner at the given location.

Method Parameters

createParameter (IPortOwner, Point)in BendAnchoredPortLocationModel
addPort (ClipboardOperationContext, IPortOwner, IPort)in ClipboardGraphCopierAdds a port to the targetOwner in the targetGraph as a copy of the sourcePort.
createParameter (IPortOwner, Point)in CompositePortLocationModelFactory method that creates a parameter for the given owner that tries to match the provided location in absolute world coordinates.
EdgeEventArgs (IEdge, IPort?, IPort?, IPortOwner?, IPortOwner?)in EdgeEventArgsInitializes a new instance of the EdgeEventArgs class.
createParameter (IPortOwner, Point)in EdgePathPortLocationModel
createParameter (IPortOwner, Point)in EdgeSegmentPortLocationModel
edgesAt (IPortOwner, AdjacencyTypes?)in FilteredGraphWrapper
createParameter (IPortOwner, Point)in FreeNodePortLocationModel
addPort (IPortOwner, IPortLocationModelParameter?, IPortStyle?, IPort['tag']?)in GraphAdd a port to the given port owner using the coordinates as the new initial position of the port anchor.
edgesAt (IPortOwner, AdjacencyTypes?)in Graph
getNewSourcePort (IPortOwner)in GraphDetermines a IPort instance to use for the creation of a new edge that starts at the given IPortOwner.
getNewTargetPort (IPortOwner)in GraphDetermines a IPort instance to use for the creation of a new edge that ends at the given IPortOwner.
onAddingPort (IPortOwner, IPort)in GraphCalled when a port is going to be added to a node.
onPortRemoved (IPortOwner, IPort)in GraphCalled just after a port has been removed from its owner.
getPortLocationParameter (ClipboardGraphCopier, IGraph, IPort, IPortOwner)in GraphClipboardGets an IPortLocationModelParameter for the given sourcePort to be placed at the given newTargetOwner.
addPort (IGraph, IGraph, IPortOwner, IPort)in GraphCopierAdds a port to the targetOwner in the targetGraph as a copy of the sourcePort.
addPort (IPortOwner, IPortLocationModelParameter?, IPortStyle?, IPort['tag']?)in GraphWrapperBase
edgesAt (IPortOwner, AdjacencyTypes?)in GraphWrapperBase
opposite (IPortOwner)in IEdgeGets the opposite port owner of an IEdge.
addPort (IPortOwner, IPortLocationModelParameter?, IPortStyle?, IPort['tag']?)in IGraphAdd a port to the given port owner using the location model parameter, style, and tag.
addPortAt (IPortOwner, Point, IPortStyle?, IPort['tag']?)in IGraphAdd a port to the given port owner using the absolute coordinates as the new initial position of the port anchor.
clearPorts (IPortOwner)in IGraphRemoves all ports from the given IPortOwner, which can be an INode or an IEdge.
createDefaultPortLocationParameter (IPortOwner, Point?)in IGraphCreates a location model parameter for a newly created IPort at the owner that matches the location.
degree (IPortOwner)in IGraphCalculates the number of edges at the given IPortOwner for this graph.
edgesAt (IPortOwner, AdjacencyTypes?)in IGraphReturns an IListEnumerable<T> for the incoming, the outgoing, or all edges adjacent to the given port owner, depending on type.
getEdge (IPortOwner, IPortOwner)in IGraphFinds an edge that connects from and to in the given graph.
getEdgesBetween (IPortOwner, IPortOwner, boolean?)in IGraphReturns the edges between the specified source and target owners.
getPortDefaults (IPortOwner)in IGraphGets the IPortDefaults for a given IPortOwner in the context of the graph.
inDegree (IPortOwner)in IGraphCalculates the number of incoming edges at the given IPortOwner for this graph.
inEdgesAt (IPortOwner)in IGraphReturns the incoming edges at the given owner.
outDegree (IPortOwner)in IGraphCalculates the number of outgoing edges at the given IPortOwner for this graph.
outEdgesAt (IPortOwner)in IGraphReturns the outgoing edges at the given owner.
getLocationParameterInstance (IPortOwner)in IPortDefaultsFactory method that returns a location model parameter instance for use with newly created ports.
getStyleInstance (IPortOwner)in IPortDefaultsFactory method that returns a style instance for use with newly created ports.
createParameter (IPortOwner, Point)in IPortLocationModelFactory method that creates a parameter for the given owner that tries to match the provided location in absolute world coordinates.
getLocationParameterInstance (IPortOwner)in PortDefaults
getStyleInstance (IPortOwner)in PortDefaults
PortEventArgs (IPort, IPortOwner)in PortEventArgsInitializes a new instance of the PortEventArgs class.
SimplePort (IPortOwner?, IPortLocationModelParameter?, )in SimplePortCreates a port with a default lookup using the given location and owner.
addPort (IParseContext, IPortOwner)in IGraphElementFactoryAdds a new port to the given IPortOwner.
create ()in IGraphElementFactory
getEndPortCandidateProvider (IPortCandidate, IPortOwner, Point)in CreateEdgeInputModeRetrieves the port candidate provider instance given a start port candidate and a possible ending item.
getStartPortCandidateProvider (IPortOwner)in CreateEdgeInputModeRetrieves the port candidate provider instance given a port owner for the start of the gesture.
fromExistingPorts (IPortOwner)in IPortCandidateProviderCreates an implementation of the IPortCandidateProvider interface that returns the ports that exist in the given ports's IPortOwner collection.
fromPortDefaults (IPortOwner)in IPortCandidateProviderCreates an implementation of an IPortCandidateProvider that always returns a candidate that uses the default locationParameter for the corresponding IPortDefaults.
fromShapeGeometry (IPortOwner, number)in IPortCandidateProviderCreates an implementation of IPortCandidateProvider that works for IPortOwner implementations that have IShapeGeometry instances in their lookup.
fromShapeGeometry (IPortOwner, boolean, number, number)in IPortCandidateProviderCreates an implementation of IPortCandidateProvider that works for IPortOwner implementations that have IShapeGeometry instances in their lookup.
fromUnoccupiedPorts (IPortOwner)in IPortCandidateProviderCreates an implementation of an IPortCandidateProvider that returns unoccupied ports at a given entity.
addTransformedPortOwner (IPortOwner)in OrthogonalEdgeEditingContextAdds an IPortOwner that is being transformed somehow during the edit so that the attached ports will be moved in an irregular ( non-linear) way.
createOrthogonalEdgeDragHandler (IInputModeContext, IPortOwner, boolean)in OrthogonalEdgeEditingContextCreates an OrthogonalEdgeDragHandler that keeps the orthogonal edges attached to portOwner orthogonal while the port owner is moved or reshaped interactively.
PortCandidate (IPortOwner, IPortLocationModel)in PortCandidateCreates a candidate for the given owner that uses the graph's defaults for the port's style and a default parameter for the given model.
PortCandidate (IPortOwner, IPortLocationModelParameter?, PortCandidateValidity?)in PortCandidateCreates a candidate for the given owner that uses the graph's defaults for the port's style and the given locationParameter.
addExistingPorts (IPortOwner, IList<IPortCandidate>)in PortCandidateProviderBaseAdds candidates for all existing ports of the owner to the provided list.
createCandidate (IPortOwner, IPortLocationModelParameter, boolean?)in PortCandidateProviderBaseFactory method that creates a candidate that will use the createInstance method of this instance to delegate createPort queries to.
PortDropInputMode (string, )in PortDropInputModeInitializes a new instance of the PortDropInputMode class for the given data type.
createPort (IInputModeContext, IGraph, IPort, IPortOwner, IPortLocationModelParameter)in PortDropInputModeCreates the port in the graph after it has been dropped.
getNewPortLocationModelParameter (IPortOwner, IPort, Point)in PortDropInputModeDetermines the IPortLocationModelParameter the port should have if it was dropped at dragLocation over owner.
isValidPortOwner (IPortOwner, IPort)in PortDropInputModeDefault backing method for isValidPortOwnerPredicate
PortsHandleProvider (IPortOwner)in PortsHandleProviderCreates an instance using the given owner as the provider for the ports.

Implementing Types

IEdgeThe interface used to model edges in an IGraph implementation.
INodeThe interface for node entities in an IGraph.