Class CellHighlight

constructor

• new CellHighlight(
      graph: Graph,
      highlightColor?: string,
      strokeWidth?: number,
      dashed?: boolean,
  ): CellHighlight

• Parameters

  • graph: Graph
  • OptionalhighlightColor: string
  • OptionalstrokeWidth: number
  • Optionaldashed: boolean

  Returns CellHighlight

dashed

graph

true
Copy

highlightColor

keepOnTop

false
Copy

opacity

repaintHandler

resetHandler

null
Copy

shape

spacing

2
Copy

state

null
Copy

strokeWidth

createShape

• createShape(): null | Shape

• Creates and returns the highlight shape for the given state.

  Returns null | Shape

destroy

• destroy(): void

• Destroys the handler and all its resources and DOM nodes.

  Returns void

drawHighlight

• drawHighlight(): void

• Creates and returns the highlight shape for the given state.

  Returns void

getStrokeWidth

• getStrokeWidth(state?: null | CellState): number

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

  Parameters

  • state: null | CellState = null

  Returns number

hide

• hide(): void

• Resets the state of the cell marker.

  Returns void

highlight

• highlight(state?: null | CellState): void

• Marks the arkedState and fires a ark event.

  Parameters

  • state: null | CellState = null

  Returns void

isHighlightAt

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

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

  Parameters

  • x: number
  • y: number

  Returns boolean

repaint

• repaint(): void

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

  Returns 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