Interface: ChartEvents

Event payloads by name (plan §7.5).

Properties

Property	Modifier	Type	Description
afterplot	public	undefined	The pipeline finished and the frame is drawn (after every update call).
afterrender	public	FrameInfo	-
animated	public	undefined	No frame is left to play (also emitted when animate is given nothing to play).
animating	public	undefined	chart.animate started playing frames (E7.4); nothing was playing before.
animatingframe	public	AnimatingFrameEvent	A frame starts: its name (sliders move to it), the computed frame and its options.
animationinterrupted	public	undefined	Queued frames were dropped by an animate call with mode: 'next' or 'immediate'.
beforerender	public	FrameInfo	Around every rendered frame (ADR-007); the payload object is reused between frames.
click	public	PointerEventData	A click on data points (E6.4). Not emitted when nothing is under the pointer.
clickannotation	public	AnnotationEventData	A click on an annotation with captureevents (E5.4).
deselect	public	undefined	The selection was cleared (double-click or a click on empty space in select mode).
destroy	public	undefined	The chart was destroyed (chart.destroy() / purge(el)).
doubleclick	public	undefined	A double-click on the plot area (after doubleClick reset/autosize ran).
hover	public	PointerEventData	The pointer is over data points (E6.1); the payload lists them.
icicleclick	public	HierarchyClickEventData	A click on an icicle cell or path bar segment (E13.4; Plotly's plotly_icicleclick), ditto.
legendclick	public	LegendEventData	Legend item clicked; a listener returning false cancels the default toggle.
legenddoubleclick	public	LegendEventData	-
redraw	public	object	After extendTraces / prependTraces has been drawn (Plotly emits plotly_redraw then; it has no dedicated extend event). The payload repeats the call's arguments.
redraw.kind	readonly	"extend" | "prepend"	-
redraw.maxPoints	readonly	MaxPoints | undefined	-
redraw.traces	readonly	readonly number[]	-
redraw.update	readonly	StreamUpdate	-
relayout	public	AttributeUpdate	After a relayout: the applied layout edits (including implied autorange: false).
relayouting	public	AttributeUpdate	During a drag or scroll zoom / pan (throttled to animation frames): the axis ranges shown so far, as relayout edits ('xaxis.range[0]', …). A relayout follows when the gesture ends.
resize	public	object	The figure size changed (container resize with config.responsive, or a relayout).
resize.height	readonly	number	-
resize.width	readonly	number	-
restyle	public	object	After a restyle: the edits and the trace indices they applied to.
restyle.traces	readonly	readonly number[]	-
restyle.update	readonly	AttributeUpdate	-
selected	public	SelectionEventData	Box / lasso selection finished, or a point was click-selected (clickmode: 'select').
selecting	public	SelectionEventData	Box / lasso selection in progress (E6.3), throttled to animation frames.
sunburstclick	public	HierarchyClickEventData	A click on a sunburst sector (E13.2), emitted before click. A listener returning false cancels the drill-down and the click event (Plotly's plotly_sunburstclick); so does a click listener returning false.
transitioned	public	undefined	A transition finished and its final state is drawn.
transitioning	public	undefined	A transition (E7.3) starts: a frame, or react with layout.transition.
transitioninterrupted	public	undefined	A transition was cut short by another one (it jumps to its end state).
treemapclick	public	HierarchyClickEventData	A click on a treemap tile or path bar segment (E13.3; Plotly's plotly_treemapclick), emitted before click and cancelling like sunburstclick.
unhover	public	PointerEventData	The hovered points are gone (pointer moved away, left the chart, or chart.unhover()).
webglcontextlost	public	undefined	-
webglcontextrestored	public	undefined	-