StockChartComponent

Represents the Kendo UI for Angular StockChart component.

The StockChart displays financial data with a navigator for date range selection. It combines a main chart with a smaller navigator chart for easy data exploration.

ts

import { Component } from '@angular/core';

@Component({
  selector: 'my-app',
  template: `
      <kendo-stockchart>
          <kendo-chart-series>
              <kendo-chart-series-item type="line" [data]="data" field="value" categoryField="date">
              </kendo-chart-series-item>
          </kendo-chart-series>
          <kendo-chart-navigator>
              <kendo-chart-navigator-select to="2017/02/01">
              </kendo-chart-navigator-select>
              <kendo-chart-navigator-series>
                  <kendo-chart-navigator-series-item type="area" [data]="data" field="value" categoryField="date">
                  </kendo-chart-navigator-series-item>
              </kendo-chart-navigator-series>
          </kendo-chart-navigator>
      </kendo-stockchart>
  `,
})
export class AppComponent {
}

Selector

kendo-stockchart

Export Name

Accessible in templates as #kendoStockChartInstance="kendoStockChart"

Inputs

Name	Type	Default	Description
axisDefaults	AxisDefaults		Defines the default configuration for all axes.
categoryAxis	CategoryAxis | CategoryAxis[]		Defines the category axis configuration.
chartArea	ChartArea		Defines the Chart area configuration.
legend	Legend		Defines the Chart legend configuration.
navigator	Navigator		Specifies the configuration options for the data navigator. The navigator provides a way to select and filter data ranges.
noData	boolean	true	Defines whether to show the no-data template when the Chart has no data.
paneDefaults	PaneDefaults		Defines the default configuration for all panes.
panes	Pane[]		Defines the Chart panes configuration.
plotArea	PlotArea		Defines the plot area configuration.
popupSettings	PopupSettings		Defines the settings for the tooltip popup.
renderAs	"canvas" | "svg"	'svg'	Defines the rendering mode of the Chart.
resizeRateLimit	number	10	Limits the automatic resizing of the Chart. Sets the maximum number of times per second that the component redraws its content when the size of its container changes. To disable the automatic resizing, set it to 0.
series	Series[]		Defines the Chart series configuration.
seriesColors	string[]		Defines the default colors for the Chart series.
seriesDefaults	SeriesDefaults		Defines the default configuration for all series.
subtitle	string | Subtitle		Defines the subtitle configuration of the Chart.
title	string | Title		Defines the title configuration of the Chart.
tooltip	Tooltip		Defines the Chart tooltip configuration.
transitions	boolean	true	Defines whether the Chart plays animations when it displays the series. By default, animations are enabled.
valueAxis	ValueAxis | ValueAxis[]		Defines the value axis configuration.
xAxis	XAxis | XAxis[]		Defines the X axis configuration.
yAxis	YAxis | YAxis[]		Defines the Y axis configuration.

Fields

Name	Type	Default	Description
surface	Surface		Represents the Drawing Surface of the Chart.

Events

