Class CellMarker

A helper class to process mouse locations and highlight cells.

Helper class to highlight cells. To add a cell marker to an existing graph for highlighting all cells, the following code is used:

let marker = new mxCellMarker(graph);
graph.addMouseListener({
  mouseDown: ()=> {},
  mouseMove: (sender, me)=>
  {
    marker.process(me);
  },
  mouseUp: ()=> {}
});

Event: mxEvent.MARK

Fires after a cell has been marked or unmarked. The state property contains the marked or null if no state is marked.

Constructor: mxCellMarker

Constructs a new cell marker.

Param: graph

Reference to the enclosing Graph.

Param: validColor

Optional marker color for valid states. Default is Constants#DEFAULT_VALID_COLOR.

Param: invalidColor

Optional marker color for invalid states. Default is Constants#DEFAULT_INVALID_COLOR.

Param: hotspot

Portion of the width and hight where a state intersects a given coordinate pair. A value of 0 means always highlight. Default is Constants#DEFAULT_HOTSPOT.

Hierarchy (view full)

Constructors

constructor

Properties

currentColor enabled eventListeners eventsEnabled eventSource graph highlight hotspot hotspotEnabled invalidColor markedState validColor validState

Methods

addListener destroy fireEvent getCell getEventSource getHotspot getMarkedState getMarkerColor getState getStateToMark getValidState hasValidState intersects isEnabled isEventsEnabled isHotspotEnabled isValidState mark markCell process removeListener reset setCurrentState setEnabled setEventsEnabled setEventSource setHotspot setHotspotEnabled unmark

Constructors

constructor

Properties

currentColor

currentColor: string = NONE

Holds the current marker color.

enabled

enabled: boolean = true

Specifies if the marker is enabled. Default is true.

eventListeners

eventListeners: EventListenerObject[] = []

Holds the event names and associated listeners in an array. The array contains the event name followed by the respective listener for each registered listener.

eventsEnabled

eventsEnabled: boolean = true

Specifies if events can be fired. Default is true.

eventSource

eventSource: null | EventTarget = null

Optional source for events. Default is null.

graph

graph: Graph

Reference to the enclosing Graph.

highlight

highlight: CellHighlight

hotspot

hotspot: number = DEFAULT_HOTSPOT

Specifies the portion of the width and height that should trigger a highlight. The area around the center of the cell to be marked is used as the hotspot. Possible values are between 0 and 1. Default is mxConstants.DEFAULT_HOTSPOT.

hotspotEnabled

hotspotEnabled: boolean = false

Specifies if the hotspot is enabled. Default is false.

invalidColor

invalidColor: string

Holds the invalid marker color.

markedState

markedState: null | CellState = null

Holds the marked .

validColor

validColor: string

Holds the valid marker color.

validState

validState: null | CellState = null

Holds the marked if it is valid.

Methods

addListener

  • addListener(name, funct): void

  • Binds the specified function to the given event name. If no event name is given, then the listener is registered for all events.

    The parameters of the listener are the sender and an EventObject.

    Parameters

    • name: string
    • funct: Function

    Returns void

destroy

fireEvent

  • fireEvent(evt, sender?): void

  • Dispatches the given event to the listeners which are registered for the event. The sender argument is optional. The current execution scope ("this") is used for the listener invocation (see Utils#bind).

    Example:

    fireEvent(new mxEventObject("eventName", key1, val1, .., keyN, valN))

    Parameters

    • evt: EventObject

      EventObject that represents the event.

    • sender: null | EventTarget = null

      Optional sender to be passed to the listener. Default value is the return value of .

    Returns void

getCell

getEventSource

getHotspot

getMarkedState

getMarkerColor

  • getMarkerColor(evt, state, isValid): string

  • Returns the valid- or invalidColor depending on the value of isValid. The given is ignored by this implementation.

    Parameters

    • evt: Event
    • state: null | CellState
    • isValid: boolean

    Returns string

getState

getStateToMark

getValidState

hasValidState

intersects

  • intersects(state, me): boolean

  • Returns true if the given coordinate pair intersects the given state. This returns true if the is 0 or the coordinates are inside the hotspot for the given cell state.

    Parameters

    Returns boolean

isEnabled

  • isEnabled(): boolean

  • Returns true if events are handled. This implementation returns .

    Returns boolean

isEventsEnabled

isHotspotEnabled

isValidState

  • isValidState(state): boolean

  • Returns true if the given is a valid state. If this returns true, then the state is stored in . The return value of this method is used as the argument for .

    Parameters

    Returns boolean

mark

markCell

  • markCell(cell, color): void

  • Marks the given cell using the given color, or if no color is specified.

    Parameters

    • cell: Cell
    • color: string

    Returns void

process

  • process(me): null | CellState

  • Processes the given event and cell and marks the state returned by with the color returned by . If the markerColor is not null, then the state is stored in arkedState. If returns true, then the state is stored in regardless of the marker color. The state is returned regardless of the marker color and valid state.

    Parameters

    Returns null | CellState

removeListener

reset

setCurrentState

setEnabled

  • setEnabled(enabled): void

  • Enables or disables event handling. This implementation updates .

    Parameters

    • enabled: boolean

      Boolean that specifies the new enabled state.

    Returns void

setEventsEnabled

setEventSource

setHotspot

setHotspotEnabled

  • setHotspotEnabled(enabled): void

  • Specifies whether the hotspot should be used in .

    Parameters

    • enabled: boolean

    Returns void

unmark

Settings

Member Visibility

On This Page

Constructors
Properties
Methods