Default implementation of the IOrthogonalEdgeHelper
Remarks
Type Details
- yfiles module
- view-editor
- yfiles-umd modules
- view-editor, view-table, view
- Legacy UMD name
- yfiles.input.OrthogonalEdgeHelper
Methods
Returns whether the given bend can be removed.
Remarks
true.Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context.
- bend - IBend
- The bend that is designated for removal.
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
Implements
getSegmentOrientation
(context: IInputModeContext, edge: IEdge, segmentIndex: number) : SegmentOrientationGets the orientation of the given segment by looking at the geometry of the segment.
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
Implements
Determines whether the provided edge should be edited orthogonally in the specified input mode context.
Remarks
If this method returns false, the other methods will not be queried at all.
The default implementation in this class always returns true.
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
Implements
Determines whether this end of the provided edge can be moved in the input mode context.
Remarks
This information is required to determine whether an edge's first or last segment needs to be split or the adjacent edge end can be moved along with the other end of the segment.
The default implementation in this class always returns false.
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.