JavaScript & React libraryAPI

Class: CosmographEventManager

Constructors

Constructor

new CosmographEventManager(_): CosmographEventManager

Parameters

ParameterType
_ICosmographInternalApi

Returns

CosmographEventManager

Methods

attachCosmosEvents()

attachCosmosEvents(config): void

Parameters

ParameterType
configCosmographConfig

Returns

void


getLabelEvents()

getLabelEvents(): object

Returns

object

NameType
onLabelClick()(e, label) => void
onHoveredLabelClick()(e) => void

onClick()

onClick(…args): void

Parameters

ParameterType
args[number, [number, number], MouseEvent]

Returns

void


onLabelClick()

onLabelClick(e, label): Promise<void>

Parameters

ParameterType
eMouseEvent
labelLabelOptions

Returns

Promise<void>


onHoveredLabelClick()

onHoveredLabelClick(e): Promise<void>

Parameters

ParameterType
eMouseEvent

Returns

Promise<void>


onRectSelect()

onRectSelect(selection, addToSelection, unselect): void

Parameters

ParameterTypeDefault value
selectionnull | [[number, number], [number, number]]undefined
addToSelectionbooleanfalse
unselectbooleantrue

Returns

void


onPolygonSelect()

onPolygonSelect(polygonPoints, addToSelection, unselect): void

Parameters

ParameterTypeDefault value
polygonPoints[number, number][]undefined
addToSelectionbooleanfalse
unselectbooleantrue

Returns

void


onPointMouseOver()

onPointMouseOver(…args): void

Parameters

ParameterType
args[number, [number, number], any]

Returns

void


onPointMouseOut()

onPointMouseOut(…args): void

Parameters

ParameterType
args[any]

Returns

void


onMouseMove()

onMouseMove(…args): void

Parameters

ParameterType
args[number, [number, number], MouseEvent]

Returns

void


onZoomStart()

onZoomStart(…args): void

Parameters

ParameterType
args[D3ZoomEvent<HTMLCanvasElement, undefined>, boolean]

Returns

void


onDrag()

onDrag(…args): void

Parameters

ParameterType
args[D3DragEvent<HTMLCanvasElement, undefined, Hovered>]

Returns

void


onDragEnd()

onDragEnd(…args): void

Parameters

ParameterType
args[D3DragEvent<HTMLCanvasElement, undefined, Hovered>]

Returns

void


onZoom()

onZoom(…args): Promise<void>

Parameters

ParameterType
args[D3ZoomEvent<HTMLCanvasElement, undefined>, boolean]

Returns

Promise<void>


onZoomEnd()

onZoomEnd(…args): void

Parameters

ParameterType
args[D3ZoomEvent<HTMLCanvasElement, undefined>, boolean]

Returns

void


onSimulationStart()

onSimulationStart(…args): void

Parameters

ParameterType
args[]

Returns

void


onSimulationTick()

onSimulationTick(…args): void

Parameters

ParameterType
args[number, number, [number, number]]

Returns

void


onSimulationEnd()

onSimulationEnd(…args): void

Parameters

ParameterType
args[]

Returns

void


onSimulationPause()

onSimulationPause(…args): void

Parameters

ParameterType
args[]

Returns

void


onSimulationRestart()

onSimulationRestart(…args): void

Parameters

ParameterType
args[]

Returns

void