## GogSeries

GogSeries — Base class for series

## Synopsis

    enum                GogSeriesFillType;
    #define             GOG_SERIES_ELEMENT_TYPE
    #define             GOG_SERIES_ELEMENT                  (o)
    #define             IS_GOG_SERIES_ELEMENT               (o)
    GType               gog_series_element_get_type         (void);
    #define             GOG_SERIES_TYPE
    #define             GOG_SERIES                          (o)
    #define             IS_GOG_SERIES                       (o)
    GType               gog_series_get_type                 (void);
    gboolean            gog_series_is_valid                 (GogSeries const *series);
    gboolean            gog_series_has_legend               (GogSeries const *series);
    GODataScalar*       gog_series_get_name                 (GogSeries const *series);
    GogPlot*            gog_series_get_plot                 (GogSeries const *series);
    void                gog_series_set_name                 (GogSeries *series,
                                                             GODataScalar *name_src,
                                                             GError **err);
    void                gog_series_set_dim                  (GogSeries *series,
                                                             int dim_i,
                                                             GOData *val,
                                                             GError **err);
    void                gog_series_set_index                (GogSeries *series,
                                                             int ind,
                                                             gboolean is_manual);
    unsigned            gog_series_num_elements             (GogSeries const *series);
    GListconst  	 *     gog_series_get_overrides            (GogSeries const *series);
    unsigned            gog_series_get_xy_data              (GogSeries const *series,
                                                             double const **x,
                                                             double const **y);
    unsigned            gog_series_get_xyz_data             (GogSeries const *series,
                                                             double const **x,
                                                             double const **y,
                                                             double const **z);
    GogSeriesFillType   gog_series_get_fill_type            (GogSeries const *series);
    void                gog_series_set_fill_type            (GogSeries *series,
                                                             GogSeriesFillType fill_type);
    void                gog_series_populate_fill_type_combo (GogSeries const *series,
                                                             GtkComboBox *combo);
    GogSeriesFillType   gog_series_get_fill_type_from_combo (GogSeries const *series,
                                                             GtkComboBox *combo);

## Description

## Details

### enum GogSeriesFillType

    typedef enum {
    	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
    } GogSeriesFillType;

### GOG_SERIES_ELEMENT_TYPE

    #define GOG_SERIES_ELEMENT_TYPE	(gog_series_element_get_type ())

### GOG_SERIES_ELEMENT()

    #define GOG_SERIES_ELEMENT(o)	(G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_SERIES_ELEMENT_TYPE, GogSeriesElement))

`o` : |

### IS_GOG_SERIES_ELEMENT()

    #define IS_GOG_SERIES_ELEMENT(o)	(G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_SERIES_ELEMENT_TYPE))

`o` : |

### gog_series_element_get_type ()

    GType               gog_series_element_get_type         (void);

Returns : |

### GOG_SERIES_TYPE

    #define GOG_SERIES_TYPE		(gog_series_get_type ())

### GOG_SERIES()

    #define GOG_SERIES(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_SERIES_TYPE, GogSeries))

`o` : |

### IS_GOG_SERIES()

    #define IS_GOG_SERIES(o)	(G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_SERIES_TYPE))

`o` : |

### gog_series_get_type ()

    GType               gog_series_get_type                 (void);

Returns : |

### gog_series_is_valid ()

    gboolean            gog_series_is_valid                 (GogSeries const *series);

`series` : | GogSeries
Returns : | the current cached validity. Does not recheck

### gog_series_has_legend ()

    gboolean            gog_series_has_legend               (GogSeries const *series);

`series` : | GogSeries
Returns : | TRUE if the series has a visible legend entry

### gog_series_get_name ()

    GODataScalar*       gog_series_get_name                 (GogSeries const *series);

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

`series` : | a GogSeries
Returns : | a GODataScalar, without added reference.

### gog_series_get_plot ()

    GogPlot*            gog_series_get_plot                 (GogSeries const *series);

`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`.

`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`

`series` : | GogSeries
`dim_i` : |
`val` : | GOData
`err` : | optional Gerror pointer

### gog_series_set_index ()

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

If `index` >= 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.

`series` : | GogSeries
`ind` : |
`is_manual` : |

### gog_series_num_elements ()

    unsigned            gog_series_num_elements             (GogSeries const *series);

`series` : | GogSeries
Returns : | the number of elements in the series

### gog_series_get_overrides ()

    GListconst  	 *     gog_series_get_overrides            (GogSeries const *series);

`series` : |
Returns : |

### gog_series_get_xy_data ()

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

`series` : |
`x` : |
`y` : |
Returns : |

### gog_series_get_xyz_data ()

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

`series` : |
`x` : |
`y` : |
`z` : |
Returns : |

### gog_series_get_fill_type ()

    GogSeriesFillType   gog_series_get_fill_type            (GogSeries const *series);

`series` : |
Returns : |

### gog_series_set_fill_type ()

    void                gog_series_set_fill_type            (GogSeries *series,
                                                             GogSeriesFillType fill_type);

`series` : |
`fill_type` : |

### gog_series_populate_fill_type_combo ()

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

`series` : |
`combo` : |

### gog_series_get_fill_type_from_combo ()

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

`series` : |
`combo` : |
Returns : |