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

Class GeneralChartConfig

source code

object --+
         |
        GeneralChartConfig

This class contains configuration properties at a chart level.


Authors:
Invient, Richard Lincoln
Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getAlignTicks(self)
Returns: align ticks
source code
 
setAlignTicks(self, alignTicks)
When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks.
source code
 
getAnimation(self)
Returns: animation
source code
 
setAnimation(self, animation)
Set the overall animation for all chart updating.
source code
 
getClassName(self)
@return
source code
 
setClassName(self, className)
A CSS class name to apply to the charts container
source code
 
getPlot(self)
Returns: Returns plot object representing chart's drawing area
source code
 
setPlot(self, plot)
Sets plot object
source code
 
getReflow(self)
Returns:
source code
 
setReflow(self, reflow)
A value of true indicates that the chart will fit the width of the charts container otherwise not.
source code
 
getShadow(self)
Returns:
source code
 
setShadow(self, shadow)
A value of true indicates that the drop shadow will apply to the outer chart area otherwise not.
source code
 
getStyle(self)
Returns:
source code
 
setStyle(self, style)
A CSS string to apply to the charts container
source code
 
getBackgroundColor(self)
Returns:
source code
 
setBackgroundColor(self, backgroundColor)
Sets the background color for the outer chart area
source code
 
getBorderColor(self)
@return
source code
 
setBorderColor(self, borderColor)
Sets the border color for the outer chart border
source code
 
getBorderRadius(self)
@return
source code
 
setBorderRadius(self, borderRadius)
Sets radius for the outer chart border
source code
 
getBorderWidth(self)
@return
source code
 
setBorderWidth(self, borderWidth)
Sets pixel width of the outer chart border
source code
 
getHeight(self)
@return
source code
 
setHeight(self, height)
Sets height for the chart
source code
 
getWidth(self)
@return
source code
 
setWidth(self, width)
Sets width for the chart
source code
 
getIgnoreHiddenSeries(self)
@return
source code
 
setIgnoreHiddenSeries(self, ignoreHiddenSeries)
If the argument is true, the axes will scale to the remaining visible series once one series is hidden.
source code
 
getInverted(self)
@return
source code
 
setInverted(self, inverted)
If the argument is true then the x-axis is reversed.
source code
 
getMargin(self)
@return
source code
 
setMargin(self, margin)
@param margin
source code
 
getShowAxes(self)
@return
source code
 
setShowAxes(self, showAxes)
If the argument is true then the axes will be shown initially.
source code
 
getSpacing(self)
@return
source code
 
setSpacing(self, spacing)
@param spacing
source code
 
getType(self)
@return
source code
 
setType(self, typ)
Sets series type to one of line, spline, scatter, area, areaspline, pie, bar and column.
source code
 
getZoomType(self)
@return
source code
 
setZoomType(self, zoomType)
Sets zoom type.
source code
 
isClientZoom(self)
@return
source code
 
setClientZoom(self, clientZoom)
If the argument is true then the scaling will happen on client.
source code
 
__str__(self)
str(x)
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __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)

getAlignTicks(self)

source code 
Returns:
align ticks

setAlignTicks(self, alignTicks)

source code 

When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks. This can be prevented by setting alignTicks to false.

Parameters:
  • alignTicks

getAnimation(self)

source code 
Returns:
animation

setAnimation(self, animation)

source code 

Set the overall animation for all chart updating.

Parameters:
  • animation

setClassName(self, className)

source code 

A CSS class name to apply to the charts container

Parameters:
  • className

getPlot(self)

source code 
Returns:
Returns plot object representing chart's drawing area

setPlot(self, plot)

source code 

Sets plot object

Parameters:
  • plot

getReflow(self)

source code 

setReflow(self, reflow)

source code 

A value of true indicates that the chart will fit the width of the charts container otherwise not.

Parameters:
  • reflow

getShadow(self)

source code 

setShadow(self, shadow)

source code 

A value of true indicates that the drop shadow will apply to the outer chart area otherwise not.

Parameters:
  • shadow

getStyle(self)

source code 

setStyle(self, style)

source code 

A CSS string to apply to the charts container

Parameters:
  • style

getBackgroundColor(self)

source code 

setBackgroundColor(self, backgroundColor)

source code 

Sets the background color for the outer chart area

@param backgroundColor

setBorderColor(self, borderColor)

source code 

Sets the border color for the outer chart border

@param borderColor

setBorderRadius(self, borderRadius)

source code 

Sets radius for the outer chart border

@param borderRadius

setBorderWidth(self, borderWidth)

source code 

Sets pixel width of the outer chart border

@param borderWidth

setHeight(self, height)

source code 

Sets height for the chart

@param height

setWidth(self, width)

source code 

Sets width for the chart

@param width

setIgnoreHiddenSeries(self, ignoreHiddenSeries)

source code 

If the argument is true, the axes will scale to the remaining visible series once one series is hidden. If the argument is false, hiding and showing a series will not affect the axes or the other series.

@param ignoreHiddenSeries

setInverted(self, inverted)

source code 

If the argument is true then the x-axis is reversed. If a bar plot is present, it will be inverted automatically.

@param inverted

setShowAxes(self, showAxes)

source code 

If the argument is true then the axes will be shown initially. This is useful when the chart is empty and axes must be shown.

@param showAxes

setType(self, typ)

source code 

Sets series type to one of line, spline, scatter, area, areaspline, pie, bar and column.

@param typ

setZoomType(self, zoomType)

source code 

Sets zoom type. It decides how a chart can be zoomed by dragging the mouse.

@param zoomType

setClientZoom(self, clientZoom)

source code 

If the argument is true then the scaling will happen on client. If the argument is false then the chart will not scale. In any case, the server will receive event notification if registered.

@param clientZoom

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)