Name	Type	Description
axisLabelClick	EventEmitter<AxisLabelClickEvent>	Fires when you click an axis label (see example).
drag	EventEmitter<DragEvent>	Fires as long as you drag the Chart with the mouse or through swipe gestures.
dragEnd	EventEmitter<DragEndEvent>	Fires when you stop dragging the Chart.
dragStart	EventEmitter<DragStartEvent>	Fires when you start dragging the Chart.
legendItemClick	EventEmitter<LegendItemClickEvent>	Fires when a legend item is clicked before the selected series visibility is toggled. You can prevent this event.
legendItemHover	EventEmitter<LegendItemHoverEvent>	Fires when you hover over a legend item (see example).
legendItemLeave	EventEmitter<LegendItemLeaveEvent>	Fires when the cursor leaves a legend item.
navigatorFilter	EventEmitter<NavigatorFilterEvent>	Fires when the navigator range is changed. Use this event to respond to user interactions with the navigator.
noteClick	EventEmitter<NoteClickEvent>	Fires when you click a note.
noteHover	EventEmitter<NoteHoverEvent>	Fires when you hover over a note.
noteLeave	EventEmitter<NoteLeaveEvent>	Fires when the cursor leaves a note.
paneRender	EventEmitter<PaneRenderEvent>	Fires when a pane is rendered because the Chart is rendered, performs panning or zooming, or is exported with different options. The event is used to render custom visuals in the panes.
plotAreaClick	EventEmitter<PlotAreaClickEvent>	Fires when you click the plot area (see example). The click event is triggered by the tap and contextmenu events. To distinguish between the original events, inspect the e.originalEvent.type field.
plotAreaHover	EventEmitter<PlotAreaHoverEvent>	Fires when you hover the plot area (see example).
plotAreaLeave	EventEmitter<PlotAreaLeaveEvent>	Fires when the cursor leaves the plot area.
render	EventEmitter<RenderEvent>	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.
select	EventEmitter<SelectEvent>	Fires when you modify the selection. The range units include a generic axis category index (0-based) and a date axis represented by a date instance.
selectEnd	EventEmitter<SelectEndEvent>	Fires when you complete the modification of the selection. The range units include a generic axis category index (0-based) and a date axis represented by a date instance.
selectStart	EventEmitter<SelectStartEvent>	Fires when you start modifying the axis selection. The range units include a generic axis category index (0-based) and a date axis represented by a date instance.
seriesClick	EventEmitter<SeriesClickEvent>	Fires when you click the Chart series. The click event will be triggered by the tap and contextmenu events (see example). To distinguish between the original events, inspect the e.originalEvent.type field.
seriesHover	EventEmitter<SeriesHoverEvent>	Fires when you hover the Chart series (see example).
seriesLeave	EventEmitter<SeriesLeaveEvent>	Fires when the cursor leaves a series.
seriesOver	EventEmitter<SeriesOverEvent>	Fires when the cursor enters a series.
zoom	EventEmitter<ZoomEvent>	Fires as long as you zoom the Chart by using the mousewheel operation.
zoomEnd	EventEmitter<ZoomEndEvent>	Fires when you stop zooming the Chart.
zoomStart	EventEmitter<ZoomStartEvent>	Fires when you use the mousewheel to zoom the Chart.

Methods

exportImage
Exports the Chart as an image. The export operation is asynchronous and returns a promise.
Parameters options ImageExportOptions The parameters for the exported image.
Returns Promise<string> A promise that resolves with a PNG image encoded as a Data URI.

exportSVG
Exports the Chart as an SVG document. The export operation is asynchronous and returns a promise.
Parameters options ChartSVGExportOptions The parameters for the exported file.
Returns Promise<string> A promise that resolves with an SVG document encoded as a Data URI.

exportVisual
Exports the Chart as a Drawing Scene.
Parameters options any The parameters for the export operation.
Returns Group The root Group of the scene.

findAxisByName
Returns the axis with the specified name.
Parameters name string The axis name.
Returns ChartAxis The axis with a corresponding name.

findPaneByIndex
Returns the pane at the specified index.
Parameters index number The pane index.
Returns ChartPane The pane at the specified index.

findPaneByName
Returns the pane with the specified name.
Parameters name string The name of the pane.
Returns ChartPane The pane with the provided name.

getPlotArea
Returns the plot area of the Chart.
Returns ChartPlotArea The plot area of the Chart.

hideTooltip
Hides the tooltip of the Chart.

notifyChanges
Updates the component fields with the specified values and refreshes the Chart. Use this method when the configuration values cannot be set through the template. ts chart.notifyChanges({ title: { text: 'New Title' } });
Parameters changes any An object containing the updated input fields.

reloadTheme
Reloads the Chart appearance settings from the current Kendo UI Theme. Call this method after loading a different theme stylesheet.

resize
Detects the size of the container and redraws the Chart. Resizing is automatic unless you set the resizeRateLimit option to 0.

showTooltip
Shows the Chart tooltip of a specific point or the shared tooltip of a specific category.
Parameters filter string | number | Date | (point: SeriesPoint) => boolean The category for a shared tooltip or a function which will be called for each point until the function returns true.

skipNavigatorRedraw
Prevents the navigator pane from redrawing when the StockChart options are updated. Use this method when you need to update only the main series data for the selected period. Call this method before updating the Chart options to improve performance.

toggleHighlight
Highlights the series points or the segments of a Pie, Donut, Funnel, or Pyramid Charts. See Series Highlight for more details (with an example).
Parameters show boolean A Boolean value that indicates whether the highlight is shown or hidden. filter string | { category: string; series: string; } | (point: SeriesPoint) => boolean A string that represents the series or category name, an object with the series and category name, or a function which will be called for each point. The function should return true for the points for which the highlight is toggled.