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

Class AxisBase

source code

object --+    
         |    
      Axis --+
             |
            AxisBase

This class defines attributes common to X axis and Y axis. A chart can have one or more axis of each type.


Authors:
chirag, Richard Lincoln
See Also:
XAxis, YAxis
Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
getAllPlotBands(self) source code
 
setAllPlotBands(self, plotBands) source code
 
addPlotBand(self, plotBand) source code
 
removePlotBand(self, plotBand_or_id)
Removes a plotband with given id.
source code
 
getAllPlotLines(self) source code
 
setAllPlotLines(self, plotLines) source code
 
addPlotLine(self, plotLine) source code
 
removePlotLine(self, plotLine_or_id) source code
 
getId(self) source code
 
setId(self, Id)
Sets an id for the axis
source code
 
getTick(self) source code
 
setTick(self, tick)
Sets tick for the axis
source code
 
getMaxZoom(self) source code
 
setMaxZoom(self, maxZoom)
Sets maximum amount of zoom for this axis.
source code
 
getReversed(self) source code
 
setReversed(self, r)
If the argument it true then this axis will be reversed.
source code
 
getOpposite(self) source code
 
setOpposite(self, opposite)
If the argument is true then another axis on the opposite side of this axis will be displayed.
source code
 
getType(self) source code
 
setType(self, typ)
Sets type of this axis.
source code
 
getTitle(self) source code
 
setTitle(self, title)
Sets title for the axis
source code
 
getLabel(self) source code
 
setLabel(self, label) source code
 
getAlternateGridColor(self) source code
 
setAlternateGridColor(self, alternateGridColor)
Sets a color to be used for alternate grids of the chart
source code
 
getEndOnTick(self) source code
 
setEndOnTick(self, endOnTick)
If the argument is true then this axis will end on a tick.
source code
 
getGrid(self) source code
 
setGrid(self, grid)
Sets grid for this axis
source code
 
getLineColor(self) source code
 
setLineColor(self, lineColor)
Sets a color for line of this axis.
source code
 
getLineWidth(self) source code
 
setLineWidth(self, lineWidth)
Sets width of this axis line
source code
 
getLinkedTo(self) source code
 
setLinkedTo(self, linkedTo)
Sets another axis which is linked with this axis.
source code
 
getMaxPadding(self) source code
 
setMaxPadding(self, maxPadding) source code
 
getMinPadding(self) source code
 
setMinPadding(self, minPadding) source code
 
getMinorGrid(self) source code
 
setMinorGrid(self, minorGrid) source code
 
getMinorTick(self) source code
 
setMinorTick(self, minorTick) source code
 
getOffset(self) source code
 
setOffset(self, offset)
Sets distance of this axis from the plot area
source code
 
getShowFirstLabel(self) source code
 
setShowFirstLabel(self, showFirstLabel)
If the argument is true then the label of this axis' first tick will be displayed.
source code
 
getShowLastLabel(self) source code
 
setShowLastLabel(self, showLastLabel)
If the argument is true then the label of this axis' last tick will be displayed.
source code
 
getStartOfWeek(self) source code
 
setStartOfWeek(self, startOfWeek)
Sets a day to be considered as start of the week.
source code
 
getStartOnTick(self) source code
 
setStartOnTick(self, startOnTick)
If the argument is true then this axis must start on a tick.
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 x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

getId(self)

source code 
Overrides: Axis.getId

setId(self, Id)

source code 

Sets an id for the axis

Overrides: Axis.setId

getTick(self)

source code 
Overrides: Axis.getTick

setTick(self, tick)

source code 

Sets tick for the axis

Overrides: Axis.setTick

getMaxZoom(self)

source code 
Overrides: Axis.getMaxZoom

setMaxZoom(self, maxZoom)

source code 

Sets maximum amount of zoom for this axis. For datetime axis, the maxZoom must be specified in milliseconds. For example, for a datetime axis the main unit is milliseconds. If maxZoom is set to 3600000, you can't zoom in more than to one hour. (Above example is taken from Highcharts documentation)

Overrides: Axis.setMaxZoom

getReversed(self)

source code 
Overrides: Axis.getReversed

setReversed(self, r)

source code 

If the argument it true then this axis will be reversed. Defaults to false.

