API Docs for: 3.8.0
Show:

StackedBarSeries Class

Module: charts-base
Parent Module: charts

The StackedBarSeries renders bar chart in which series are stacked horizontally to show their contribution to the cumulative total.

Methods

_getPlotDefaults

() protected

Returns:

Object

drawSeries

() protected

updateMarkerState

(
  • type
  • i
)
protected

Parameters:

  • type String

    state of the marker

  • i Number

    index of the marker

Attributes

direction

String

Direction of the series

Default: vertical

Fires event directionChange

Fires when the value for the configuration attribute direction 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.

negativeBaseValues

Array private

Default: null

Fires event negativeBaseValuesChange

Fires when the value for the configuration attribute negativeBaseValues 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.

positiveBaseValues

Array private

Default: null

Fires event positiveBaseValuesChange

Fires when the value for the configuration attribute positiveBaseValues 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.

styles

Object

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

fill
A hash containing the following values:
color
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 below array:
["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]
alpha
Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
border
A hash containing the following values:
color
Color of the border. The default value is determined by the order of the series on the graph. The color will be retrieved from the below array:
["#205096", "#b38206", "#000000", "#94001e", "#9d6fa0", "#e55b00", "#5e85c9", "#adab9e", "#6ac291", "#006457"]
alpha
Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
weight
Number indicating the width of the border. The default value is 1.
height
indicates the width of the marker. The default value is 24.
over
hash containing styles for markers when highlighted by a mouseover event. The default values for each style is null. When an over style is not set, the non-over value will be used. For example, the default value for marker.over.fill.color is equivalent to marker.fill.color.

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

Read-only attribute indicating the type of series.

Default: stackedBar

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.