GwyLayerBasic

GwyLayerBasic — Display data colored with a gradient

Synopsis




            GwyLayerBasic;
            GwyLayerBasicClass;
GwyPixmapLayer* gwy_layer_basic_new         (void);
void        gwy_layer_basic_get_range       (GwyLayerBasic *basic_layer,
                                             gdouble *min,
                                             gdouble *max);
void        gwy_layer_basic_set_gradient_key
                                            (GwyLayerBasic *basic_layer,
                                             const gchar *key);
const gchar* gwy_layer_basic_get_gradient_key
                                            (GwyLayerBasic *basic_layer);
void        gwy_layer_basic_set_min_max_key (GwyLayerBasic *basic_layer,
                                             const gchar *prefix);
const gchar* gwy_layer_basic_get_min_max_key
                                            (GwyLayerBasic *basic_layer);
void        gwy_layer_basic_set_range_type_key
                                            (GwyLayerBasic *basic_layer,
                                             const gchar *key);
const gchar* gwy_layer_basic_get_range_type_key
                                            (GwyLayerBasic *basic_layer);

Object Hierarchy


  GObject
   +----GtkObject
         +----GwyDataViewLayer
               +----GwyPixmapLayer
                     +----GwyLayerBasic

Properties


  "gradient-key"         gchararray            : Read / Write
  "min-max-key"          gchararray            : Read / Write
  "range-type-key"       gchararray            : Read / Write

Description

Details

GwyLayerBasic

typedef struct _GwyLayerBasic GwyLayerBasic;


GwyLayerBasicClass

typedef struct {
    GwyPixmapLayerClass parent_class;

    gpointer reserved1;
    gpointer reserved2;
} GwyLayerBasicClass;


gwy_layer_basic_new ()

GwyPixmapLayer* gwy_layer_basic_new         (void);

Creates a new basic data displaying layer.

Returns : The newly created layer.

gwy_layer_basic_get_range ()

void        gwy_layer_basic_get_range       (GwyLayerBasic *basic_layer,
                                             gdouble *min,
                                             gdouble *max);

Gets the range colors are mapped from in current mode.

basic_layer : A basic data view layer.
min : Location to store range minimum to.
max : Location to store range maximum to.

gwy_layer_basic_set_gradient_key ()

void        gwy_layer_basic_set_gradient_key
                                            (GwyLayerBasic *basic_layer,
                                             const gchar *key);

Sets the gradient to use to visualize data.

basic_layer : A basic data view layer.
key : Container string key identifying the color gradient to use.

gwy_layer_basic_get_gradient_key ()

const gchar* gwy_layer_basic_get_gradient_key
                                            (GwyLayerBasic *basic_layer);

Gets key identifying color gradient.

basic_layer : A basic data view layer.
Returns : The string key, or NULL if it isn't set.

gwy_layer_basic_set_min_max_key ()

void        gwy_layer_basic_set_min_max_key (GwyLayerBasic *basic_layer,
                                             const gchar *prefix);

Sets basic layer fixed range minimum and maximum.

basic_layer : A basic data view layer.
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.

gwy_layer_basic_get_min_max_key ()

const gchar* gwy_layer_basic_get_min_max_key
                                            (GwyLayerBasic *basic_layer);

Gets prefix identifying fixed range minimum and maximum.

basic_layer : A basic data view layer.
Returns : The prefix, or NULL if it isn't set.

gwy_layer_basic_set_range_type_key ()

void        gwy_layer_basic_set_range_type_key
                                            (GwyLayerBasic *basic_layer,
                                             const gchar *key);

Sets the color range mapping type to use to visualize data.

basic_layer : A basic data view layer.
key : Container string key identifying the range type to use.

gwy_layer_basic_get_range_type_key ()

const gchar* gwy_layer_basic_get_range_type_key
                                            (GwyLayerBasic *basic_layer);

Gets key identifying color range mapping type.

basic_layer : A basic data view layer.
Returns : The string key, or NULL if it isn't set.

Properties

The "gradient-key" property

  "gradient-key"         gchararray            : Read / Write

The :gradient-key property is the container key used to identify GwyGradient data is colored with.

Default value: NULL


The "min-max-key" property

  "min-max-key"          gchararray            : Read / Write

The :min-max-key property is the container key prefix used to identify fixed range minimum and maximum.

Default value: NULL


The "range-type-key" property

  "range-type-key"       gchararray            : Read / Write

The :range-type-key property is the container key used to identify color range type.

Default value: NULL