Overrides: Axis.setReversed

getOpposite(self)

source code 
Overrides: Axis.getOpposite

setOpposite(self, opposite)

source code 

If the argument is true then another axis on the opposite side of this axis will be displayed. The normal axis is on left side for vertical axes and bottom for horzontal axes.

Overrides: Axis.setOpposite

getType(self)

source code 
Overrides: Axis.getType

setType(self, typ)

source code 

Sets type of this axis. Used by subclasses

getTitle(self)

source code 
Overrides: Axis.getTitle

setTitle(self, title)

source code 

Sets title for the axis

Overrides: Axis.setTitle

See Also: AxisTitle

getAlternateGridColor(self)

source code 
Overrides: Axis.getAlternateGridColor

setAlternateGridColor(self, alternateGridColor)

source code 

Sets a color to be used for alternate grids of the chart

Overrides: Axis.setAlternateGridColor

getEndOnTick(self)

source code 
Overrides: Axis.getEndOnTick

setEndOnTick(self, endOnTick)

source code 

If the argument is true then this axis will end on a tick.

Overrides: Axis.setEndOnTick

getGrid(self)

source code 
Overrides: Axis.getGrid

setGrid(self, grid)

source code 

Sets grid for this axis

Overrides: Axis.setGrid

See Also: Grid

getLineColor(self)

source code 
Overrides: Axis.getLineColor

setLineColor(self, lineColor)

source code 

Sets a color for line of this axis. This line indicate this axis

Overrides: Axis.setLineColor

getLineWidth(self)

source code 
Overrides: Axis.getLineWidth

setLineWidth(self, lineWidth)

source code 

Sets width of this axis line

Overrides: Axis.setLineWidth

getLinkedTo(self)

source code 
Overrides: Axis.getLinkedTo

setLinkedTo(self, linkedTo)

source code 

Sets another axis which is linked with this axis. The following description is copied from Highcharts API documentation http://www.highcharts.com/ref/#xAxis.

When an axis is linked to a master axis, it will take the same extremes as the master, but as assigned by min or max or by setExtremes. It can be used to show additional info, or to ease reading the chart by duplicating the scales. Defaults to null.

Overrides: Axis.setLinkedTo

getMaxPadding(self)

source code 
Overrides: Axis.getMaxPadding

setMaxPadding(self, maxPadding)

source code 
Overrides: Axis.setMaxPadding

getMinPadding(self)

source code 
Overrides: Axis.getMinPadding

setMinPadding(self, minPadding)

source code 
Overrides: Axis.setMinPadding

getMinorGrid(self)

source code 
Overrides: Axis.getMinorGrid

setMinorGrid(self, minorGrid)

source code 
Overrides: Axis.setMinorGrid

getMinorTick(self)

source code 
Overrides: Axis.getMinorTick

setMinorTick(self, minorTick)

source code 
Overrides: Axis.setMinorTick

getOffset(self)

source code 
Overrides: Axis.getOffset

setOffset(self, offset)

source code 

Sets distance of this axis from the plot area

Overrides: Axis.setOffset

getShowFirstLabel(self)

source code 
Overrides: Axis.getShowFirstLabel

setShowFirstLabel(self, showFirstLabel)

source code 

If the argument is true then the label of this axis' first tick will be displayed. Defaults to true.

Overrides: Axis.setShowFirstLabel

getShowLastLabel(self)

source code 
Overrides: Axis.getShowLastLabel

setShowLastLabel(self, showLastLabel)

source code 

If the argument is true then the label of this axis' last tick will be displayed. Defaults to false

Overrides: Axis.setShowLastLabel

getStartOfWeek(self)

source code 
Overrides: Axis.getStartOfWeek

setStartOfWeek(self, startOfWeek)

source code 

Sets a day to be considered as start of the week. For datetime axis, this decides where to put tick. e.g. if startOfWeek = THURSDAY then tick will be placed on every thursday.

Overrides: Axis.setStartOfWeek

getStartOnTick(self)

source code 
Overrides: Axis.getStartOnTick

setStartOnTick(self, startOnTick)

source code 

If the argument is true then this axis must start on a tick. Defaults to false.

Overrides: Axis.setStartOnTick