Trees       Indices       Help   
Module gwy :: Class ColorAxis
[hide private]
[frames] | no frames]

Class ColorAxis

source code

Instance Methods [hide private]
 
__init__(orientation)
Creates a new color axis.		 source code
 
get_range()
Gets the range of a color axis.		 source code
 
set_range(min, max)
Sets the range of a color axis.		 source code
 
get_si_unit()
Gets the SI unit a color axis displays.		 source code
 
set_si_unit(unit)
Sets the SI unit a color axis displays.		 source code
 
set_gradient(gradient)
Sets the color gradient a color axis should use.		 source code
 
get_gradient()
Gets the color gradient a color axis uses.		 source code
 
get_ticks_style()
Gets ticks style of a color axis.		 source code
 
set_ticks_style(ticks_style)
Sets the ticks style of a color axis.		 source code
 
get_labels_visible()
Gets the visibility of labels of a color axis.		 source code
 
set_labels_visible(labels_visible)
Sets the visibility of labels of a color axis.		 source code
Method Details [hide private]

__init__(orientation)
(Constructor)

source code 

Creates a new color axis.

Parameters:
  • orientation - The orientation of the axis. (GtkOrientation)
Returns:
The newly created color axis as a GtkWidget. (gtk.Widget)

get_range()

source code 

Gets the range of a color axis.

Returns:
Tuple consisting of 2 values (min, max). ((float), (float))

set_range(min, max)

source code 

Sets the range of a color axis.

Parameters:
  • min - The range minimum. (float)
  • max - The range maximum. (float)

get_si_unit()

source code 

Gets the SI unit a color axis displays.

Returns:
The SI unit. (SIUnit)

set_si_unit(unit)

source code 

Sets the SI unit a color axis displays.

Parameters:
  • unit - A SI unit to display next to minimum and maximum value. (SIUnit)

set_gradient(gradient)

source code 

Sets the color gradient a color axis should use.

Parameters:
  • gradient - Name of gradient axis should use. It should exist. (string)

get_gradient()

source code 

Gets the color gradient a color axis uses.

Returns:
The color gradient. (string)

get_ticks_style()

source code 

Gets ticks style of a color axis.

Returns:
The ticks style. (TicksStyle)

set_ticks_style(ticks_style)

source code 

Sets the ticks style of a color axis.

Parameters:
  • ticks_style - The ticks style to use. Expected values: TICKS_STYLE_NONE, TICKS_STYLE_CENTER, TICKS_STYLE_AUTO, TICKS_STYLE_UNLABELED, TICKS_STYLE_UNLABELLED. (TicksStyle)

get_labels_visible()

source code 

Gets the visibility of labels of a color axis.

Returns:
True if labels are displayed, False if they are omitted. (bool)

set_labels_visible(labels_visible)

source code 

Sets the visibility of labels of a color axis.

Parameters:
  • labels_visible - True to display labels with minimum and maximum values, False to display no labels. (bool)

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 http://epydoc.sourceforge.net