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

Class TitleBase

source code

object --+
         |
        TitleBase
Known Subclasses:

A chart has a title and a subtitle. This class defines attributes which are common to both.

The text of a title can be plain text or html text containing html elements. It is also possible to apply css to the title. The css must be valid css string e.g. { color: 'red' }


Authors:
Invient, Richard Lincoln
See Also:
Title, SubTitle, HorzAlign, VertAlign
Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getAlign(self) source code
 
setAlign(self, align)
Sets horizontal alignment of the title.
source code
 
getVertAlign(self) source code
 
setVertAlign(self, vertAlign)
Sets horizontal alignment of the title.
source code
 
getFloating(self) source code
 
setFloating(self, floating)
If the argument is true then the plot area will not move to make space for the chart title.
source code
 
getText(self) source code
 
setText(self, text)
Sets text for the chart's title.
source code
 
getX(self) source code
 
setX(self, x)
Sets x position (in pixel) of the title relative to the alignment within Spacing.left and Spacing.right.
source code
 
getY(self) source code
 
setY(self, y)
Sets y position (in pixel) of the title relative to the alignment within Spacing.top and Spacing.bottom.
source code
 
getStyle(self) source code
 
setStyle(self, style)
Sets css for the title.
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)

setAlign(self, align)

source code 

Sets horizontal alignment of the title. Defaults to HorzAlign.CENTER

setVertAlign(self, vertAlign)

source code 

Sets horizontal alignment of the title. Defaults to VertAlign.TOP

setFloating(self, floating)

source code 

If the argument is true then the plot area will not move to make space for the chart title. Defaults to false.

setText(self, text)

source code 

Sets text for the chart's title. The text can be plain or html string.

setX(self, x)

source code 

Sets x position (in pixel) of the title relative to the alignment within Spacing.left and Spacing.right. Defaults to 0

setY(self, y)

source code 

Sets y position (in pixel) of the title relative to the alignment within Spacing.top and Spacing.bottom. Defaults to 0

setStyle(self, style)

source code 
Sets css for the title. The css must be a valid css object. e.g. css
string "{ color:'red' }" is valid but "{ color: 'red'" is invalid.