StockSeriesModel API in React Stock Chart API component

Interface for a class StockSeries

Properties

animation

AnimationModel

Options to customizing animation for the series.

bearFillColor

string

This property is used in stock charts to visualize the price movements in stock. It defines the color of the candle/point, when the opening price is less than the closing price.

border

BorderModel

Options to customizing the border of the series. This is applicable only for Column and Bar type series.

bullFillColor

string

This property is used in financial charts to visualize the price movements in stock. It defines the color of the candle/point, when the opening price is higher than the closing price.

cardinalSplineTension

number

It defines tension of cardinal spline types.

close

string

The DataSource field that contains the close value of y It is applicable for series and technical indicators

columnSpacing

number

To render the column series points with particular column spacing. It takes value from 0 - 1.

columnWidth

number

To render the column series points with particular column width. If the series type is histogram the default value is 1 otherwise 0.7.

cornerRadius

CornerRadiusModel

To render the column series points with particular rounded corner.

dashArray

string

Defines the pattern of dashes and gaps to stroke the lines in Line type series.

dataSource

Object | DataManager

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

emptyPointSettings

EmptyPointSettingsModel

options to customize the empty points in series.

enableSolidCandles

boolean

This property is applicable for candle series. It enables/disables to visually compare the current values with the previous values in stock.

enableTooltip

boolean

If set true, the Tooltip for series will be visible.

fill

string

The fill color for the series that accepts value in hex and rgba as a valid CSS color string. It also represents the color of the signal lines in technical indicators. For technical indicators, the default value is ‘blue’ and for series, it has null.

high

string

The DataSource field that contains the high value of y It is applicable for series and technical indicators

legendImageUrl

string

The URL for the Image that is to be displayed as a Legend icon. It requires legendShape value to be an Image.

legendShape

LegendShape

The shape of the legend. Each series has its own legend shape. They are

• Circle - Renders a circle.
• Rectangle - Renders a rectangle.
• Triangle - Renders a triangle.
• Diamond - Renders a diamond.
• Cross - Renders a cross.
• HorizontalLine - Renders a horizontalLine.
• VerticalLine - Renders a verticalLine.
• Pentagon - Renders a pentagon.
• InvertedTriangle - Renders a invertedTriangle.
• SeriesType -Render a legend shape based on series type.
• Image -Render a image. *

low

string

The DataSource field that contains the low value of y It is applicable for series and technical indicators

marker

MarkerSettingsModel

Options for displaying and customizing markers for individual points in a series.

name

string

The name of the series visible in legend.

opacity

number

The opacity of the series.

open

string

The DataSource field that contains the open value of y It is applicable for series and technical indicators

pointColorMapping

string

The DataSource field that contains the color value of point It is applicable for series

query

Query

Specifies query to select data from DataSource. This property is applicable only when the DataSource is ej.DataManager.

selectionStyle

string

Custom style for the selected series or points.

showNearestTooltip

boolean

Enables or disables the display of tooltips for the nearest data point to the cursor for series.

tooltipMappingName

string

The provided value will be considered as a Tooltip name

trendlines

TrendlineModel[]

Defines the collection of trendlines that are used to predict the trend

type

ChartSeriesType

The type of the series are

• Line
• Column
• Area
• Spline
• Hilo
• HiloOpenClose
• Candle

visible

boolean

Specifies the visibility of series.

volume

string

Defines the data source field that contains the volume value in candle charts It is applicable for financial series and technical indicators

width

number

The stroke width for the series that is applicable only for Line type series. It also represents the stroke width of the signal lines in technical indicators.

xAxisName

string

The name of the horizontal axis associated with the series. It requires axes of the chart. It is applicable for series and technical indicators

xName

string

The DataSource field that contains the x value. It is applicable for series and technical indicators

yAxisName

string

The name of the vertical axis associated with the series. It requires axes of the chart. It is applicable for series and technical indicators

yName

string

The DataSource field that contains the y value.