API Docs for: 3.8.0
Show:

AreaSeries Class

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

The AreaSeries class renders quantitative data on a graph by creating a fill between 0 and the relevant data points.

Item Index

Methods

Attributes

Methods

_getDefaultStyles

() protected

Defined in charts/js/AreaSeries.js:43

Returns:

Object

_setStyles

(
  • newStyles
)
protected

Defined in charts/js/AreaSeries.js:25

Parameters:

  • newStyles Object

    Hash of properties to update.

Returns:

Object

drawSeries

() protected

Defined in charts/js/AreaSeries.js:13

Attributes

styles

Object

Defined in charts/js/AreaSeries.js:71

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

color
The color of the fill. The default value is determined by the order of the series on the graph. The color will be retrieved from the following array: ["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]
alpha
Number between 0 and 1 that indicates the opacity of the fill. The default value is 1

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/AreaSeries.js:60

Read-only attribute indicating the type of series.

Default: area

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.