| GOffice Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
GogSeries; GogSeriesClass; GogSeriesDesc; GogSeriesDimDesc; enum GogDimType; enum GogMSDimType; GogSeriesElement; GogSeriesElementClass; enum GogSeriesPriority; enum GogSeriesFillType; void gog_series_check_validity (GogSeries *series); GogSeriesElement * gog_series_get_element (GogSeries const *series,int index); GogSeriesFillType gog_series_get_fill_type (GogSeries const *series); GogSeriesFillType gog_series_get_fill_type_from_combo (GogSeries const *series,GtkComboBox *combo); GogDataset * gog_series_get_interpolation_params (GogSeries const *series); GOData * gog_series_get_name (GogSeries const *series); GList const * gog_series_get_overrides (GogSeries const *series); GogPlot * gog_series_get_plot (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); gboolean gog_series_has_legend (GogSeries const *series); gboolean gog_series_is_valid (GogSeries const *series); int gog_series_map_XL_dim (GogSeries const *series,GogMSDimType ms_type); unsigned gog_series_num_elements (GogSeries const *series); void gog_series_populate_fill_type_combo (GogSeries const *series,GtkComboBox *combo); void gog_series_set_XL_dim (GogSeries *series,GogMSDimType ms_type,GOData *val,GError **err); void gog_series_set_dim (GogSeries *series,int dim_i,GOData *val,GError **err); void gog_series_set_fill_type (GogSeries *series,GogSeriesFillType fill_type); void gog_series_set_index (GogSeries *series,int ind,gboolean is_manual); void gog_series_set_name (GogSeries *series,GODataScalar *name_src,GError **err);
GObject +----GogObject +----GogStyledObject +----GogSeries
GObject +----GogObject +----GogStyledObject +----GogSeriesElement
GogSeries implements GOStyledObject and GogDataset.
GogSeriesElement implements GOStyledObject.
"fill-type" gchar* : Read / Write "has-legend" gboolean : Read / Write "interpolation" gchar* : Read / Write "interpolation-skip-invalid" gboolean : Read / Write "index" gint : Read / Write
typedef struct {
GogStyledObjectClass base;
gboolean has_interpolation;
gboolean has_fill_type;
GogSeriesFillType const *valid_fill_type_list;
GType series_element_type;
/* Virtuals */
void (*dim_changed) (GogSeries *series, int dim_i);
unsigned (*get_xy_data) (GogSeries const *series,
double const **x, double const **y);
GogDataset *(*get_interpolation_params) (GogSeries const *series);
} GogSeriesClass;
GogStyledObjectClass |
|
| supports interpolation. | |
TRUE if filling is supported. |
|
GogSeriesFillType const * |
list of supported GogSeriesFillType values. |
| GType for the series element if supported. | |
| called when data changed for the series. | |
| get X and Y data. | |
| get interpolation parameters if any, only applies to constrained cubic spline interpolation. |
typedef struct {
unsigned style_fields;
unsigned num_dim;
GogSeriesDimDesc const *dim;
} GogSeriesDesc;
GogSeriesDimDesc const * |
dimensions descriptions. |
typedef struct {
char const *name;
GogSeriesPriority priority;
gboolean is_shared;
GogDimType val_type;
GogMSDimType ms_type;
} GogSeriesDimDesc;
| name. | |
GogSeriesPriority |
priority. |
| whether the dimension is shared among the series. | |
GogDimType |
data type. |
GogMSDimType |
data type for foreign formats. |
typedef enum {
GOG_DIM_INVALID = -1,
GOG_DIM_LABEL = 0,
GOG_DIM_INDEX,
GOG_DIM_VALUE,
GOG_DIM_MATRIX,
GOG_DIM_TYPES
} GogDimType;
Data types for plots.
typedef enum {
GOG_MS_DIM_LABELS = 0,
GOG_MS_DIM_VALUES = 1,
GOG_MS_DIM_CATEGORIES = 2,
GOG_MS_DIM_BUBBLES = 3, /* undocumented */
GOG_MS_DIM_TYPES,
GOG_MS_DIM_ERR_plus1, /* we made it up */
GOG_MS_DIM_ERR_minus1, /* we made it up */
GOG_MS_DIM_ERR_plus2, /* we made it up */
GOG_MS_DIM_ERR_minus2, /* we made it up */
GOG_MS_DIM_START, /* we made it up for dropbars*/
GOG_MS_DIM_END, /* we made it up for dropbars */
GOG_MS_DIM_LOW, /* we made it up for hi-lo*/
GOG_MS_DIM_HIGH, /* we made it up for hi-lo */
GOG_MS_DIM_EXTRA1, /* we made it up for other uses */
GOG_MS_DIM_EXTRA2 /* we made it up for other uses */
} GogMSDimType;
Data types classed according to what they become when exported to foreign formats.
| labels. | |
| values. | |
| categories. | |
| bubble values. | |
| maximum value known by MS, should not occur. | |
| positive erros on first dimension, we made it up. | |
| negative erros on first dimension, we made it up. | |
| positive erros on second dimension, we made it up. | |
| negative erros on second dimension, we made it up | |
| start value, we made it up for dropbars. | |
| end value, we made it up for dropbars. | |
| low value, we made it up for hi-lo. | |
| high value, we made it up for hi-lo. | |
| we made it up for other uses. | |
| we made it up for other uses. |
typedef struct {
GogStyledObjectClass base;
/* Virtuals */
gpointer (*gse_populate_editor) (GogObject *gobj,
GOEditor *editor,
GOCmdContext *cc);
} GogSeriesElementClass;
GogStyledObjectClass |
|
| populates editor. |
typedef enum {
GOG_SERIES_REQUIRED, /* it must be there */
GOG_SERIES_SUGGESTED, /* allocator will fill it in, but use need not */
GOG_SERIES_OPTIONAL,
GOG_SERIES_ERRORS
} GogSeriesPriority;
Applies to data declarations in GogSeriesDimDesc.
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_X_AXIS_MIN,
GOG_SERIES_FILL_TYPE_X_AXIS_MAX,
GOG_SERIES_FILL_TYPE_Y_AXIS_MIN,
GOG_SERIES_FILL_TYPE_Y_AXIS_MAX,
GOG_SERIES_FILL_TYPE_INVALID
} GogSeriesFillType;
| from origin ox the X-axis. | |
| from the origin of the Y-axis | |
| from the chart bottom. | |
| from the chart left side. | |
| from the chart top. | |
| , from the chart right side. | |
| from the origin (for radar and polar plots). | |
| from the center (for radar and polar plots). | |
| from the edge (for radar and polar plots). | |
| close the series curve and fills it. | |
| from next series. | |
| from X-axis minimum. | |
| from X-axis maximum. | |
| from Y-axis minimum. | |
| from Y-axis maximum. | |
| invalid, should not happen. |
void gog_series_check_validity (GogSeries *series);
Updates the is_valid flag for a series. This is an internal utility that should not really be necessary for general usage.
|
GogSeries |
GogSeriesElement * gog_series_get_element (GogSeries const *series,int index);
|
GogSeries |
|
the element index |
Returns : |
the GogSeriesElement corresponding to index if
any. [transfer none]
|
GogSeriesFillType gog_series_get_fill_type_from_combo (GogSeries const *series,GtkComboBox *combo);
GogDataset * gog_series_get_interpolation_params (GogSeries const *series);
Only constrained cubic spline interpolation use parameters (for the slopes at each end).
|
GogSeries |
Returns : |
the interpolation parameters. [transfer none] |
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.
|
a GogSeries |
Returns : |
a GODataScalar, without added reference. [transfer none] |
GList const * gog_series_get_overrides (GogSeries const *series);
Overrides are data owning their own style, overriding the series style.
|
GogSeries |
Returns : |
the series overrides. [element-type GogSeriesElement][transfer none] |
GogPlot * gog_series_get_plot (GogSeries const *series);
|
GogSeries |
Returns : |
the possibly NULL plot that contains this series. [transfer none] |
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);
gboolean gog_series_has_legend (GogSeries const *series);
|
GogSeries |
Returns : |
TRUE if the series has a visible legend entry |
gboolean gog_series_is_valid (GogSeries const *series);
|
GogSeries |
Returns : |
the current cached validity. Does not recheck |
unsigned gog_series_num_elements (GogSeries const *series);
|
GogSeries |
Returns : |
the number of elements in the series |
void gog_series_populate_fill_type_combo (GogSeries const *series,GtkComboBox *combo);
void gog_series_set_XL_dim (GogSeries *series,GogMSDimType ms_type,GOData *val,GError **err);
void gog_series_set_dim (GogSeries *series,int dim_i,GOData *val,GError **err);
Absorbs a ref to val
void gog_series_set_fill_type (GogSeries *series,GogSeriesFillType fill_type);
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.
|
GogSeries |
|
>= 0 assigns a new index, < 0 resets to auto |
|
gboolean |
void gog_series_set_name (GogSeries *series,GODataScalar *name_src,GError **err);
Absorbs a ref to name_src.
|
a GogSeries |
|
a GODataScalar |
|
a GError |
"fill-type" property "fill-type" gchar* : Read / Write
How to fill the area.
Default value: "invalid"
"has-legend" property "has-legend" gboolean : Read / Write
Should the series show up in legends.
Default value: TRUE
"interpolation" property "interpolation" gchar* : Read / Write
Type of line interpolation.
Default value: "linear"
"interpolation-skip-invalid" property "interpolation-skip-invalid" gboolean : Read / Write
Should the series interpolation ignore the invalid data.
Default value: FALSE