Class ChartIndicatorBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
ChartIndicatorBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartIndicatorBuilder : ControlBuilder
Constructors
ChartIndicatorBuilder()
Declaration
public ChartIndicatorBuilder()
ChartIndicatorBuilder(List<ChartIndicator>)
Declaration
public ChartIndicatorBuilder(List<ChartIndicator> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChartIndicator> |
collection |
|
Methods
Accessibility(TechnicalIndicatorAccessibility)
Options to improve accessibility for technical indicator elements.
Declaration
public ChartIndicatorBuilder Accessibility(TechnicalIndicatorAccessibility accessibility)
Parameters
Returns
Accessibility(Action<ChartAccessibilityBuilder>)
Declaration
public ChartIndicatorBuilder Accessibility(Action<ChartAccessibilityBuilder> accessibility)
Parameters
Returns
Add()
Declaration
Animation(ChartAnimation)
Options for customizing the animation of the series.
By default, animation is enabled with a duration of 1000 milliseconds (about 1 second). It can be disabled by setting enable to false.
The following properties are supported in animation:
enable: If set to true, the series is animated on initial loading.
duration: The duration of the animation in milliseconds.
delay: The delay before the animation starts, in milliseconds.
Declaration
public ChartIndicatorBuilder Animation(ChartAnimation animation)
Parameters
Returns
Animation(Action<ChartAnimationBuilder>)
Declaration
public ChartIndicatorBuilder Animation(Action<ChartAnimationBuilder> animation)
Parameters
Returns
BandColor(String)
Configures the settings for customizing the Bollinger Bands in the indicator.
Declaration
public ChartIndicatorBuilder BandColor(string bandColor)
Parameters
| Type |
Name |
Description |
| System.String |
bandColor |
|
Returns
Close(String)
The data source field that contains the close value.
It is applicable for both financial series and technical indicators.
Declaration
public ChartIndicatorBuilder Close(string close)
Parameters
| Type |
Name |
Description |
| System.String |
close |
|
Returns
ColorName(String)
The data source field that contains the color mapping value.
It is applicable for range color mapping.
Declaration
public ChartIndicatorBuilder ColorName(string colorName)
Parameters
| Type |
Name |
Description |
| System.String |
colorName |
|
Returns
DashArray(String)
Defines the pattern of dashes and gaps used to stroke the lines in Line type series.
Declaration
public ChartIndicatorBuilder DashArray(string dashArray)
Parameters
| Type |
Name |
Description |
| System.String |
dashArray |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public ChartIndicatorBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
| Type |
Name |
Description |
| System.Action<Syncfusion.EJ2.DataManagerBuilder> |
dataSource |
|
Returns
DataSource(Object)
Specifies the data source for the series. It can be an array of JSON objects, or an instance of DataManager.
Declaration
public ChartIndicatorBuilder DataSource(object dataSource)
Parameters
| Type |
Name |
Description |
| System.Object |
dataSource |
|
Returns
DPeriod(Double)
Defines the period over which price changes determine the %D value in stochastic indicators.
Declaration
public ChartIndicatorBuilder DPeriod(double dPeriod)
Parameters
| Type |
Name |
Description |
| System.Double |
dPeriod |
|
Returns
EnableComplexProperty(Boolean)
This property is used to improve chart performance through data mapping for the series data source.
Declaration
public ChartIndicatorBuilder EnableComplexProperty(bool enableComplexProperty)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableComplexProperty |
|
Returns
FastPeriod(Double)
Sets the fast period to define the MACD line.
Declaration
public ChartIndicatorBuilder FastPeriod(double fastPeriod)
Parameters
| Type |
Name |
Description |
| System.Double |
fastPeriod |
|
Returns
Field(FinancialDataFields)
Defines the field used to compare the current value with previous values.
Declaration
public ChartIndicatorBuilder Field(FinancialDataFields field)
Parameters
Returns
Fill(String)
The fill color for the series, which accepts values in hex or 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 is null.
Declaration
public ChartIndicatorBuilder Fill(string fill)
Parameters
| Type |
Name |
Description |
| System.String |
fill |
|
Returns
High(String)
The data source field that contains the high value.
It is applicable for both financial series and technical indicators.
Declaration
public ChartIndicatorBuilder High(string high)
Parameters
| Type |
Name |
Description |
| System.String |
high |
|
Returns
KPeriod(Double)
Defines the look-back period for price changes used to calculate the %K value in stochastic indicators.
Declaration
public ChartIndicatorBuilder KPeriod(double kPeriod)
Parameters
| Type |
Name |
Description |
| System.Double |
kPeriod |
|
Returns
Low(String)
The data source field that contains the low value.
It is applicable for both financial series and technical indicators.
Declaration
public ChartIndicatorBuilder Low(string low)
Parameters
| Type |
Name |
Description |
| System.String |
low |
|
Returns
LowerLine(ChartConnector)
Defines the appearance of the lower line in technical indicators.
Declaration
public ChartIndicatorBuilder LowerLine(ChartConnector lowerLine)
Parameters
Returns
LowerLine(Action<ChartConnectorBuilder>)
Declaration
public ChartIndicatorBuilder LowerLine(Action<ChartConnectorBuilder> lowerLine)
Parameters
Returns
MacdLine(ChartConnector)
Defines the appearance of the MACD line in the MACD indicator.
Declaration
public ChartIndicatorBuilder MacdLine(ChartConnector macdLine)
Parameters
Returns
MacdLine(Action<ChartConnectorBuilder>)
Declaration
public ChartIndicatorBuilder MacdLine(Action<ChartConnectorBuilder> macdLine)
Parameters
Returns
MacdNegativeColor(String)
Specifies the color for negative bars in the MACD indicator.
Declaration
public ChartIndicatorBuilder MacdNegativeColor(string macdNegativeColor)
Parameters
| Type |
Name |
Description |
| System.String |
macdNegativeColor |
|
Returns
MacdPositiveColor(String)
Specifies the color for positive bars in the MACD indicator.
Declaration
public ChartIndicatorBuilder MacdPositiveColor(string macdPositiveColor)
Parameters
| Type |
Name |
Description |
| System.String |
macdPositiveColor |
|
Returns
MacdType(MacdType)
Defines the type of the MACD (Moving Average Convergence Divergence) indicator.
Declaration
public ChartIndicatorBuilder MacdType(MacdType macdType)
Parameters
Returns
Open(String)
The data source field that contains the open value.
It is applicable for both financial series and technical indicators.
Declaration
public ChartIndicatorBuilder Open(string open)
Parameters
| Type |
Name |
Description |
| System.String |
open |
|
Returns
OverBought(Double)
Specifies the over-bought (threshold) values applicable for RSI and stochastic indicators.
Declaration
public ChartIndicatorBuilder OverBought(double overBought)
Parameters
| Type |
Name |
Description |
| System.Double |
overBought |
|
Returns
OverSold(Double)
Defines the over-sold (threshold) values for RSI and stochastic indicators.
Declaration
public ChartIndicatorBuilder OverSold(double overSold)
Parameters
| Type |
Name |
Description |
| System.Double |
overSold |
|
Returns
Period(Double)
Defines the period over which price changes are considered for trend prediction.
Declaration
public ChartIndicatorBuilder Period(double period)
Parameters
| Type |
Name |
Description |
| System.Double |
period |
|
Returns
PeriodLine(ChartConnector)
Defines the appearance of the period line in technical indicators.
Declaration
public ChartIndicatorBuilder PeriodLine(ChartConnector periodLine)
Parameters
Returns
PeriodLine(Action<ChartConnectorBuilder>)
Declaration
public ChartIndicatorBuilder PeriodLine(Action<ChartConnectorBuilder> periodLine)
Parameters
Returns
PointColorMapping(String)
The data source field that contains the color value of a point.
It is applicable for series.
Declaration
public ChartIndicatorBuilder PointColorMapping(string pointColorMapping)
Parameters
| Type |
Name |
Description |
| System.String |
pointColorMapping |
|
Returns
Query(String)
Specifies a query to select data from the data source. This property is applicable only when the data source is an ej.DataManager.
Declaration
public ChartIndicatorBuilder Query(string query)
Parameters
| Type |
Name |
Description |
| System.String |
query |
|
Returns
SegmentAxis(Segment)
Defines the axis along which the line series will be split.
Declaration
public ChartIndicatorBuilder SegmentAxis(Segment segmentAxis)
Parameters
| Type |
Name |
Description |
| Segment |
segmentAxis |
|
Returns
Segments(Object)
Specifies a collection of regions used to differentiate a line series.
Declaration
public ChartIndicatorBuilder Segments(object segments)
Parameters
| Type |
Name |
Description |
| System.Object |
segments |
|
Returns
SeriesName(String)
Specifies the name of the series to be used for displaying the indicator data.
Declaration
public ChartIndicatorBuilder SeriesName(string seriesName)
Parameters
| Type |
Name |
Description |
| System.String |
seriesName |
|
Returns
ShowZones(Boolean)
Specifies whether to enable or disable the over-bought and over-sold regions.
Declaration
public ChartIndicatorBuilder ShowZones(bool showZones)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showZones |
|
Returns
SlowPeriod(Double)
Sets the slow period for defining the MACD line.
Declaration
public ChartIndicatorBuilder SlowPeriod(double slowPeriod)
Parameters
| Type |
Name |
Description |
| System.Double |
slowPeriod |
|
Returns
StandardDeviation(Double)
Sets the standard deviation values used to define the upper and lower Bollinger Bands.
Declaration
public ChartIndicatorBuilder StandardDeviation(double standardDeviation)
Parameters
| Type |
Name |
Description |
| System.Double |
standardDeviation |
|
Returns
Type(TechnicalIndicators)
Defines the types of technical indicators. They are:
'Sma' - Predicts the trend using the Simple Moving Average approach.
'Ema' - Predicts the trend using the Exponential Moving Average approach.
'Tma' - Predicts the trend using the Triangular Moving Average approach.
'Atr' - Predicts the trend using the Average True Range approach.
'AccumulationDistribution' - Predicts the trend using the Accumulation Distribution approach.
'Momentum' - Predicts the trend using the Momentum approach.
'Rsi' - Predicts the trend using the Relative Strength Index (RSI) approach.
'Macd' - Predicts the trend using the Moving Average Convergence Divergence (MACD) approach.
'Stochastic' - Predicts the trend using the Stochastic Oscillator approach.
'BollingerBands' - Predicts the trend using the Bollinger Bands approach.
Declaration
public ChartIndicatorBuilder Type(TechnicalIndicators type)
Parameters
Returns
UpperLine(ChartConnector)
Defines the appearance of the upper line in technical indicators.
Declaration
public ChartIndicatorBuilder UpperLine(ChartConnector upperLine)
Parameters
Returns
UpperLine(Action<ChartConnectorBuilder>)
Declaration
public ChartIndicatorBuilder UpperLine(Action<ChartConnectorBuilder> upperLine)
Parameters
Returns
Visible(Boolean)
If set to true, the series will be visible. If set to false, the series will be hidden.
Declaration
public ChartIndicatorBuilder Visible(bool visible)
Parameters
| Type |
Name |
Description |
| System.Boolean |
visible |
|
Returns
Volume(String)
Defines the data source field that contains the volume value in candle charts.
It is applicable for both financial series and technical indicators.
Declaration
public ChartIndicatorBuilder Volume(string volume)
Parameters
| Type |
Name |
Description |
| System.String |
volume |
|
Returns
Width(Double)
The stroke width for the series, applicable only for Line type series.
It also represents the stroke width of the signal lines in technical indicators.
Declaration
public ChartIndicatorBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
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.
Declaration
public ChartIndicatorBuilder XAxisName(string xAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
xAxisName |
|
Returns
XName(String)
The data source field that contains the x value.
It is applicable to both series and technical indicators.
Declaration
public ChartIndicatorBuilder XName(string xName)
Parameters
| Type |
Name |
Description |
| System.String |
xName |
|
Returns
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.
Declaration
public ChartIndicatorBuilder YAxisName(string yAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
yAxisName |
|
Returns
