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

Class LayerBasic

source code

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

__init__()
(Constructor)

source code 

Creates a new basic data displaying layer.

Returns:
The newly created layer. (PixmapLayer)

get_range()

source code 

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.

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

get_range_type()

source code 

Gets the current color mapping mode.

Returns:
The current color mapping mode. (LayerBasicRangeType)

Since: 2.7

set_gradient_key(key)

source code 

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)

get_gradient_key()

source code 

Gets key identifying color gradient.

Returns:
The string key, or None if it isn't set. (string)

set_presentation_key(key)

source code 

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)

get_presentation_key()

source code 

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

See LayerBasic.set_presentation_key() for details.

Returns:
The string key, or None if it isn't set. (string)

get_has_presentation()

source code 

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. (bool)

set_min_max_key(prefix)

source code 

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)

get_min_max_key()

source code 

Gets prefix identifying fixed range minimum and maximum.

Returns:
The prefix, or None if it isn't set. (string)

set_range_type_key(key)

source code 

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)

get_range_type_key()

source code 

Gets key identifying color range mapping type.

Returns:
The string key, or None if it isn't set. (string)

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