StockChartProps

Premium

Represents the props of the KendoReact StockChart component.

Name	Type	Default	Description
axisDefaults?	AxisDefaults		This option allows to override the default axis options.
className?	string		Sets additional CSS classes to the component.
dir?	string		Represents the dir HTML attribute.
onAxisLabelClick?	(event: AxisLabelClickEvent) => void		Fires when the user clicks an axis label.
onDrag?	(event: DragEvent) => void		Fires as long as the user is dragging the Chart with the mouse or through swipe gestures.
onDragEnd?	(event: DragEndEvent) => void		Fires when the user stops dragging the Chart.
onDragStart?	(event: DragStartEvent) => void		Fires when the user starts dragging the Chart.
onLegendItemClick?	(event: LegendItemClickEvent) => void		Fires when the user clicks a legend item (see example).
onLegendItemHover?	(event: LegendItemHoverEvent) => void		Fires when the user hovers over a legend item.
onNavigatorFilter?	(event: NavigatorFilterEvent) => void		Fires when the navigator range is changed.
onNoteClick?	(event: NoteClickEvent) => void		Fires when the user clicks a note.
onNoteHover?	(event: NoteHoverEvent) => void		Fires when the user hovers over a note.
onPlotAreaClick?	(event: PlotAreaClickEvent) => void		Fires when the user clicks the plot area. The click event is triggered by the tap and contextmenu events. To distinguish between the original events, inspect the e.originalEvent.type field.
onPlotAreaHover?	(event: PlotAreaHoverEvent) => void		Fires when the user hovers the plot area (see example).
onRefresh?	(chartOptions: any, themeOptions: any, chartInstance: any) => void		Fires when the Chart is about to refresh. The event can be used to prevent the refresh of the Chart in specific cases (see example.
onRender?	(event: RenderEvent) => void		Fires when the Chart is ready to render on screen (see example). For example, you can use it to remove loading indicators. Any changes made to the options are ignored.
onSelect?	(event: SelectEvent) => void		Fires when the user modifies the selection. The range units are: Generic axis—Category index (0-based). Date axis—Date instance.
onSelectEnd?	(event: SelectEndEvent) => void		Fires when the user completes the modification of the selection (see example). The range units are: Generic axis—Category index (0-based). Date axis—Date instance.
onSelectStart?	(event: SelectStartEvent) => void		Fires when the user starts modifying the axis selection. The range units are: Generic axis—Category index (0-based). Date axis—Date instance.
onSeriesClick?	(event: SeriesClickEvent) => void		Fires when the user clicks the Chart series. The click event will be triggered by the tap and contextmenu events. To distinguish between the original events, inspect the e.originalEvent.type field.
onSeriesHover?	(event: SeriesHoverEvent) => void		Fires when the user hovers over the Chart series.
onZoom?	(event: ZoomEvent) => void		Fires as long as the user is zooming the Chart by using the mousewheel operation.
onZoomEnd?	(event: ZoomEndEvent) => void		Fires when the user stops zooming the Chart.
onZoomStart?	(event: ZoomStartEvent) => void		Fires when the user uses the mousewheel to zoom the Chart.
paneDefaults?	PaneDefaults		This option allows to override the default pane options.
panes?	Pane[]		The chart panes configuration.
pannable?	boolean | DragAction		Specifies if the Chart can be panned (see example).
partialRedraw?	boolean		Specifies whether the StockChart will perform full or partial redraw upon re-render. The partial redraw is required when the onNavigatorFilter event is handled and the data for the main panes is limited to a specific set. The default value is false.
renderAs?	"canvas" | "svg"		Sets the preferred rendering engine (see example). If not supported by the browser, the Chart switches to the first available mode. The supported values are: "svg"—If available, renders the component as an inline .svg file. "canvas"—If available, renders the component as a canvas element.
seriesColors?	string[]		The default colors for the Chart series. When all colors are used, new colors are pulled from the start again.
seriesDefaults?	SeriesDefaults		This option allows to override the default series options.
style?	React.CSSProperties		The styles that are applied to the component.
transitions?	boolean		If set to true, the Chart plays animations when it displays the series. By default, animations are enabled.
zoomable?	boolean | Zoomable		Specifies if the Chart can be zoomed (see example). Currently is only applicable to linear types, where the range on the X axis can be changed based on the zoom level.