mxCellHighlight

A helper class to highlight cells. Here is an example for a given cell.

var highlight = new mxCellHighlight(graph, '#ff0000', 2);
highlight.highlight(graph.view.getState(cell)));

Summary

mxCellHighlight	A helper class to highlight cells.
Functions
mxCellHighlight	Constructs a cell highlight.
Variables
keepOnTop	Specifies if the highlights should appear on top of everything else in the overlay pane.
graph	Reference to the enclosing mxGraph.
state	Reference to the mxCellState.
spacing	Specifies the spacing between the highlight for vertices and the vertex.
resetHandler	Holds the handler that automatically invokes reset if the highlight should be hidden.
Functions
setHighlightColor	Sets the color of the rectangle used to highlight drop targets.
drawHighlight	Creates and returns the highlight shape for the given state.
createShape	Creates and returns the highlight shape for the given state.
getStrokeWidth	Returns the stroke width.
repaint	Updates the highlight after a change of the model or view.
hide	Resets the state of the cell marker.
mark	Marks the <markedState> and fires a mark event.
isHighlightAt	Returns true if this highlight is at the given position.
destroy	Destroys the handler and all its resources and DOM nodes.

Functions

mxCellHighlight

function mxCellHighlight( graph,
highlightColor,
strokeWidth,
dashed )

Constructs a cell highlight.

Variables

keepOnTop

mxCellHighlight.prototype.keepOnTop

Specifies if the highlights should appear on top of everything else in the overlay pane. Default is false.

graph

mxCellHighlight.prototype.graph

Reference to the enclosing mxGraph.

state

mxCellHighlight.prototype.state

Reference to the mxCellState.

spacing

mxCellHighlight.prototype.spacing

Specifies the spacing between the highlight for vertices and the vertex. Default is 2.

resetHandler

mxCellHighlight.prototype.resetHandler

Holds the handler that automatically invokes reset if the highlight should be hidden.

Functions

setHighlightColor

mxCellHighlight.prototype.setHighlightColor = function( color )

Sets the color of the rectangle used to highlight drop targets.

Parameters

color

String that represents the new highlight color.

drawHighlight

mxCellHighlight.prototype.drawHighlight = function()

Creates and returns the highlight shape for the given state.

createShape

mxCellHighlight.prototype.createShape = function()

Creates and returns the highlight shape for the given state.

getStrokeWidth

mxCellHighlight.prototype.getStrokeWidth = function( state )

Returns the stroke width.

repaint

mxCellHighlight.prototype.repaint = function()

Updates the highlight after a change of the model or view.

hide

mxCellHighlight.prototype.hide = function()

Resets the state of the cell marker.

mark

Marks the <markedState> and fires a mark event.

isHighlightAt

mxCellHighlight.prototype.isHighlightAt = function( x,
y )

Returns true if this highlight is at the given position.

destroy

mxCellHighlight.prototype.destroy = function()

Destroys the handler and all its resources and DOM nodes.