ASP.NET MVC Controls | ComponentOne
In This Topic
    ATR Class
    In This Topic
    File
    wijmo.chart.finance.analytics.js
    Module
    wijmo.chart.finance.analytics
    Base Class
    SingleOverlayIndicatorBase

    Represents an Average True Range indicator series for the FinancialChart.

    Average true range is used to measure the volatility of an asset. Average true range does not provide any indication of the price's trend, but rather the degree of price volatility.

    Constructor

    Properties

    Methods

    Events

    Constructor

    constructor

    constructor(options?: any): ATR
    

    Initializes a new instance of the ATR class.

    Parameters
    • options: any
    Optional

    JavaScript object containing initialization data for the object.

    Returns
    ATR

    Properties

    altStyle

    Gets or sets the alternate style for the series.

    The alternate style is used for negative values in Bar, Column, and Scatter charts; and for rising values in financial chart types like Candlestick, LineBreak, EquiVolume etc.

    The default value for this property is null, which causes the series to use the default style.

    Inherited From
    SeriesBase
    Type
    any

    axisX

    Gets or sets the X-axis for the series.

    Inherited From
    SeriesBase
    Type
    Axis

    axisY

    Gets or sets the Y-axis for the series.

    Inherited From
    SeriesBase
    Type
    Axis

    binding

    Gets or sets the name of the property that contains Y values for the series.

    Inherited From
    SeriesBase
    Type
    string

    bindingX

    Gets or sets the name of the property that contains X values for the series.

    Inherited From
    SeriesBase
    Type
    string

    chart

    Gets the FlexChart object that owns this series.

    Inherited From
    SeriesBase
    Type
    FlexChartCore

    collectionView

    Gets the ICollectionView object that contains the data for this series.

    Inherited From
    SeriesBase
    Type
    ICollectionView

    cssClass

    Gets or sets the series CSS class.

    Inherited From
    SeriesBase
    Type
    string

    hostElement

    Gets the series host element.

    Inherited From
    SeriesBase
    Type
    SVGGElement

    interpolateNulls

    Gets or sets a value that determines whether to interpolate null values in the data.

    If true, the series interpolates the value of any missing data based on neighboring points. If false, it leaves a break in lines and areas at the points with null values.

    The default value for this property is false.

    Inherited From
    SeriesBase
    Type
    boolean

    itemFormatter

    Gets or sets the item formatter function that allows you to customize the appearance of the series.

    The property overrides the chart's itemFormatter itemFormatter.

    Inherited From
    SeriesBase
    Type
    Function

    itemsSource

    Gets or sets the array or ICollectionView object that contains the series data.

    Inherited From
    SeriesBase
    Type
    any

    legendElement

    Gets the series element in the legend.

    Inherited From
    SeriesBase
    Type
    SVGGElement

    name

    Gets or sets the series name.

    The series name is displayed in the chart legend. Any series without a name does not appear in the legend.

    Inherited From
    SeriesBase
    Type
    string

    period

    Gets or sets the period for the calculation as an integer value.

    Inherited From
    SingleOverlayIndicatorBase
    Type
    any

    style

    Gets or sets the series style.

    Inherited From
    SeriesBase
    Type
    any

    symbolMarker

    Gets or sets the shape of marker to use for each data point in the series. Applies to Scatter, LineSymbols, and SplineSymbols chart types.

    The default value for this property is Marker.Dot.

    Inherited From
    SeriesBase
    Type
    Marker

    symbolSize

    Gets or sets the size (in pixels) of the symbols used to render this Series. Applies to Scatter, LineSymbols, and SplineSymbols chart types.

    The default value for this property is 10 pixels.

    Inherited From
    SeriesBase
    Type
    number

    symbolStyle

    Gets or sets the series symbol style.

    Applies to Bar, Column, Scatter, LineSymbols, and SplineSymbols chart types.

    Inherited From
    SeriesBase
    Type
    any

    tooltipContent

    Gets or sets the series specific tooltip content.

    The property overrides the content of chart tooltip content.

    Inherited From
    SeriesBase
    Type
    any

    visibility

    Gets or sets an enumerated value indicating whether and where the series appears.

    The default value for this property is SeriesVisibility.Visible.

    Inherited From
    SeriesBase
    Type
    SeriesVisibility

    Methods

    dataToPoint

    dataToPoint(pt: Point): Point
    

    Converts a Point from series data coordinates to control coordinates.

    Parameters
    Inherited From
    SeriesBase
    Returns
    Point

    drawLegendItem

    drawLegendItem(engine: IRenderEngine, rect: Rect, index: number): void
    

    Draw a legend item at the specified position.

    Parameters
    • engine: IRenderEngine

      The rendering engine to use.

    • rect: Rect

      The position of the legend item.

    • index: number

      Index of legend item(for series with multiple legend items).

    Inherited From
    SeriesBase
    Returns
    void

    getDataRect

    getDataRect(currentRect?: Rect, calculatedRect?: Rect): Rect
    

    Returns the series bounding rectangle in data coordinates.

    If getDataRect() returns null, the limits are calculated automatically based on the data values.

    Parameters
    Optional

    The current rectangle of chart. This parameter is optional.

    The calculated rectangle of chart. This parameter is optional.

    Inherited From
    SeriesBase
    Returns
    Rect

    getPlotElement

    getPlotElement(pointIndex: number): any
    

    Gets the plot element that corresponds to the specified point index.

    Parameters
    • pointIndex: number

      The index of the data point.

    Inherited From
    SeriesBase
    Returns
    any

    hitTest

    hitTest(pt: any, y?: number): HitTestInfo
    

    Gets a HitTestInfo object with information about the specified point.

    Parameters
    • pt: any

      The point to investigate, in window coordinates.

    • y: number Optional

      The Y coordinate of the point (if the first parameter is a number).

    Inherited From
    SeriesBase
    Returns
    HitTestInfo

    initialize

    initialize(options: any): void
    

    Initializes the series by copying the properties from a given object.

    Parameters
    • options: any

      JavaScript object containing initialization data for the series.

    Inherited From
    SeriesBase
    Returns
    void

    legendItemLength

    legendItemLength(): number
    

    Returns number of series items in the legend.

    Inherited From
    SeriesBase
    Returns
    number

    measureLegendItem

    measureLegendItem(engine: IRenderEngine, index: number): Size
    

    Measures height and width of the legend item.

    Parameters
    • engine: IRenderEngine

      The rendering engine to use.

    • index: number

      Index of legend item(for series with multiple legend items).

    Inherited From
    SeriesBase
    Returns
    Size

    onRendered

    onRendered(engine: IRenderEngine): void
    

    Raises the rendered event.

    Parameters
    Inherited From
    SeriesBase
    Returns
    void

    onRendering

    onRendering(engine: IRenderEngine, index: number, count: number): boolean
    

    Raises the rendering event.

    Parameters
    Inherited From
    SeriesBase
    Returns
    boolean

    pointToData

    pointToData(pt: Point): Point
    

    Converts a Point from control coordinates to series data coordinates.

    Parameters
    • pt: Point

      The point to convert, in control coordinates.

    Inherited From
    SeriesBase
    Returns
    Point

    Events

    rendered

    Occurs when series is rendered.

    Inherited From
    SeriesBase
    Arguments
    IRenderEngine

    rendering

    Occurs when series is rendering.

    Inherited From
    SeriesBase
    Arguments
    EventArgs