Interface used by OrthogonalEdgeEditingContext and the like that can be decorated to the ILookup of IEdges.
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.IOrthogonalEdgeHelper
See Also
Methods
Invoked after the provided edge has been edited orthogonally.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context which edited the edge.
- graph - IGraph
- The graph to use for modifying the edge instance.
- edge - IEdge
- The edge to clean up the path.
See Also
getSegmentOrientation
(context: IInputModeContext, edge: IEdge, segmentIndex: number) : SegmentOrientationGets the declared orientation of the given segment at the provided edge.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context in which the orientation is needed.
- edge - IEdge
- The edge to inspect.
- segmentIndex - number
- The index of the segment.
Returns
- ↪SegmentOrientation
- The declared orientation of the segment.
See Also
Determines whether the provided edge should be edited orthogonally in the specified input mode context.
Remarks
false, the other methods will not be queried at all.Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context in which the edge is about to be edited.
- edge - IEdge
- The edge to inspect.
Returns
- ↪boolean
trueif the edge should be orthogonally edited in the specified input mode context;falseotherwise.
See Also
Determines whether this end of the provided edge can be moved in the input mode context.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context in which the segment is edited.
- edge - IEdge
- The edge to inspect.
- sourceEnd - boolean
- if set to
truethe source end of the edge is queried, otherwise the target end.
Returns
- ↪boolean
trueif the end of the edge can be moved for the specified input mode context;falseotherwise, in which case the corresponding segment needs to be split to keep the segment orientation orthogonal.
See Also
Static Methods
Creates an implementation of the interface IOrthogonalEdgeHelper from the given definition.
Remarks
Parameters
A map of options to pass to the method.
- getSegmentOrientation - function(IInputModeContext, IEdge, number):SegmentOrientation
Gets the declared orientation of the given segment at the provided edge.
This property holds the implementation for getSegmentOrientation.
- shouldMoveEndImplicitly - function(IInputModeContext, IEdge, boolean):boolean
Determines whether this end of the provided edge can be moved in the input mode context.
This property holds the implementation for shouldMoveEndImplicitly.
- shouldEditOrthogonally - function(IInputModeContext, IEdge):boolean
Determines whether the provided edge should be edited orthogonally in the specified input mode context.
This property holds the implementation for shouldEditOrthogonally.
- cleanUpEdge - function(IInputModeContext, IGraph, IEdge):void
Invoked after the provided edge has been edited orthogonally.
This property holds the implementation for cleanUpEdge.
Returns
- ↪IOrthogonalEdgeHelper
- An instance of the IOrthogonalEdgeHelper interface based on the given definition.