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

Class PieConfig

source code

  object --+    
           |    
SeriesConfig --+
               |
              PieConfig

This class contains configuration options for pie series.


Authors:
Invient, Richard Lincoln
Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getCenterX(self)
Returns: Returns x position (in pixel) of the center of the pie chart relative to the plot area.
source code
 
setCenterX(self, centerX)
Sets x position (in pixel) of the center of the pie chart relative to the plot area.
source code
 
getCenterY(self)
Returns: Returns y position (in pixel) of the center of the pie chart relative to the plot area.
source code
 
setCenterY(self, centerY)
Sets y position (in pixel) of the center of the pie chart relative to the plot area.
source code
 
getBorderColor(self)
Returns: Returns color of border surrounding each slice.
source code
 
setBorderColor(self, borderColor)
Sets color of border surrounding each slice.
source code
 
getBorderWidth(self)
Returns: Returns width of the border surrounding each slice.
source code
 
setBorderWidth(self, borderWidth)
Sets width of border surrounding each slice.
source code
 
getInnerSize(self)
Returns: Returns size of the inner diameter of the pie.
source code
 
setInnerSize(self, innerSize)
Sets the size of the inner diameter for the pie.
source code
 
getSize(self)
Returns: Returns size of diameter of the pie relative to the plot area.
source code
 
setSize(self, size)
Sets size of diameter of the pie relative to the plot area.
source code
 
getSlicedOffset(self)
Returns: Returns offset in pixel by which a slice should be moved out from the center.
source code
 
setSlicedOffset(self, slicedOffset)
Sets offset in pixel by which a slice should be moved out from the center.
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
 
setShadow(self, shadow)
If the argument is true then a shadow will be shown to the graph line otherwise not.
source code
 
getVisible(self)
Returns: Returns null as pie does not support toggle (show/hide pie) feature.
source code
 
getShadow(self)
Returns: Returns null as pie series does not support shadow.
source code
 
setDataLabel(self, dataLabel)
Sets an object of PieDataLabel which contains configuration for formatting data labels.
source code
 
getDataLabel(self)
@return
source code
 
setHoverState(self, state)
Sets state which should be applied to a slice when a mouse is over the slice
source code
 
getHoverState(self)
@return
source code

Inherited from SeriesConfig: getAllowPointSelect, getAnimation, getColor, getCursor, getEnableMouseTracking, getShowCheckbox, getShowInLegend, getStacking, setAllowPointSelect, setAnimation, setColor, setCursor, setEnableMouseTracking, setShowCheckbox, setShowInLegend, setStacking

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)

getCenterX(self)

source code 
Returns:
Returns x position (in pixel) of the center of the pie chart relative to the plot area.

setCenterX(self, centerX)

source code 

Sets x position (in pixel) of the center of the pie chart relative to the plot area.

@param centerX

getCenterY(self)

source code 
Returns:
Returns y position (in pixel) of the center of the pie chart relative to the plot area.

setCenterY(self, centerY)

source code 

Sets y position (in pixel) of the center of the pie chart relative to the plot area.

@param centerY

getBorderColor(self)

source code 
Returns:
Returns color of border surrounding each slice.

setBorderColor(self, borderColor)

source code 

Sets color of border surrounding each slice.

@param borderColor

getBorderWidth(self)

source code 
Returns:
Returns width of the border surrounding each slice.

setBorderWidth(self, borderWidth)

source code 

Sets width of border surrounding each slice.

@param borderWidth

getInnerSize(self)

source code 
Returns:
Returns size of the inner diameter of the pie.

setInnerSize(self, innerSize)

source code 

Sets the size of the inner diameter for the pie. Any value greater than 0 renders a donut chart.

@param innerSize

getSize(self)

source code 
Returns:
Returns size of diameter of the pie relative to the plot area.

setSize(self, size)

source code 

Sets size of diameter of the pie relative to the plot area.

@param size

getSlicedOffset(self)

source code 
Returns:
Returns offset in pixel by which a slice should be moved out from the center.

setSlicedOffset(self, slicedOffset)

source code 

Sets offset in pixel by which a slice should be moved out from the center.

@param slicedOffset

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 - Pie chart does not support visible property so this method throws an exception if invoked.
Overrides: SeriesConfig.setVisible

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 - Pie chart does not support shadow property so this method throws an exception if invoked.
Overrides: SeriesConfig.setShadow

getVisible(self)

source code 

@return

Returns:
Returns null as pie does not support toggle (show/hide pie) feature.
Overrides: SeriesConfig.getVisible

getShadow(self)

source code 

@return

Returns:
Returns null as pie series does not support shadow.
Overrides: SeriesConfig.getShadow

setDataLabel(self, dataLabel)

source code 

Sets an object of PieDataLabel which contains configuration for formatting data labels.

@param dataLabel

Overrides: SeriesConfig.setDataLabel

getDataLabel(self)

source code 

@return

Overrides: SeriesConfig.getDataLabel
(inherited documentation)

setHoverState(self, state)

source code 

Sets state which should be applied to a slice when a mouse is over the slice

@param state

Overrides: SeriesConfig.setHoverState

getHoverState(self)

source code 

@return

Overrides: SeriesConfig.getHoverState
(inherited documentation)