Class ChartIndicator

Inheritance
System.Object
EJTagHelper
ChartIndicator
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class ChartIndicator : EJTagHelper

Constructors

ChartIndicator()

Declaration
public ChartIndicator()

Properties

AnimationDuration

Gets or sets the animation duration value to animate the Indicators, which animates the indicator based on provided duration.

Declaration
[JsonProperty("animationDuration")]
public double? AnimationDuration { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

Specifies the animation duration value to animate the Indicators.

Close

Gets or sets the value for Close in Indicators, which binds close value for indicator data source based on specified close name.

Declaration
[JsonProperty("close")]
public string Close { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the close in indicators data source.

DataSource

Gets or sets the value for DataSource in Indicators, which specifies data source value to render technical indicator.

Declaration
[HtmlAttributeName("datasource")]
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("dataSource")]
public object DataSource { get; set; }
Property Value
Type Description
System.Object
Remarks

Specifies the data source in indicators.

DPeriod

Gets or sets the value for DPeriod in Indicators, which specifies d period value required for stochastic technical indicator.

Declaration
[JsonProperty("dPeriod")]
public double DPeriod { get; set; }
Property Value
Type Description
System.Double
Remarks

The dPeriod value for stochastic indicator.

EnableAnimation

Gets or sets the value for EnableAnimation in Indicators, which provides an option to enable or disable animation for technical indicators.

Declaration
[JsonProperty("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Enables/disables the animation.

Fill

Gets or sets the value for Fill in Indicators, which provides an option to customize fill color of technical indicator.

Declaration
[JsonProperty("fill")]
public string Fill { get; set; }
Property Value
Type Description
System.String
Remarks

Color of the technical indicator.

Font

Gets or sets the value for Font in Indicators, which provides an option to cutomize font of technical indicators.

Declaration
[JsonProperty("font")]
public ChartFont Font { get; set; }
Property Value
Type Description
ChartFont
Remarks

Specifies font in indicators

High

Gets or sets the value for High in Indicators, which binds high value for indicator data source based on provided high name.

Declaration
[JsonProperty("high")]
public string High { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the high in indicators data source.

Histogram

Gets or sets the value for Histogram in Indicators, which provides an option to customize histogram of MACD indicator.

Declaration
[JsonProperty("histogram")]
public Histogram Histogram { get; set; }
Property Value
Type Description
Histogram
Remarks

Options to customize the histogram in MACD indicator.

KPeriod

Gets or sets the value for KPeriod in Indicators, which specifies k period value required for stochastic technical indicator.

Declaration
[JsonProperty("kPeriod")]
public double KPeriod { get; set; }
Property Value
Type Description
System.Double
Remarks

Specifies the k period in stochastic indicator.

LongPeriod

Gets or sets the value for LongPeriod in Indicators, which specifies long period value required for MACD technical indicator.

Declaration
[JsonProperty("longPeriod")]
public double LongPeriod { get; set; }
Property Value
Type Description
System.Double
Remarks

Specifies the long period in MACD indicator.

Low

Gets or sets the value for Low in Indicators, which binds low value for indicator data source based on specified low name.

Declaration
[JsonProperty("low")]
public string Low { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the low in indicators data source.

LowerLine

Gets or sets the value for LowerLine in Indicators, which provides an option to customize lower line of technical indicators.

Declaration
[JsonProperty("lowerLine")]
public IndicatorLine LowerLine { get; set; }
Property Value
Type Description
IndicatorLine
Remarks

Options to customize the lower line in indicators.

MacdLine

Gets or sets the value for MacdLine in Indicators, which provides an option to customize MACD line of MACD technical indicator.

Declaration
[JsonProperty("macdLine")]
public IndicatorLine MacdLine { get; set; }
Property Value
Type Description
IndicatorLine
Remarks

Options to customize the MACD line.

MacdType

Gets or sets the value for MacdType in Indicators, which specifies Moving Average Convergence Divergence indicator with MACD line.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("macdType")]
public MacdType MacdType { get; set; }
Property Value
Type Description
MacdType
Remarks

Specifies the type of the MACD indicator.

Open

Gets or sets the value for Open in Indicators, which binds open value for indicator data source based on provided open name.

Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the open in indicators data source.

Period

Gets or sets the value for Period in Indicators, which specifies the period value required to render the technical indicator.

Declaration
[JsonProperty("period")]
public double Period { get; set; }
Property Value
Type Description
System.Double
Remarks

Specifies period value in indicator.

PeriodLine

Gets or sets the value for PeriodLine in Indicators, which provides an option to customize period line of indicator.

Declaration
[JsonProperty("periodLine")]
public IndicatorLine PeriodLine { get; set; }
Property Value
Type Description
IndicatorLine
Remarks

Options to customize the period line in indicators.

Points

Gets or sets the value for Points in Indicators, which provides an option to customize the chart indicator points.

Declaration
[JsonProperty("points")]
public List<Points> Points { get; }
Property Value
Type Description
System.Collections.Generic.List<Points>
Remarks

Specifies the points in indicators

SeriesName

Gets or sets the value for SeriesName in Indicators, which provides an option to specify series name to render indicator.

Declaration
[JsonProperty("seriesName")]
public string SeriesName { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the series for which indicator has to be drawn.

ShortPeriod

Gets or sets the value for ShortPeriod in Indicators, which specifies short period value required for MACD techniccal indicators.

Declaration
[JsonProperty("shortPeriod")]
public double ShortPeriod { get; set; }
Property Value
Type Description
System.Double
Remarks

Specifies the short period in MACD indicator.

StandardDeviations

Gets or sets the value for StandardDeviations in Indicators, which specifies standard deviation values required for bollinger band indicator.

Declaration
[JsonProperty("standardDeviations")]
public double StandardDeviations { get; set; }
Property Value
Type Description
System.Double
Remarks

Specifies the standard deviation value for Bollinger band indicator.

Tooltip

Gets or sets the value for Tooltip in Indicators, which displays tooltip value when hovered over technical indicators.

Declaration
[JsonProperty("tooltip")]
public NewTooltip Tooltip { get; set; }
Property Value
Type Description
NewTooltip
Remarks

Options to customize the tooltip.

Trigger

Gets or sets the value for Trigger in Indicators, which specifies trigger value required for MACD technical indicator.

Declaration
[JsonProperty("trigger")]
public double Trigger { get; set; }
Property Value
Type Description
System.Double
Remarks

Trigger value of MACD indicator.

Type

Gets or sets the value for Type in Indicators, which specifies the type of indicator chart to be rendered.

Declaration
[JsonProperty("type")]
[JsonConverter(typeof(StringEnumConverter))]
public ChartIndicatorType Type { get; set; }
Property Value
Type Description
ChartIndicatorType
Remarks

Specifies the type of indicator that has to be rendered.

UpperLine

Gets or sets the value for UpperLine in Indicators, which provides an option to customize upper line of technical indicators.

Declaration
[JsonProperty("upperLine")]
public IndicatorLine UpperLine { get; set; }
Property Value
Type Description
IndicatorLine
Remarks

Options to customize the upper line in indicators.

Visible

Gets or sets the value for Visible in Indicators, which controls the visibility of technical indicators.

Declaration
[JsonProperty("visible")]
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Show/hide the indicator.

Volume

Gets or sets the value for Volume in Indicators, which binds volume value for indicator data source based on provides volume name.

Declaration
[JsonProperty("volume")]
public string Volume { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the volume in indicators data source.

Width

Gets or sets the value for Width in Indicators, which provides an option to customize the width of an indicator line.

Declaration
[JsonProperty("width")]
public double Width { get; set; }
Property Value
Type Description
System.Double
Remarks

Width of the indicator line.

XAxisName

Gets or sets the value for XAxisName in Indicators, which provides an option to specify horizontal axis name for indicator.

Declaration
[JsonProperty("xAxisName")]
public string XAxisName { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the horizontal axis used for indicator. Primary X axis is used when x axis name is not specified.

XName

Gets or sets the value for XName in Indicators, which binds the x value for indicator data source based on specified x name.

Declaration
[JsonProperty("xName")]
public string XName { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the xName in indicators data source.

YAxisName

Gets or sets the value for YAxisName in Indicators, which provides an option to specify vertical axis name for indicator.

Declaration
[JsonProperty("yAxisName")]
public string YAxisName { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the vertical axis used for indicator. Primary Y axis is used when y axis name is not specified.

Methods

ShouldSerializeFont()

Declaration
public bool ShouldSerializeFont()
Returns
Type Description
System.Boolean

ShouldSerializeHistogram()

Declaration
public bool ShouldSerializeHistogram()
Returns
Type Description
System.Boolean

ShouldSerializeLowerLine()

Declaration
public bool ShouldSerializeLowerLine()
Returns
Type Description
System.Boolean

ShouldSerializeMacdLine()

Declaration
public bool ShouldSerializeMacdLine()
Returns
Type Description
System.Boolean

ShouldSerializePeriodLine()

Declaration
public bool ShouldSerializePeriodLine()
Returns
Type Description
System.Boolean

ShouldSerializeTooltip()

Declaration
public bool ShouldSerializeTooltip()
Returns
Type Description
System.Boolean

ShouldSerializeUpperLine()

Declaration
public bool ShouldSerializeUpperLine()
Returns
Type Description
System.Boolean