Package muntjac :: Package addon :: Package invient :: Module invient_charts_config :: Class SeriesConfig
[hide private]
[frames] | no frames]

Class SeriesConfig

source code

object --+
         |
        SeriesConfig
Known Subclasses:

This class contains general configuration options for all series types such as line, area and pie.


Authors:
Invient, Richard Lincoln
Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getAllowPointSelect(self)
@return
source code
 
setAllowPointSelect(self, allowPointSelect)
If the argument is true then the points of a can be selected otherwise not.
source code
 
getAnimation(self) source code
 
setAnimation(self, animation)
If the argument is true then animation will be enabled when a series will be displayed otherwise not.
source code
 
getEnableMouseTracking(self)
@return
source code
 
setEnableMouseTracking(self, enableMouseTracking)
If the argument is true then the mouse tracking will be enabled for a series otherwise not.
source code
 
getShowInLegend(self)
@return
source code
 
setShowInLegend(self, showInLegend)
If the argument is true then a series will be displayed in the legend otherwise not.
source code
 
getCursor(self)
@return
source code
 
setCursor(self, cursor)
Sets the cursor style.
source code
 
getStacking(self)
@return
source code
 
setStacking(self, stacking)
Specifies whether the values of each series should be stacked on top of each other or not.
source code
 
getShowCheckbox(self)
@return
source code
 
setShowCheckbox(self, showCheckbox)
If the argument is true then a checkbox is displayed next to the legend item in the legend area.
source code
 
getVisible(self)
@return
source code
 
setVisible(self, visible)
If the argument is true then the series is visible otherwise not when a chart is rendered initially.
source code
 
getShadow(self)
@return
source code
 
setShadow(self, shadow)
If the argument is true then a shadow will be shown to the graph line otherwise not.
source code
 
getHoverState(self)
@return
source code
 
setHoverState(self, state)
Sets attributes which should be applied to a series when series is hovered.
source code
 
getDataLabel(self)
@return
source code
 
setDataLabel(self, dataLabel)
Sets how point value should be formatted and displayed for each point.
source code
 
getColor(self)
@return
source code
 
setColor(self, color)
Sets color for the series.
source code

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 help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

setAllowPointSelect(self, allowPointSelect)

source code 

If the argument is true then the points of a can be selected otherwise not. Defaults to false, The point on a chart will toggle. Also, whenever a point is selected or deselected, the registered event listeners will be triggered.

@param allowPointSelect

setAnimation(self, animation)

source code 

If the argument is true then animation will be enabled when a series will be displayed otherwise not. Defaults to false.

@param animation

setEnableMouseTracking(self, enableMouseTracking)

source code 

If the argument is true then the mouse tracking will be enabled for a series otherwise not. Defaults to true.

@param enableMouseTracking

setShowInLegend(self, showInLegend)

source code 

If the argument is true then a series will be displayed in the legend otherwise not. Defaults to true.

@param showInLegend

setCursor(self, cursor)

source code 

Sets the cursor style. E.g. cursor can be set to css cursor style 'pointer', 'hand' or any other. Defaults to null.

@param cursor

setStacking(self, stacking)

source code 

Specifies whether the values of each series should be stacked on top of each other or not. Defaults to null. If the argument is null then the values of each series are not stacked.

@param stacking

setShowCheckbox(self, showCheckbox)

source code 

If the argument is true then a checkbox is displayed next to the legend item in the legend area. Defaults to false

@param showCheckbox

setVisible(self, visible)

source code 

If the argument is true then the series is visible otherwise not when a chart is rendered initially. Defaults to true However, this is not applicable for series related to Pie chart.

@param visible

Raises:
  • NotImplementedError - If this method is invoked on PieConfig

setShadow(self, shadow)

source code 

If the argument is true then a shadow will be shown to the graph line otherwise not. Defaults to true.

Parameters:
  • shadow
Raises:
  • NotImplementedError - If this method is invoked on PieConfig

setHoverState(self, state)

source code 

Sets attributes which should be applied to a series when series is hovered.

@param state

setDataLabel(self, dataLabel)

source code 

Sets how point value should be formatted and displayed for each point.

@param dataLabel

setColor(self, color)

source code 

Sets color for the series.

@param color