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

Class InvientChartsConfig

source code

object --+
         |
        InvientChartsConfig

This class encapsulates a number of configuration options for the InvientChars. These configuration options are Title, SubTitle , GeneralChartConfig, Credit, Legend, Tooltip , ChartLabel, SeriesConfig, XAxis and YAxis

All configuration properties which are of object type are initialized with an object instance.

These configuration options are static and generally set once. After a chart (InvientCharts) created, any changes made to the configuration options will not reflect in the chart. You would have to create a new chart InvientCharts

For some APIs, the description has been taken from http://www.highcharts.com/ref/


Authors:
Invient, Richard Lincoln
Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getInvientCharts(self) source code
 
setInvientCharts(self, invientCharts) source code
 
getChartLabel(self)
Returns: The ChartLabel object representing labels at arbitrary position in the chart.
source code
 
setChartLabel(self, chartLabel)
Sets the argument ChartLabel object only if it is non-null
source code
 
getXAxes(self)
Returns: Returns a collection of x-axis.
source code
 
setXAxes(self, xAxes)
Sets a collection of x-axis for the chart.
source code
 
addXAxes(self, xAxis)
Adds specified x-axis to the collection of x-axis.
source code
 
getYAxes(self)
Returns: Returns a collection of y-axis.
source code
 
setYAxes(self, yAxes)
Sets a collection of y-axis for the chart.
source code
 
addYAxes(self, yAxis)
Adds specified y-axis to the collection of y-axis.
source code
 
getTitle(self)
Returns: Returns Title object
source code
 
setTitle(self, title)
Sets the argument title only if the argument title is non-null
source code
 
getSubtitle(self)
Returns: Returns subtitle
source code
 
setSubtitle(self, subtitle)
Sets the argument subtitle only if the argument is non-null
source code
 
getTooltip(self)
Returns: Returns tooltip object associated with this class
source code
 
setTooltip(self, tooltip)
Sets Tooltip object only if the argument tooltip is non-null
source code
 
getLegend(self)
Returns: Returns legend object of the chart
source code
 
setLegend(self, legend)
Sets Legend object only if the argument legend is non-null
source code
 
getCredit(self)
Returns: Returns credit object of the chart
source code
 
setCredit(self, credit)
Sets the Credit object only if the argument credit is non-null
source code
 
getGeneralChartConfig(self)
Returns: Returns GeneralChartConfig object
source code
 
setGeneralChartConfig(self, generalChartConfig)
Sets GeneralChartConfig object only if the argument is non-null
source code
 
getSeriesConfig(self) source code
 
setSeriesConfig(self, seriesConfigs)
Sets a set of {@link SeriesConfig} objects only if the argument is non-null.
source code
 
addSeriesConfig(self, seriesConfig)
Adds the specified argument only if it is non-null.
source code

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

Class Methods [hide private]
 
getSeriesType(cls, seriesConfig)
Returns:
source code
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)

getChartLabel(self)

source code 
Returns:
The ChartLabel object representing labels at arbitrary position in the chart.

setChartLabel(self, chartLabel)

source code 

Sets the argument ChartLabel object only if it is non-null

Parameters:
  • chartLabel

getXAxes(self)

source code 
Returns:
Returns a collection of x-axis.

setXAxes(self, xAxes)

source code 

Sets a collection of x-axis for the chart. The collection of x-axis is set only if argument xAxes is non-null.

Parameters:
  • xAxes

addXAxes(self, xAxis)

source code 

Adds specified x-axis to the collection of x-axis.

Parameters:
  • xAxis
Returns:
Returns true if the x-axis is added successfully otherwise false

getYAxes(self)

source code 
Returns:
Returns a collection of y-axis.

setYAxes(self, yAxes)

source code 

Sets a collection of y-axis for the chart. The collection of y-axis is set only if argument yAxes is non-null

Parameters:
  • yAxes

addYAxes(self, yAxis)

source code 

Adds specified y-axis to the collection of y-axis.

Parameters:
  • yAxis
Returns:
Returns true if the y-axis is added successfully otherwise false

getTitle(self)

source code 
Returns:
Returns Title object

setTitle(self, title)

source code 

Sets the argument title only if the argument title is non-null

Parameters:
  • title

getSubtitle(self)

source code 
Returns:
Returns subtitle

setSubtitle(self, subtitle)

source code 

Sets the argument subtitle only if the argument is non-null

Parameters:
  • subtitle

getTooltip(self)

source code 
Returns:
Returns tooltip object associated with this class

setTooltip(self, tooltip)

source code 

Sets Tooltip object only if the argument tooltip is non-null

Parameters:
  • tooltip

getLegend(self)

source code 
Returns:
Returns legend object of the chart

setLegend(self, legend)

source code 

Sets Legend object only if the argument legend is non-null

Parameters:
  • legend

getCredit(self)

source code 
Returns:
Returns credit object of the chart

setCredit(self, credit)

source code 

Sets the Credit object only if the argument credit is non-null

Parameters:
  • credit

getGeneralChartConfig(self)

source code 
Returns:
Returns GeneralChartConfig object

setGeneralChartConfig(self, generalChartConfig)

source code 

Sets GeneralChartConfig object only if the argument is non-null

Parameters:
  • generalChartConfig

setSeriesConfig(self, seriesConfigs)

source code 

Sets a set of {@link SeriesConfig} objects only if the argument is non-null.

Parameters:
  • seriesConfigs

addSeriesConfig(self, seriesConfig)

source code 

Adds the specified argument only if it is non-null.

Parameters:
  • seriesConfig
Raises:
  • ValueError - if the argument is null

getSeriesType(cls, seriesConfig)
Class Method

source code 
Parameters:
  • seriesConfig