API Docs for: 3.8.0
Show:

LineSeries Class

Defined in: charts/js/LineSeries.js:1
Module: charts-base
Parent Module: charts

The LineSeries class renders quantitative data on a graph by connecting relevant data points.

Item Index

Methods

Attributes

Methods

_getDefaultStyles

() protected

Defined in charts/js/LineSeries.js:40

Returns:

Object

_setStyles

(
  • newStyles
)
protected

Defined in charts/js/LineSeries.js:22

Parameters:

  • newStyles Object

    Hash of properties to update.

Returns:

Object

drawSeries

() protected

Defined in charts/js/LineSeries.js:12

Attributes

styles

Object

Defined in charts/js/LineSeries.js:68

Style properties used for drawing lines. This attribute is inherited from Renderer. Below are the default values:

color
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"]
weight
Number that indicates the width of the line. The default value is 6.
alpha
Number between 0 and 1 that indicates the opacity of the line. The default value is 1.
lineType
Indicates whether the line is solid or dashed. The default value is solid.
dashLength
When the lineType is dashed, indicates the length of the dash. The default value is 10.
gapSpace
When the lineType is dashed, indicates the distance between dashes. The default value is 10.
connectDiscontinuousPoints
Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.
discontinuousType
Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.
discontinuousDashLength
When the discontinuousType is dashed, indicates the length of the dash. The default value is 10.
discontinuousGapSpace
When the discontinuousType is dashed, indicates the distance between dashes. The default value is 10.

Fires event stylesChange

Fires when the value for the configuration attribute styles is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

type

String

Defined in charts/js/LineSeries.js:57

Read-only attribute indicating the type of series.

Default: line

Fires event typeChange

Fires when the value for the configuration attribute type is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.