gwy.ColorAxis

Module gwy :: Class ColorAxis

[show private | hide private]

Class ColorAxis

Method Summary
	`__init__(orientation)` Creates a new color axis.
	`get_gradient()` Gets the color gradient a color axis uses.
	`get_labels_visible()` Gets the visibility of labels of a color axis.
	`get_range(min, max)` Gets the range of a color axis.
	`get_si_unit()` Gets the SI unit a color axis displays.
	`get_ticks_style()` Gets ticks style of a color axis.
	`set_gradient(gradient)` Sets the color gradient a color axis should use.
	`set_labels_visible(labels_visible)` Sets the visibility of labels of a color axis.
	`set_range(min, max)` Sets the range of a color axis.
	`set_si_unit(unit)` Sets the SI unit a color axis displays.
	`set_ticks_style(ticks_style)` Sets the ticks style of a color axis.

Method Details

init(orientation)
(Constructor)

Creates a new color axis.

Returns:: The newly created color axis as a GtkWidget.

get_gradient()

Gets the color gradient a color axis uses.

Returns:: The color gradient.

get_labels_visible()

Gets the visibility of labels of a color axis.

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

get_range(min, max)

Gets the range of a color axis.

Parameters:: min - Location to store the range maximum (or NULL). (float); max - Location to store the range minimum (or NULL). (float)

get_si_unit()

Gets the SI unit a color axis displays.

Returns:: The SI unit.

get_ticks_style()

Gets ticks style of a color axis.

Returns:: The ticks style.

set_gradient(gradient)

Sets the color gradient a color axis should use.

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

set_labels_visible(labels_visible)

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)

set_range(min, max)

Sets the range of a color axis.

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

set_si_unit(unit)

Sets the SI unit a color axis displays.

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

set_ticks_style(ticks_style)

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, (TicksStyle)

Generated by Epydoc 2.1 on Tue Dec 30 04:01:41 2008

http://epydoc.sf.net