documentationfor yFiles for HTML 3.0.0.3

Properties

wrappedParameterin CompositePortLocationModelParameterGets the wrapped parameter that was added via addParameter.
locationParameterin FoldingPortDefaultsGets or sets the IPortLocationModelParameter to use for initializing the folding ports.
locationParameterin FoldingPortStateGets or sets the IPortLocationModelParameter describing the position of this port.
locationParameterin IPortGets the IPortLocationModelParameter that is used to determine the location of this port.
locationParameterin IPortDefaultsGets or sets the location model parameter to use for ports.
locationParameterin PortDefaults
locationParameterin SimplePortGets or sets the IPortLocationModelParameter that is used to determine the location of this port.
locationParameterin IPortCandidateGets the model parameter that will be used for the locationParameter if this candidate is chosen.
locationParameterin PortCandidateGets or sets the model parameter that will be used for the locationParameter if this candidate is chosen.
portEndParameterin LayoutExecutorAsyncGets a mapping from ports in the LayoutGraph to their new location parameters, after the results are in.

Method Return Values

createParameter (IPortOwner, Point)in BendAnchoredPortLocationModel
copyPortLocationParameter (IGraph, IPort)in ClipboardGraphCopierCopies a IPortLocationModelParameter for a given port.
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.
createParameter (IPortOwner, Point)in EdgePathPortLocationModel
createParameter (IPortOwner, Point)in EdgeSegmentPortLocationModel
createParameter (IPortOwner, Point)in FreeNodePortLocationModel
getPortLocationParameter (ClipboardGraphCopier, IGraph, IPort, IPortOwner)in GraphClipboardGets an IPortLocationModelParameter for the given sourcePort to be placed at the given newTargetOwner.
copyPortLocationParameter (IGraph, IPort)in GraphCopierCopies a IPortLocationModelParameter for a given port.
createDefaultPortLocationParameter (IPortOwner, Point?)in IGraphCreates a location model parameter for a newly created IPort at the owner that matches the location.
getLocationParameterInstance (IPortOwner)in IPortDefaultsFactory method that returns a location model parameter 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
getNewPortLocationModelParameter (IPortOwner, IPort, Point)in PortDropInputModeDetermines the IPortLocationModelParameter the port should have if it was dropped at dragLocation over owner.
getNewParameter (IPort, IPortLocationModel, Point)in PortLocationModelParameterHandleObtains the new parameter for the given location and port.

Method Parameters

getLocation (IPort, IPortLocationModelParameter)in BendAnchoredPortLocationModel
addParameter (IPortLocationModelParameter, CompositePortLocationModelPortSide?, number?, number?)in CompositePortLocationModelAdds the given parameter to the locationParameters of this instance.
getLocation (IPort, IPortLocationModelParameter)in CompositePortLocationModel
getLocation (IPort, IPortLocationModelParameter)in EdgePathPortLocationModel
getLocation (IPort, IPortLocationModelParameter)in EdgeSegmentPortLocationModel
createGroupNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in FilteredGraphWrapper
createNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in FilteredGraphWrapper
FoldingPortDefaults (IPortDefaults?, )in FoldingPortDefaultsCreates a new instance of this type, optionally configuring the values from the given IPortDefaults object.
getLocation (IPort, IPortLocationModelParameter)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.
createEdge (INode, INode, IEdgeStyle?, IEdge['tag']?, )in GraphCreates and returns an edge that connects to the given node instances using the given style instance.
createEdge (IPort, IPort, IEdgeStyle?, IEdge['tag']?, )in Graph
createGroupNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in Graph
createNode (Rect, INodeStyle?, INode['tag']?, )in Graph
createNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in Graph
createUndoUnitForLocationParameterChange (IPort, IPortLocationModelParameter)in GraphCreates the undo unit for changing the location parameter of the given port.
onChangingPortLocationModelParameter (IPort, IPortLocationModelParameter)in GraphCalled before the locationParameter of a port is being changed.
onPortLocationParameterChanged (IPort, IPortLocationModelParameter)in GraphCalled after a port location model parameter has changed.
setPortLocationParameter (IPort, IPortLocationModelParameter)in Graph
addPort (IPortOwner, IPortLocationModelParameter?, IPortStyle?, IPort['tag']?)in GraphWrapperBase
createEdge (IPort, IPort, IEdgeStyle?, IEdge['tag']?, )in GraphWrapperBase
createEdge (INode, INode, IEdgeStyle?, IEdge['tag']?, )in GraphWrapperBase
createGroupNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in GraphWrapperBase
createNode (Rect, INodeStyle?, INode['tag']?, )in GraphWrapperBase
createNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in GraphWrapperBase
onPortLocationParameterChanged (ItemChangedEventArgs<IPort,IPortLocationModelParameter>)in GraphWrapperBaseRaises the port-location-parameter-changed event
setPortLocationParameter (IPort, IPortLocationModelParameter)in GraphWrapperBase
addPort (IPortOwner, IPortLocationModelParameter?, IPortStyle?, IPort['tag']?)in IGraphAdd a port to the given port owner using the location model parameter, style, and tag.
createEdge (IPort, IPort, IEdgeStyle?, IEdge['tag']?, )in IGraphCreates and returns an edge that connects to the given port instances.
createEdge (INode, INode, IEdgeStyle?, IEdge['tag']?, )in IGraphCreates and returns an edge that connects to the given node instances using the given style instance.
createGroupNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in IGraphCreates a new group node using the provided style and layout as a child of parent.
createNode (Rect, INodeStyle?, INode['tag']?, )in IGraphCreates and returns a node using the specified values for the initial geometry, style, and tag.
createNode (INode?, Rect?, INodeStyle?, INode['tag']?, )in IGraphCreates a new ordinary node as a direct descendant of parent using the given layout and style.
createNodeAt (Point, INodeStyle?, INode['tag']?, )in IGraphCreates and returns a node using the specified initial center location and style, as well as the tag.
groupNodes (IEnumerable<INode>, INodeStyle?, any?, )in IGraphGroups the nodes in children into a newly created group node.
setPortLocationParameter (IPort, IPortLocationModelParameter)in IGraphSets a new IPortLocationModelParameter for the given port.
getLocation (IPort, IPortLocationModelParameter)in IPortLocationModelDetermines the location of the port for the given parameter.
PortDefaults ()in PortDefaultsInitializes a new instance of the PortDefaults class using a trivial location model parameter.
SimplePort (IPortOwner?, IPortLocationModelParameter?, )in SimplePortCreates a port with a default lookup using the given location and owner.
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.
createInstance (IInputModeContext, IGraph, IPortLocationModelParameter, IPortStyle, IPort['tag'])in PortCandidateActually creates the IPort instance.
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.
createPort (IInputModeContext, IGraph, IPort, IPortOwner, IPortLocationModelParameter)in PortDropInputModeCreates the port in the graph after it has been dropped.
setParameter (IGraph, IPort, IPortLocationModelParameter)in PortLocationModelParameterHandleApplies the parameter.
createGraphAnimation (IGraph, IMapper<INode,IRectangle>?, IMapper<IEdge,yfiles.geometry.IPoint[]>?, IMapper<IPort,IPortLocationModelParameter>?, IMapper<ILabel,ILabelModelParameter>?, TimeSpan?)in IAnimationCreates a new IAnimation that animates the given layout of all types of graph items.
createPortAnimation (IGraph, IPort, IPortLocationModelParameter, TimeSpan)in IAnimationCreates a new IAnimation that animates the given port from its current location to the new location given by the targetLocationParameter.