Class CellHighlight

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)));

Constructors

constructor

Properties

dashed graph highlightColor keepOnTop opacity repaintHandler resetHandler shape spacing state strokeWidth

Methods

createShape destroy drawHighlight getStrokeWidth hide highlight isHighlightAt repaint setHighlightColor

Constructors

constructor

Properties

dashed

dashed: boolean = false

graph

graph: Graph

Reference to the enclosing graph.

Default

true

highlightColor

highlightColor: string

keepOnTop

keepOnTop: boolean = false

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

Default

false

opacity

opacity: number = 100

repaintHandler

repaintHandler: Function

resetHandler

resetHandler: Function

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

Default

null

shape

shape: null | Shape = null

spacing

spacing: number = 2

Specifies the spacing between the highlight for vertices and the vertex.

Default

2

state

state: null | CellState = null

Reference to the CellState.

Default

null

strokeWidth

strokeWidth: number = 0

Methods

createShape

destroy

drawHighlight

getStrokeWidth

hide

highlight

isHighlightAt

  • isHighlightAt(x, y): boolean

  • Returns true if this highlight is at the given position.

    Parameters

    • x: number
    • y: number

    Returns boolean

repaint

setHighlightColor

  • setHighlightColor(color): void

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

    Parameters

    • color: string

      String that represents the new highlight color.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods