ASP.NET MVC Controls | ComponentOne
In This Topic
    SeriesBase Class
    In This Topic
    File
    wijmo.chart.js
    Module
    wijmo.chart
    Derived Classes
    Series, BoxWhisker, BreakEven, TrendLineBase, Waterfall, FlexRadarSeries, FinancialSeries, Fibonacci, FibonacciArcs, FibonacciFans, FibonacciTimeZones, OverlayIndicatorBase

    Represents a series of data points to display in the chart.

    Constructor

    constructor

    constructor(options?: any): SeriesBase
    

    Initializes a new instance of the SeriesBase class.

    Parameters
    • options: any Optional

      JavaScript object containing initialization data for the object.

    Returns
    SeriesBase

    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.

    Type
    any

    axisX

    Gets or sets the X-axis for the series.

    Type
    Axis

    axisY

    Gets or sets the Y-axis for the series.

    Type
    Axis

    binding

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

    Type
    string

    bindingX

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

    Type
    string

    chart

    Gets the FlexChart object that owns this series.

    Type
    FlexChartCore

    collectionView

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

    Type
    ICollectionView

    cssClass

    Gets or sets the series CSS class.

    Type
    string

    hostElement

    Gets the series host element.

    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.

    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.

    Type
    Function

    itemsSource

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

    Type
    any

    legendElement

    Gets the series element in the legend.

    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.

    Type
    string

    style

    Gets or sets the series style.

    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.

    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.

    Type
    number

    symbolStyle

    Gets or sets the series symbol style.

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

    Type
    any

    tooltipContent

    Gets or sets the series specific tooltip content.

    The property overrides the content of chart tooltip content.

    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.

    Type
    SeriesVisibility

    Methods

    dataToPoint

    dataToPoint(pt: Point): Point
    

    Converts a Point from series data coordinates to control coordinates.

    Parameters
    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).

    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
    • currentRect: Rect Optional

      The current rectangle of chart. This parameter is optional.

    • calculatedRect: Rect Optional

      The calculated rectangle of chart. This parameter is optional.

    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.

    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).

    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.

    Returns
    void

    legendItemLength

    legendItemLength(): number
    

    Returns number of series items in the legend.

    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).

    Returns
    Size

    onRendered

    onRendered(engine: IRenderEngine): void
    

    Raises the rendered event.

    Parameters
    Returns
    void

    onRendering

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

    Raises the rendering event.

    Parameters
    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.

    Returns
    Point

    Events

    rendered

    Occurs when series is rendered.

    Arguments
    IRenderEngine

    rendering

    Occurs when series is rendering.

    Arguments
    EventArgs