GogSeries

GogSeries — A single data series.

Functions

gboolean gog_series_is_valid ()
gboolean gog_series_has_legend ()
GOData * gog_series_get_name ()
GogPlot * gog_series_get_plot ()
void gog_series_set_name ()
void gog_series_set_dim ()
void gog_series_set_index ()
unsigned gog_series_num_elements ()
GList const * gog_series_get_overrides ()
GogSeriesFillType gog_series_get_fill_type ()
GogSeriesFillType gog_series_get_fill_type_from_combo ()
unsigned gog_series_get_xy_data ()
unsigned gog_series_get_xyz_data ()
void gog_series_lines_use_markers ()
void gog_series_populate_fill_type_combo ()
void gog_series_set_fill_type ()
GogDataset * gog_series_get_interpolation_params ()
void gog_series_lines_stroke ()

Properties

gchar * fill-type Read / Write
gboolean has-legend Read / Write
gchar * interpolation Read / Write
gboolean interpolation-skip-invalid Read / Write
gint index Read / Write

Types and Values

  GogSeries
enum GogSeriesFillType
#define GOG_SERIES_ACCEPT_TREND_LINE

Object Hierarchy

    GObject
    ╰── GogObject
        ╰── GogStyledObject
            ├── GogSeries
            ╰── GogSeriesElement

Implemented Interfaces

GogSeries implements GOStyledObject and GogDataset.

Description

A GogSeries represents a data series that can be added to a GogPlot.

Functions

gog_series_is_valid ()

gboolean
gog_series_is_valid (GogSeries const *series);

Parameters

series

GogSeries

  

Returns

the current cached validity. Does not recheck

gog_series_has_legend ()

gboolean
gog_series_has_legend (GogSeries const *series);

Parameters

series

GogSeries

  

Returns

TRUE if the series has a visible legend entry

gog_series_get_name ()

GOData *
gog_series_get_name (GogSeries const *series);

Gets the _source_ of the name associated with the series. NOTE : this is _NOT_ the actual name.

Parameters

series

a GogSeries

  

Returns

a GODataScalar, without added reference.

gog_series_get_plot ()

GogPlot *
gog_series_get_plot (GogSeries const *series);

Parameters

series

GogSeries

  

Returns

the possibly NULL plot that contains this series.

gog_series_set_name ()

void
gog_series_set_name (GogSeries *series,
                     GODataScalar *name_src,
                     GError **err);

Absorbs a ref to name_src .

Parameters

series

a GogSeries

  

name_src

a GODataScalar

  

err

a GError

  

gog_series_set_dim ()

void
gog_series_set_dim (GogSeries *series,
                    int dim_i,
                    GOData *val,
                    GError **err);

Absorbs a ref to val

Parameters

series

GogSeries

  

dim_i

Which dimension

  

val

GOData

  

err

optional GError pointer

  

gog_series_set_index ()

void
gog_series_set_index (GogSeries *series,
                      int ind,
                      gboolean is_manual);

If ind >= 0 attempt to assign the new index. Auto indicies (is_manual == FALSE) will not override the current index if it is manual. An index < 0, will reset the index to automatic and potentially queue a revaluation of the parent chart's cardinality.

Parameters

series

GogSeries

  

ind

= 0 assigns a new index, < 0 resets to auto

  

is_manual

gboolean

  

gog_series_num_elements ()

unsigned
gog_series_num_elements (GogSeries const *series);

Parameters

series

GogSeries

  

Returns

the number of elements in the series

gog_series_get_overrides ()

GList const  	 *
gog_series_get_overrides (GogSeries const *series);

gog_series_get_fill_type ()

GogSeriesFillType
gog_series_get_fill_type (GogSeries const *series);

gog_series_get_fill_type_from_combo ()

GogSeriesFillType
gog_series_get_fill_type_from_combo (GogSeries const *series,
                                     GtkComboBox *combo);

gog_series_get_xy_data ()

unsigned
gog_series_get_xy_data (GogSeries const *series,
                        double const **x,
                        double const **y);

gog_series_get_xyz_data ()

unsigned
gog_series_get_xyz_data (GogSeries const *series,
                         double const **x,
                         double const **y,
                         double const **z);

gog_series_lines_use_markers ()

void
gog_series_lines_use_markers (GogSeriesLines *lines,
                              gboolean use_markers);

gog_series_populate_fill_type_combo ()

void
gog_series_populate_fill_type_combo (GogSeries const *series,
                                     GtkComboBox *combo);

gog_series_set_fill_type ()

void
gog_series_set_fill_type (GogSeries *series,
                          GogSeriesFillType fill_type);

gog_series_get_interpolation_params ()

GogDataset *
gog_series_get_interpolation_params (GogSeries const *series);

gog_series_lines_stroke ()

void
gog_series_lines_stroke (GogSeriesLines *lines,
                         GogRenderer *rend,
                         GogViewAllocation const *bbox,
                         GOPath *path,
                         gboolean invert);

Types and Values

GogSeries

typedef struct _GogSeries GogSeries;

enum GogSeriesFillType

Members

GOG_SERIES_FILL_TYPE_Y_ORIGIN

    

GOG_SERIES_FILL_TYPE_X_ORIGIN

    

GOG_SERIES_FILL_TYPE_BOTTOM

    

GOG_SERIES_FILL_TYPE_LEFT

    

GOG_SERIES_FILL_TYPE_TOP

    

GOG_SERIES_FILL_TYPE_RIGHT

    

GOG_SERIES_FILL_TYPE_ORIGIN

    

GOG_SERIES_FILL_TYPE_CENTER

    

GOG_SERIES_FILL_TYPE_EDGE

    

GOG_SERIES_FILL_TYPE_SELF

    

GOG_SERIES_FILL_TYPE_NEXT

    

GOG_SERIES_FILL_TYPE_INVALID

    

GOG_SERIES_ACCEPT_TREND_LINE

#define GOG_SERIES_ACCEPT_TREND_LINE 1

Property Details

The “fill-type” property

  “fill-type”                gchar *

How to fill the area.

Flags: Read / Write

Default value: "invalid"

The “has-legend” property

  “has-legend”               gboolean

Should the series show up in legends.

Flags: Read / Write

Default value: TRUE

The “interpolation” property

  “interpolation”            gchar *

Type of line interpolation.

Flags: Read / Write

Default value: "linear"

The “interpolation-skip-invalid” property

  “interpolation-skip-invalid” gboolean

Should the series interpolation ignore the invalid data.

Flags: Read / Write

Default value: FALSE

The “index” property

  “index”                    gint

Index of the corresponding data element.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Generated by GTK-Doc V1.25