StockChartComponent

23 Sep 20257 minutes to read

Stock Chart Component

<ejs-stockchart></ejs-stockchart>

Properties

annotations StockChartAnnotationSettingsModel[]

The configuration for annotation in chart.

axes StockChartAxisModel[]

Secondary axis collection for the stockChart.

background string

The background color of the stockChart that accepts value in hex and rgba as a valid CSS color string.

Defaults to null

border StockChartBorderModel

Options for customizing the color and width of the stockChart border.

chartArea StockChartAreaModel

Options for configuring the border and background of the stockChart area.

crosshair CrosshairSettingsModel

Options for customizing the crosshair of the chart.

dataSource Object|DataManager

Specifies the DataSource for the stockChart. It can be an array of JSON objects or an instance of DataManager.

<div id='financial'></div>
let dataManager: DataManager = new DataManager({
        url: 'http://mvc.syncfusion.com/Services/Northwnd.svc/Tasks/'
});
let query: Query = new Query().take(50).where('Estimate', 'greaterThan', 0, false);
let financial: stockChart = new stockChart({
...
 dataSource:dataManager,
  series: [{
       xName: 'Id',
       yName: 'Estimate',
       query: query
   }],
...
});
financial.appendTo('#financial');

Defaults to ’’

enableCustomRange boolean

Custom Range

Defaults to true

enablePeriodSelector boolean

It specifies whether the periodSelector to be rendered in financial chart

Defaults to true

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableSelector boolean

It specifies whether the range navigator to be rendered in financial chart

Defaults to true

exportType ExportType[]

It specifies the types of Export types in financial chart.

height string

The height of the stockChart as a string accepts input both as ‘100px’ or ‘100%’.
If specified as ‘100%, stockChart renders to the full height of its parent element.

Defaults to null

indicatorType TechnicalIndicators[]

It specifies the types of indicators in financial chart.

indicators StockChartIndicatorModel[]

Defines the collection of technical indicators, that are used in financial markets.

isMultiSelect boolean

If set true, enables the multi selection in chart. It requires selectionMode to be Point Series or Cluster.

Defaults to false

isSelect boolean

If set true, enables the animation in chart.

Defaults to false

isTransposed boolean

It specifies whether the stockChart should be render in transposed manner or not.

Defaults to false

legendSettings StockChartLegendSettingsModel

Options for customizing the legend of the stockChart.

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ’’

mainObject Element

Overall SVG

margin StockMarginModel

Options to customize left, right, top and bottom margins of the stockChart.

noDataTemplate string|Function

Specifies the template to be displayed when the chart has no data.
This property enables the users to display customized messages, images, or other UI elements in place of an empty chart.
It provides a better user experience by offering context when no data points are available.

Defaults to null

periods PeriodsModel[]

To configure period selector options.

primaryXAxis StockChartAxisModel

Options to configure the horizontal axis.

primaryYAxis StockChartAxisModel

Options to configure the vertical axis.

rows StockChartRowModel[]

Options to split stockChart into multiple plotting areas horizontally.
Each object in the collection represents a plotting area in the stockChart.

selectedDataIndexes StockChartIndexesModel[]

Specifies the point indexes to be selected while loading a chart.
It requires selectionMode to be Point | Series | or Cluster.

<div id='Chart'></div>
let chart: Chart = new Chart({
...
  selectionMode: 'Point',
  selectedDataIndexes: [ { series: 0, point: 1},
                         { series: 2, point: 3} ],
...
});
chart.appendTo('#Chart');

Defaults to []

selectionMode SelectionMode

Specifies whether series or data point has to be selected. They are,

  • none: Disables the selection.
  • series: selects a series.
  • point: selects a point.
  • cluster: selects a cluster of point
  • dragXY: selects points by dragging with respect to both horizontal and vertical axes
  • dragX: selects points by dragging with respect to horizontal axis.
  • dragY: selects points by dragging with respect to vertical axis.

Defaults to None

series StockSeriesModel[]

The configuration for series in the stockChart.

seriesType ChartSeriesType[]

It specifies the types of series in financial chart.

stockEvents StockEventsSettingsModel[]

The configuration for stock events in the stockChart.

stockLegendModule StockLegend

legendModule is used to manipulate and add legend to the Stockchart.

theme ChartTheme

Specifies the theme for the stockChart.

Defaults to ‘Material’

title string

Title of the chart

Defaults to ’’

titleStyle StockChartFontModel

Options for customizing the title of the Chart.

tooltip StockTooltipSettingsModel

Options for customizing the tooltip of the chart.

trendlineType TrendlineTypes[]

It specifies the types of trendline types in financial chart.

width string

The width of the stockChart as a string accepts input as both like ‘100px’ or ‘100%’.
If specified as ‘100%, stockChart renders to the full width of its parent element.

Defaults to null

zoomChange boolean

private

zoomSettings ZoomSettingsModel

Options to enable the zooming feature in the chart.

Methods

chartModuleInjection

Module Injection for components.

Returns void

destroy

Destroy method.

Returns void

getModuleName

Get component name.

Returns string

rangeChanged

To change the range for chart.

Parameter Type Description
updatedStart number The updated start value for the chart range.
updatedEnd number The updated end value for the chart range.

Returns void

renderPeriodSelector

Render period selector.

Returns void

stockChartDataManagerSuccess

DataManager Success.

Returns void

Events

axisLabelRender EmitType<IAxisLabelRenderEventArgs>

Triggers before each axis label is rendered.

beforeExport EmitType<IExportEventArgs>

Triggers before the export process begins. This event allows for the customization of export settings before the chart is exported.

legendClick EmitType<IStockLegendClickEventArgs>

Triggers after click on legend.

legendRender EmitType<IStockLegendRenderEventArgs>

Triggers before the legend is rendered.

load EmitType<IStockChartEventArgs>

Triggers before the range navigator rendering.

loaded EmitType<IStockChartEventArgs>

Triggers after the range navigator rendering.

onZooming EmitType<IZoomingEventArgs>

Triggers after the zoom selection is completed.

pointClick EmitType<IPointEventArgs>

Triggers on point click.

pointMove EmitType<IPointEventArgs>

Triggers on point move.

rangeChange EmitType<IRangeChangeEventArgs>

Triggers if the range is changed

selectorRender EmitType<IRangeSelectorRenderEventArgs>

Triggers before render the selector

seriesRender EmitType<ISeriesRenderEventArgs>

Triggers before the series is rendered.

stockChartMouseClick EmitType<IMouseEventArgs>

Triggers on clicking the stock chart.

stockChartMouseDown EmitType<IMouseEventArgs>

Triggers on mouse down.

stockChartMouseLeave EmitType<IMouseEventArgs>

Triggers when cursor leaves the chart.

stockChartMouseMove EmitType<IMouseEventArgs>

Triggers on hovering the stock chart.

stockChartMouseUp EmitType<IMouseEventArgs>

Triggers on mouse up.

stockEventRender EmitType<IStockEventRenderArgs>

Triggers before the series is rendered.

tooltipRender EmitType<ITooltipRenderEventArgs>

Triggers before the tooltip for series is rendered.