Package muntjac :: Package addon :: Package invient :: Module invient_charts_config :: Class BaseBarConfig

Class BaseBarConfig

  object --+    
           |    
SeriesConfig --+
               |
              BaseBarConfig

This class contains configuration options for bar and column series.

Authors:: Invient, Richard Lincoln

Instance Methods

[hide private]

__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

getBorderColor(self)
@return

source code

setBorderColor(self, borderColor)
Sets the color of the border surronding each column or bar.

source code

getBorderRadius(self)
@return

source code

setBorderRadius(self, borderRadius)
Sets corner radius of the border surronding each column or bar.

source code

getBorderWidth(self)
@return

source code

setBorderWidth(self, borderWidth)
Sets width of the border surronding each column or bar.

source code

getColorByPoint(self)
@return

source code

setColorByPoint(self, colorByPoint)
If the argument is true then each point (bar or column in a series will have a different color otherwise all points (bars/columns) of a series will have same color.

source code

getGroupPadding(self)
@return

source code

setGroupPadding(self, groupPadding)
Sets padding between each value groups, in x axis units.

source code

getMinPointLength(self)
@return

source code

setMinPointLength(self, minPointLength)
Sets the minimal height for a column or width for a bar.

source code

getPointPadding(self)
@return

source code

setPointPadding(self, pointPadding)
Sets padding between each column or bar, in x axis units.

source code

getPointWidth(self)
@return

source code

setPointWidth(self, pointWidth)
Sets width of each bar or column in pixel.

source code

setHoverState(self, state)
Sets state which should be applied to a bar or column when a mouse is over the bar or column

source code

getHoverState(self)
@return

source code

Inherited from SeriesConfig: getAllowPointSelect, getAnimation, getColor, getCursor, getDataLabel, getEnableMouseTracking, getShadow, getShowCheckbox, getShowInLegend, getStacking, getVisible, setAllowPointSelect, setAnimation, setColor, setCursor, setDataLabel, setEnableMouseTracking, setShadow, setShowCheckbox, setShowInLegend, setStacking, setVisible

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

setBorderColor(self, borderColor)

source code

Sets the color of the border surronding each column or bar.

@param borderColor

setBorderRadius(self, borderRadius)

source code

Sets corner radius of the border surronding each column or bar.

@param borderRadius

setBorderWidth(self, borderWidth)

source code

Sets width of the border surronding each column or bar.

@param borderWidth

setColorByPoint(self, colorByPoint)

source code

If the argument is true then each point (bar or column in a series will have a different color otherwise all points (bars/columns) of a series will have same color.

@param colorByPoint

setGroupPadding(self, groupPadding)

source code

Sets padding between each value groups, in x axis units. Defaults to 0.2.

@param groupPadding

setMinPointLength(self, minPointLength)

source code

Sets the minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values. Defaults to 0. (For detail, refer to http://www.highcharts.com/ref/#plotOptions-bar);

@param minPointLength