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:

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

Event: InternalEvent.MARK

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

Hierarchy (View Summary)

EventSource
- CellMarker
  - CellTracker

Constructors

constructor

new CellMarker(
    graph: AbstractGraph,
    validColor?: string,
    invalidColor?: string,
    hotspot?: number,
): CellMarker
Constructs a new cell marker.
Parameters
- graph: AbstractGraph
  Reference to the enclosing AbstractGraph.
- validColor: string = DEFAULT_VALID_COLOR
  Optional marker color for valid states. Default is DEFAULT_VALID_COLOR.
- invalidColor: string = DEFAULT_INVALID_COLOR
  Optional marker color for invalid states. Default is DEFAULT_INVALID_COLOR.
- hotspot: number = DEFAULT_HOTSPOT
  Portion of the width and height where a state intersects a given coordinate pair. A value of 0 means always highlight. Default is DEFAULT_HOTSPOT.
Returns CellMarker
Overrides EventSource.constructor
- Defined in view/cell/CellMarker.ts:121

Properties

currentColor

currentColor: string = NONE

Holds the current marker color.

enabled

enabled: boolean = true

Specifies if the marker is enabled.

Default

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: AbstractGraph

Reference to the enclosing AbstractGraph.

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

DEFAULT_HOTSPOT

hotspotEnabled

hotspotEnabled: boolean = false

Specifies if the hotspot is enabled.

Default

false

invalidColor

invalidColor: string

Holds the invalid marker color.

markedState

markedState: null | CellState = null

Holds the marked CellState.

validColor

validColor: string

Holds the valid marker color.

validState

validState: null | CellState = null

Holds the marked CellState if it is valid.

Methods

addListener

addListener(name: string, funct: Function): 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
Inherited from EventSource.addListener
- Defined in view/event/EventSource.ts:103

destroy

destroy(): void
Destroys the handler and all its resources and DOM nodes.

Returns void
- Defined in view/cell/CellMarker.ts:359

fireEvent

fireEvent(evt: EventObject, sender?: null | EventTarget): 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
Inherited from EventSource.fireEvent
- Defined in view/event/EventSource.ts:137

getCell

getCell(me: InternalMouseEvent): null | Cell
Returns the Cell for the given event and cell. This implementation returns the given cell.
Parameters
- me: InternalMouseEvent
Returns null | Cell
- Defined in view/cell/CellMarker.ts:322

getEventSource

getEventSource(): null | EventTarget
Returns .

Returns null | EventTarget
Inherited from EventSource.getEventSource
- Defined in view/event/EventSource.ts:86

getHotspot

getHotspot(): number
Returns the hotspot.

Returns number
- Defined in view/cell/CellMarker.ts:164

getMarkedState

getMarkedState(): null | CellState
Returns the markedState.

Returns null | CellState
- Defined in view/cell/CellMarker.ts:199

getMarkerColor

getMarkerColor(evt: Event, state: null | CellState, isValid: boolean): string
Returns the validColor or invalidColor depending on the value of isValid. The given CellState is ignored by this implementation.
Parameters
- evt: Event
- state: null | CellState
- isValid: boolean
Returns string
- Defined in view/cell/CellMarker.ts:300

getState

getState(me: InternalMouseEvent): null | CellState
Uses getCell, getStateToMark and intersects to return the CellState for the given MouseEvent.
Parameters
- me: InternalMouseEvent
Returns null | CellState
- Defined in view/cell/CellMarker.ts:307

getStateToMark

getStateToMark(state: null | CellState): null | CellState
Returns the CellState to be marked for the given CellState under the mouse. This implementation returns the given state.
Parameters
- state: null | CellState
Returns null | CellState
- Defined in view/cell/CellMarker.ts:330

getValidState

getValidState(): null | CellState
Returns the validState.

Returns null | CellState
- Defined in view/cell/CellMarker.ts:192

hasValidState

hasValidState(): boolean
Returns true if validState is not null.

Returns boolean
- Defined in view/cell/CellMarker.ts:185

intersects

intersects(state: CellState, me: InternalMouseEvent): boolean
Returns true if the given coordinate pair intersects the given state. This returns true if the hotspot is 0 or the coordinates are inside the hotspot for the given cell state.
Parameters
- state: CellState
- me: InternalMouseEvent
Returns boolean
- Defined in view/cell/CellMarker.ts:338

isEnabled

isEnabled(): boolean
Returns true if events are handled. This implementation returns enabled.

