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.
hide	Resets the state of the cell marker.
mark	Marks the <markedState> and fires a mark event.
destroy	Destroys the handler and all its resources and DOM nodes.

function mxCellHighlight( graph,
highlightColor,
strokeWidth )

Constructs a cell highlight.

mxCellHighlight.prototype.keepOnTop

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

mxCellHighlight.prototype.graph

Reference to the enclosing mxGraph.

mxCellHighlight.prototype.state

Reference to the mxCellState.

mxCellHighlight.prototype.spacing

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

mxCellHighlight.prototype.resetHandler

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

mxCellHighlight.prototype.setHighlightColor = function( color )

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

color

String that represents the new highlight color.

mxCellHighlight.prototype.drawHighlight = function( state )

Creates and returns the highlight shape for the given state.

mxCellHighlight.prototype.createShape = function( state )

Creates and returns the highlight shape for the given state.

mxCellHighlight.prototype.hide = function()

Resets the state of the cell marker.

Marks the <markedState> and fires a mark event.

mxCellHighlight.prototype.destroy = function()

Destroys the handler and all its resources and DOM nodes.