gwy.LayerBasic

Module gwy :: Class LayerBasic

[show private | hide private]

Class LayerBasic

LayerBasic The ::presentation-switched signal is emitted when the presentation state changes, that is when a layer which displayed data directly starts displaying a presentation, or conversely when it stops displaying a presentation.

('gwydataview', ' The #GwyLayerBasic which received the signal. ')

Method Summary
	`__init__()` Creates a new basic data displaying layer.
	`get_gradient_key()` Gets key identifying color gradient.
	`get_has_presentation()` Tests whether a basic layer displays a presentation instead of the data.
	`get_min_max_key()` Gets prefix identifying fixed range minimum and maximum.
	`get_presentation_key()` Gets the key identifying data field this pixmap layer actually displays.
	`get_range(min, max)` Gets the range colors are mapped from in current mode.
	`get_range_type()` Gets the current color mapping mode.
	`get_range_type_key()` Gets key identifying color range mapping type.
	`set_gradient_key(key)` Sets the container key of the colour gradient to use to visualize data.
	`set_min_max_key(prefix)` Sets basic layer fixed range minimum and maximum.
	`set_presentation_key(key)` Sets the container key of the data field to actually display by a basic layer.
	`set_range_type_key(key)` Sets the container key of the color range mapping type to use to visualize data.

Method Details

init()
(Constructor)

Creates a new basic data displaying layer.

Returns:: The newly created layer.

get_gradient_key()

Gets key identifying color gradient.

Returns:: The string key, or NULL if it isn't set.

get_has_presentation()

Tests whether a basic layer displays a presentation instead of the data.

Returns:: True if the layer has a presentation, False it it displays the data.

get_min_max_key()

Gets prefix identifying fixed range minimum and maximum.

Returns:: The prefix, or NULL if it isn't set.

get_presentation_key()

Gets the key identifying data field this pixmap layer actually displays.

See LayerBasic.set_presentation_key() for details.

Returns:: The string key, or NULL if it isn't set.

get_range(min, max)

Gets the range colors are mapped from in current mode.

This function does not take presentations into account. It always returns ther range corresponding to the underlying data even if a presentation is shown instead.

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

get_range_type()

Gets the current color mapping mode.

Returns:: The current color mapping mode.
Since: 2.7

get_range_type_key()

Gets key identifying color range mapping type.

Returns:: The string key, or NULL if it isn't set.

set_gradient_key(key)

Sets the container key of the colour gradient to use to visualize data.

Parameters:: key - Container string key identifying the color gradient to use. (string)

set_min_max_key(prefix)

Sets basic layer fixed range minimum and maximum.

Parameters:: prefix - Prefix of keys identifying minimum and maximum values for fixed range, "/min" and "/max" is appended to it to get the individual minimum and maximum keys. (string)

set_presentation_key(key)

Sets the container key of the data field to actually display by a basic layer.

The data field set with PixmapLayer.get_data_key() is used to obtain values, it determines physical dimensions, etc. When a data field is set with this method, it is displayed instead of the actual data.

Parameters:: key - Container string key identifying the data field to actually display. (string)

set_range_type_key(key)

Sets the container key of the color range mapping type to use to visualize data.

Parameters:: key - Container string key identifying the range type to use. (string)

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

http://epydoc.sf.net