Events

Complete list

• typeLoadChange

  Every change of the chart type's load state: loading, ready, or why the type cannot be drawn .

• rendered

  Emits rendering results in detail when chart drawing completes.

• appended

  CustomEvent.detail type: ChartAppendedEventDetail. Event names are case-sensitive.

• windowSlid

  CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.

• chartAnimationStart

  CustomEvent.detail type: void. Event names are case-sensitive.

• chartAnimationEnd

  CustomEvent.detail type: void. Event names are case-sensitive.

• chartAnimationInterrupted

  CustomEvent.detail type: void. Event names are case-sensitive.

• pointHover

  CustomEvent.detail type: ChartPointEventDetail | null. Event names are case-sensitive.

• dependencyClick

  CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive.

• taskEditStart

  CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.

• taskEditMove

  CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.

• taskEditEnd

  CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.

• taskEditCancel

  CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.

• dependencyHover

  CustomEvent.detail type: GanttDependencyHitDetail|null. Event names are case-sensitive.

• dependencySelectionChange

  CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive.

• pointClick

  A point selection event. Read the selected data and index from CustomEvent.detail.

• pointContextMenu

  CustomEvent.detail type: ChartPointContextMenuEventDetail. Event names are case-sensitive.

• pointChange

  CustomEvent.detail type: RadarChartPointerEventDetail. Event names are case-sensitive.

• pointDragStart

  Network Graph — a node drag begins (after the 3 px threshold), moves and ends; by tells a pointer drag from a keyboard nudge.

• pointDragMove

  CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive.

• pointDragEnd

  CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive.

• seriesClick

  CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive.

• seriesOutsideClick

  CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive.

• legendItemClick

  CustomEvent.detail type: ChartLegendItemEventDetail. Event names are case-sensitive.

• seriesToggled

  CustomEvent.detail type: ChartSeriesToggledEventDetail. Event names are case-sensitive.

• crosshairMove

  CustomEvent.detail type: CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail. Event names are case-sensitive.

• tooltipShow

  Whether to display the built-in tooltip.

• tooltipHide

  CustomEvent.detail type: void. Event names are case-sensitive.

• zoomChange

  re-emitted from the active cartesian family after every zoom change.

• mapViewChange

  Geographic camera after a completed globe drag or map-view reset.

• mapLayerChange

  CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive.

• featureClick

  CustomEvent.detail type: GeoMapFeatureHitDetail. Event names are case-sensitive.

• featureHover

  CustomEvent.detail type: GeoMapFeatureHitDetail | null. Event names are case-sensitive.

• featureSelectionChange

  CustomEvent.detail type: GeoMapFeatureSelectionChangeEventDetail. Event names are case-sensitive.

• axisBrushChange

  CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive.

• axisBrushStart

  CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.

• axisBrushMove

  CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.

• axisBrushEnd

  CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.

• brushChange

  CustomEvent.detail type: CartesianBrushChangeEventDetail. Event names are case-sensitive.

• actionDispatched

  every dispatchAction call, after it ran (handled false for an unknown type).

• renderProgress

  re-emitted from the scatter family: a progressively painted chunk landed (done on the last).

• brushStart

  CustomEvent.detail type: CartesianBrushStartEventDetail. Event names are case-sensitive.

• brushMove

  CustomEvent.detail type: CartesianBrushMoveEventDetail. Event names are case-sensitive.

• brushEnd

  CustomEvent.detail type: CartesianBrushEndEventDetail. Event names are case-sensitive.

• drawingsChange

  the drawing document of the active cartesian family changed.

• drawingSelectionChange

  the drawing selection of the active cartesian family changed.

• tooltipAction

  CustomEvent.detail type: ChartTooltipActionEventDetail. Event names are case-sensitive.

• sliceClick

  CustomEvent.detail type: PieChartSliceEventDetail. Event names are case-sensitive.

• sliceHover

  CustomEvent.detail type: PieChartSliceEventDetail | null. Event names are case-sensitive.

• sliceSelected

  CustomEvent.detail type: PieChartSelectedEventDetail. Event names are case-sensitive.

• sliceToggled

  CustomEvent.detail type: { index: number; sliceId: string; disabled: boolean }. Event names are case-sensitive.

• selectionChanged

  CustomEvent.detail type: SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail. Event names are case-sensitive.

• drillChange

  Treemap branch navigation through pointer, keyboard, methods or data reconciliation.

• gaugeClick

  CustomEvent.detail type: GaugeChartPointerEventDetail. Event names are case-sensitive.

• gaugeHover

  CustomEvent.detail type: GaugeChartPointerEventDetail | null. Event names are case-sensitive.

• valueChange

  CustomEvent.detail type: { value: number; fraction: number }. Event names are case-sensitive.

• needleToggled

  CustomEvent.detail type: { index: number; needleId: string; disabled: boolean }. Event names are case-sensitive.

• sectionClick

  CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive.

• sectionHover

  CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive.

• sectionToggled

  CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive.

• cameraChange

  CustomEvent.detail type: Surface3DCameraChangeEventDetail. Event names are case-sensitive.

• dataValidationError

  CustomEvent.detail type: ChartDataValidationErrorDetail. Event names are case-sensitive.

• contextMenuOpened

  CustomEvent.detail type: ChartContextMenuEventDetail. Event names are case-sensitive.

• contextMenuClosed

  CustomEvent.detail type: void. Event names are case-sensitive.

• contextMenuItemSelect

  CustomEvent.detail type: ChartContextMenuItemEventDetail. Event names are case-sensitive.

• exported

  CustomEvent.detail type: { format: 'png' | 'svg' | 'csv' | 'json'; filename: string }. Event names are case-sensitive.

• dataTableToggled

  CustomEvent.detail type: { open: boolean }. Event names are case-sensitive.