Options
All
  • Public
  • Public/Protected
  • All
Menu

Class mxCellHighlight

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

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

Hierarchy

  • mxCellHighlight

Index

Constructors

Properties

Methods

Constructors

constructor

  • new mxCellHighlight(graph: mxGraph, highlightColor?: string, strokeWidth?: number, dashed?: boolean): mxCellHighlight

Properties

graph

graph: boolean

Reference to the enclosing mxGraph.

default

true

keepOnTop

keepOnTop: boolean

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

default

false

resetHandler

resetHandler: any

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

default

null

spacing

spacing: number

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

default

2

state

state: mxCellState

Reference to the mxCellState.

default

null

Methods

createShape

destroy

  • destroy(): void

drawHighlight

  • drawHighlight(): void

getStrokeWidth

hide

  • hide(): void

highlight

isHighlightAt

  • isHighlightAt(x: number, y: number): boolean

repaint

  • repaint(): void

setHighlightColor

  • setHighlightColor(color: string): void

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

    Parameters

    • color: string

      String that represents the new highlight color.

    Returns void

Generated using TypeDoc