#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# File: charts/js/SplineSeries.js

    /**
     * Provides functionality for creating a spline series.
     *
     * @module charts
     * @submodule series-spline
     */
    /**
     * SplineSeries renders a graph with data points connected by a curve.
     *
     * @class SplineSeries
     * @extends LineSeries
     * @uses CurveUtil
     * @uses Lines
     * @constructor
     * @param {Object} config (optional) Configuration parameters.
     * @submodule series-spline
     */
    Y.SplineSeries = Y.Base.create("splineSeries",  Y.LineSeries, [Y.CurveUtil, Y.Lines], {
        /**
         * @protected
         *
         * Draws the series.
         *
         * @method drawSeries
         */
        drawSeries: function()
        {
            this.drawSpline();
        }
    }, {
    	ATTRS : {
            /**
             * Read-only attribute indicating the type of series.
             *
             * @attribute type
             * @type String
             * @default spline
             */
            type : {
                value:"spline"
            }

            /**
             * Style properties used for drawing lines. This attribute is inherited from `Renderer`.
             * Below are the default values:
             *  <dl>
             *      <dt>color</dt><dd>The color of the line. The default value is determined by the order of the series on
             *      the graph. The color will be retrieved from the following array:
             *      `["#426ab3", "#d09b2c", "#000000", "#b82837", "#b384b5", "#ff7200", "#779de3", "#cbc8ba", "#7ed7a6", "#007a6c"]`
             *      <dt>weight</dt><dd>Number that indicates the width of the line. The default value is 6.</dd>
             *      <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the line. The default value is 1.</dd>
             *      <dt>lineType</dt><dd>Indicates whether the line is solid or dashed. The default value is solid.</dd>
             *      <dt>dashLength</dt><dd>When the `lineType` is dashed, indicates the length of the dash. The default value
             *      is 10.</dd>
             *      <dt>gapSpace</dt><dd>When the `lineType` is dashed, indicates the distance between dashes. The default value is
             *      10.</dd>
             *      <dt>connectDiscontinuousPoints</dt><dd>Indicates whether or not to connect lines when there is a missing or null
             *      value between points. The default value is true.</dd>
             *      <dt>discontinuousType</dt><dd>Indicates whether the line between discontinuous points is solid or dashed. The
             *      default value is solid.</dd>
             *      <dt>discontinuousDashLength</dt><dd>When the `discontinuousType` is dashed, indicates the length of the dash.
             *      The default value is 10.</dd>
             *      <dt>discontinuousGapSpace</dt><dd>When the `discontinuousType` is dashed, indicates the distance between dashes.
             *      The default value is 10.</dd>
             *  </dl>
             *
             * @attribute styles
             * @type Object
             */
        }
    });