OrthogonalEdgeHelper

Default implementation of the IOrthogonalEdgeHelper.

Inheritance Hierarchy

OrthogonalEdgeHelper

Implemented Interfaces

Remarks

This class inspects the edge it was queried for and infers the SegmentOrientations of the segments from the current geometry of the edge path.

Examples

Setting a configured orthogonal edge helper

graph.decorator.edges.orthogonalEdgeHelper.addFactory(
  (edge) =>
    new OrthogonalEdgeHelper({
      edge,
      implicitlyMoveEnds: true,
    }),
)

Type Details

yFiles module: view

Constructors

OrthogonalEdgeHelper

(edge: IEdge, orthogonalEditing?: boolean, implicitlyMoveEnds?: boolean)

Creates a new instance with optional static default return values for shouldEditOrthogonally and shouldMoveEndImplicitly.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to inspect.
orthogonalEditing - boolean: The static default return value of shouldEditOrthogonally. true
implicitlyMoveEnds - boolean

Properties

edge

: IEdge

Gets the edge this helper was created for.

Methods

canRemoveBend

(context: IInputModeContext, bend: IBend) : boolean

Returns whether the given bend can be removed.

Remarks

This implementation always returns true.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The input mode context.
bend - IBend: The bend that is designated for removal.

Returns

↪boolean: true if the specified bend can be removed; otherwise, false.

cleanUpEdge

(context: IInputModeContext, graph: IGraph)

Invoked after the edge has been edited orthogonally.

Remarks

The default implementation in this class removes duplicate and collinear bends, as well as segments of zero length.

Parameters

options - Object
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.

Implements

IOrthogonalEdgeHelper

getSegmentOrientation

(context: IInputModeContext, segmentIndex: number) : SegmentOrientation

Gets the orientation of the given segment by looking at the geometry of the segment.

Remarks

If the segment has a zero length, the adjacent segments will be inspected to infer the orientation such that the orientation toggles between VERTICAL and HORIZONTAL.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The input mode context in which the orientation is needed.
segmentIndex - number: The index of the segment.

Returns

↪SegmentOrientation: The declared orientation of the segment.

Implements

IOrthogonalEdgeHelper

shouldEditOrthogonally

(context: IInputModeContext) : boolean

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

options - Object
A map of options to pass to the method.

context - IInputModeContext: The input mode context in which the edge is about to be edited.

Returns

↪boolean: true if the edge should be orthogonally edited in the specified input mode context; false otherwise.

Implements

IOrthogonalEdgeHelper

shouldMoveEndImplicitly

(context: IInputModeContext, sourceEnd: boolean) : boolean

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

options - Object
A map of options to pass to the method.

context - IInputModeContext: The input mode context in which the segment is edited.
sourceEnd - boolean: if set to true the source end of the edge is queried, otherwise the target end.

Returns

↪boolean: true if the end of the edge can be moved for the specified input mode context; false otherwise, in which case the corresponding segment needs to be split to keep the segment orientation orthogonal.

Implements

IOrthogonalEdgeHelper