Version 3.5.1
Show:

BarSeries Class

Defined in: charts/js/BarSeries.js:1
Module: charts

The BarSeries class renders bars positioned vertically along a category or time axis. The bars' lengths are proportional to the values they represent along a horizontal axis. and the relevant data points.

Methods

_getMarkerDimensions

(
  • xcoord
  • ycoord
  • calculatedSize
  • offset
)
private

Defined in charts/js/BarSeries.js:13

Helper method for calculating the size of markers.

Parameters:

  • xcoord Number

    The x-coordinate representing the data point for the marker.

  • ycoord Number

    The y-coordinate representing the data point for the marker.

  • calculatedSize Number

    The calculated size for the marker. For a BarSeries is it the width. For a ColumnSeries it is the height.

  • offset Number

    Distance of position offset dictated by other marker series in the same graph.

Returns:

Object

updateMarkerState

(
  • type
  • i
)
protected

Defined in charts/js/BarSeries.js:42

Resizes and positions markers based on a mouse interaction.

Parameters:

  • type String

    state of the marker

  • i Number

    index of the marker

Attributes

direction

String

Defined in charts/js/BarSeries.js:117

Indicates the direction of the category axis that the bars are plotted against.

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.

styles

Object

Defined in charts/js/BarSeries.js:127

Style properties used for drawing markers. This attribute is inherited from MarkerSeries. 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 12.
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

Defined in charts/js/BarSeries.js:106

Read-only attribute indicating the type of series.

Default: bar

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.