Returns boolean
- Defined in view/cell/CellMarker.ts:150

isEventsEnabled

isEventsEnabled(): boolean
Returns .

Returns boolean
Inherited from EventSource.isEventsEnabled
- Defined in view/event/EventSource.ts:72

isHotspotEnabled

isHotspotEnabled(): boolean
Returns true if hotspot is used in .

Returns boolean
- Defined in view/cell/CellMarker.ts:178

isValidState

isValidState(state: CellState): boolean
Returns true if the given CellState is a valid state. If this returns true, then the state is stored in validState. The return value of this method is used as the argument for getMarkerColor.
Parameters
- state: CellState
Returns boolean
- Defined in view/cell/CellMarker.ts:292

mark

mark(): void
Marks the markedState and fires a InternalEvent.MARK event.

Returns void
- Defined in view/cell/CellMarker.ts:274

markCell

markCell(cell: Cell, color: string): void
Marks the given cell using the given color, or validColor if no color is specified.
Parameters
- cell: Cell
- color: string
Returns void
- Defined in view/cell/CellMarker.ts:261

process

process(me: InternalMouseEvent): null | CellState
Processes the given event and cell and marks the state returned by getState with the color returned by getMarkerColor. If the markerColor is not null, then the state is stored in markedState. If isValidState returns true, then the state is stored in validState regardless of the marker color. The state is returned regardless of the marker color and valid state.
Parameters
- me: InternalMouseEvent
Returns null | CellState
- Defined in view/cell/CellMarker.ts:221

removeListener

removeListener(funct: Function): void
Removes all occurrences of the given listener from .
Parameters
- funct: Function
Returns void
Inherited from EventSource.removeListener
- Defined in view/event/EventSource.ts:110

reset

reset(): void
Resets the state of the cell marker.

Returns void
- Defined in view/cell/CellMarker.ts:206

setCurrentState

setCurrentState(
    state: null | CellState,
    me: InternalMouseEvent,
    color?: string,
): void
Sets and marks the current valid state.
Parameters
- state: null | CellState
- me: InternalMouseEvent
- Optionalcolor: string
Returns void
- Defined in view/cell/CellMarker.ts:235

setEnabled

setEnabled(enabled: boolean): void
Enables or disables event handling. This implementation updates enabled.
Parameters
- enabled: boolean
  Boolean that specifies the new enabled state.
Returns void
- Defined in view/cell/CellMarker.ts:142

setEventsEnabled

setEventsEnabled(value: boolean): void
Sets .
Parameters
- value: boolean
Returns void
Inherited from EventSource.setEventsEnabled
- Defined in view/event/EventSource.ts:79

setEventSource

setEventSource(value: null | EventTarget): void
Sets .
Parameters
- value: null | EventTarget
Returns void
Inherited from EventSource.setEventSource
- Defined in view/event/EventSource.ts:93

setHotspot

setHotspot(hotspot: number): void
Sets the hotspot.
Parameters
- hotspot: number
Returns void
- Defined in view/cell/CellMarker.ts:157

setHotspotEnabled

setHotspotEnabled(enabled: boolean): void
Specifies whether the hotspot should be used in .
Parameters
- enabled: boolean
Returns void
- Defined in view/cell/CellMarker.ts:171

unmark

unmark(): void
Hides the marker and fires a InternalEvent.MARK event.

Returns void
- Defined in view/cell/CellMarker.ts:283

Class CellMarker

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CellMarker

Properties

currentColor

enabled

Default

eventListeners

eventsEnabled

eventSource

graph

highlight

hotspot

Default

hotspotEnabled

Default

invalidColor

markedState

validColor

validState

Methods

addListener

Parameters

Returns void

destroy

Returns void

fireEvent

Parameters

Returns void

getCell

Parameters

Returns null | Cell

getEventSource

Returns null | EventTarget

getHotspot

Returns number

getMarkedState

Returns null | CellState

getMarkerColor

Parameters

Returns string

getState

Parameters

Returns null | CellState

getStateToMark

Parameters

Returns null | CellState

getValidState

Returns null | CellState

hasValidState

Returns boolean

intersects

Parameters

Returns boolean

isEnabled

Returns boolean

isEventsEnabled

Returns boolean

isHotspotEnabled

Returns boolean

isValidState

Parameters

Returns boolean

mark

Returns void

markCell

Parameters

Returns void

process

Parameters

Returns null | CellState

removeListener

Parameters