Variable: allowHandleBoundsCheck
Specifies if the bounds of handles should be used for hit-detection in IE Default is true.
Variable: bends
Holds the
Variable: cloneEnabled
Specifies if cloning by control-drag is enabled. Default is true.
Variable: constraintHandler
Holds the
Variable: dblClickRemoveEnabled
Specifies if removing bends by double click is enabled. Default is false.
Variable: error
Holds the current validation error while a connection is being changed.
Variable: graph
Reference to the enclosing
Variable: handleImage
Optional
Variable: labelShape
Holds the
Variable: manageLabelHandle
Specifies if the label handle should be moved if it intersects with another
handle. Uses
Variable: marker
Holds the
Variable: mergeRemoveEnabled
Specifies if removing bends by dropping them on other bends is enabled. Default is false.
Variable: outlineConnect
Specifies if connections to the outline of a highlighted target should be enabled. This will allow to place the connection point along the outline of the highlighted target. Default is false.
Variable: parentHighlightEnabled
Specifies if the parent should be highlighted if a child cell is selected. Default is false.
Variable: preferHtml
Specifies if bends should be added to the graph container. This is updated
in
Variable: removeEnabled
Specifies if removing bends by shift-click is enabled. Default is false. Note: This experimental feature is not recommended for production use.
Variable: shape
Holds the
Variable: snapToTerminals
Specifies if waypoints should snap to the routing centers of terminals. Default is false.
Variable: state
Reference to the
Variable: straightRemoveEnabled
Specifies if removing bends by creating straight segments should be enabled. If enabled, this can be overridden by holding down the alt key while moving. Default is false.
Variable: tolerance
Optional tolerance for hit-detection in
Variable: virtualBendOpacity
Opacity to be used for virtual bends (see
Variable: virtualBendsEnabled
Specifies if virtual bends should be added in the center of each segments. These bends can then be used to add new waypoints. Default is false.
Function: addPoint
Adds a control point for the given state and event.
Function: addPointAt
Adds a control point at the given point.
Function: checkLabelHandle
Checks if the label handle intersects the given bounds and moves it if it intersects.
Function: clonePreviewState
Returns a clone of the current preview state for the given point and terminal.
Overriden to merge edge segments.
Function: convertPoint
Converts the given point in-place from screen to unscaled, untranslated graph coordinates and applies the grid. Returns the given, modified point instance.
Parameters:
point -
Function: createBends
Creates and returns the bends used for modifying the edge. This is
typically an array of
Function: createCustomHandles
Returns an array of custom handles. This implementation returns null.
Function: createHandleShape
Creates the shape used to display the given bend. Note that the index may be null for special cases, such as when called from <mxElbowEdgeHandler.createVirtualBend>. Only images and rectangles should be returned if support for HTML labels with not foreign objects is required. Index if null for virtual handles.
Function: createLabelHandleShape
Creates the shape used to display the the label handle.
Function: createMarker
Creates and returns the
Function: createSelectionShape
Creates the shape used to draw the selection border.
Function: createVirtualBends
Creates and returns the bends used for modifying the edge. This is
typically an array of
Function: destroy
Destroys the handler and all its resources and DOM nodes. This does normally not need to be called as handlers are destroyed automatically when the corresponding cell is deselected.
Function: destroyBends
Destroys all elements in
Function: drawPreview
Redraws the preview.
Function: getCellAt
Creates and returns the
Function: getCurrentPoints
Returns the current absolute points.
Function: getHandleFillColor
Returns the fillcolor for the handle at the given index.
Function: getHandleForEvent
Returns the index of the handle for the given event.
Function: getPointForEvent
Returns the point for the given event.
Function: getPreviewTerminalState
Updates the given preview state taking into account the state of the constraint handler.
Function: getSelectionColor
Returns <mxConstants.EDGE_SELECTION_COLOR>.
Function: getSelectionPoints
Returns the list of points that defines the selection stroke.
Function: getSelectionStrokeWidth
Returns <mxConstants.EDGE_SELECTION_STROKEWIDTH>.
Function: getSnapToTerminalTolerance
Returns the tolerance for the guides. Default value is gridSize * scale / 2.
Function: getTooltipForNode
Returns no tooltips.
Function: init
Initializes the shapes required for this edge handler.
Function: initBend
Helper method to initialize the given bend.
Parameters:
bend -
Function: isAddPointEvent
Returns true if the given event is a trigger to add a new point. This implementation returns true if shift is pressed.
Function: isAddVirtualBendEvent
Returns true if the given event allows virtual bends to be added. This implementation returns true.
Function: isConnectableCell
Returns true if the given cell is connectable. This is a hook to disable floating connections. This implementation returns true.
Function: isCustomHandleEvent
Returns true if the given event allows custom handles to be changed. This implementation returns true.
Function: isHandleEnabled
Creates the shape used to display the given bend.
Function: isHandleVisible
Returns true if the handle at the given index is visible.
Function: isOutlineConnectEvent
Returns true if
Function: isRemovePointEvent
Returns true if the given event is a trigger to remove a point. This implementation returns true if shift is pressed.
Function: isSelectionDashed
Returns <mxConstants.EDGE_SELECTION_DASHED>.
Function: isSnapToTerminalsEvent
Returns true if
Function: isVirtualBendsEnabled
Returns true if virtual bends should be added. This returns true if
Function: mouseDown
Handles the event by checking if a special element of the handler
was clicked, in which case the index parameter is non-null. The
indices may be one of
Function: mouseMove
Handles the event by updating the preview.
Function: mouseUp
Handles the event to applying the previewed changes on the edge by
using
Function: moveLabel
Changes the coordinates for the label of the given edge.
Parameters:
edge -
Function: redraw
Overridden to invoke
Function: redrawHandles
Redraws the handles.
Function: refresh
Refreshes the bends of this handler.
Function: removeHint
Hooks for subclassers to hide details when the handler gets inactive.
Function: removePoint
Removes the control point at the given index from the given state.
Function: reset
Resets the state of this handler.
Function: roundLength
Hook for rounding the unscaled width or height. This uses Math.round.
Function: hideHandles
Shortcut to
Function: setPreviewColor
Sets the color of the preview to the given value.
Function: createBends
Adds custom bends for the center of each segment.
Function: updateHint
Hook for subclassers do show details while the handler is active.
Function: updatePreviewState
Overridden to perform optimization of the edge style result.
Function: validateConnection
Returns the error message or an empty string if the connection for the given source, target pair is not valid. Otherwise it returns null. This implementation uses <mxGraph.getEdgeValidationError>.
Parameters:
source -
Generated using TypeDoc
Variable: addEnabled
Specifies if adding bends by shift-click is enabled. Default is false. Note: This experimental feature is not recommended for production use.