GogPlot

GogPlot — Base class for plots

Synopsis




                    GogPlot;
                    GogPlotBoundInfo;
GogPlot*            gog_plot_new_by_type                (GogPlotType const *type);
GogPlot*            gog_plot_new_by_name                (char const *id);
gboolean            gog_plot_make_similar               (GogPlot *dst,
                                                         GogPlot const *src);
void                gog_plot_request_cardinality_update (GogPlot *plot);
void                gog_plot_get_cardinality            (GogPlot *plot,
                                                         unsigned *full,
                                                         unsigned *visible);
void                gog_plot_foreach_elem               (GogPlot *plot,
                                                         gboolean only_visible,
                                                         GogEnumFunc handler,
                                                         gpointer data);
GSListconst *       gog_plot_get_series                 (GogPlot const *plot);
GOData*             gog_plot_get_axis_bounds            (GogPlot *plot,
                                                         GogAxisType axis,
                                                         GogPlotBoundInfo *bounds);
gboolean            gog_plot_supports_vary_style_by_element
                                                        (GogPlot const *plot);
GogSeries*          gog_plot_new_series                 (GogPlot *plot);
GogPlotDescconst *  gog_plot_description                (GogPlot const *plot);
GogAxisSet          gog_plot_axis_set_pref              (GogPlot const *plot);
gboolean            gog_plot_axis_set_is_valid          (GogPlot const *plot,
                                                         GogAxisSet type);
gboolean            gog_plot_axis_set_assign            (GogPlot *plot,
                                                         GogAxisSet type);
void                gog_plot_axis_clear                 (GogPlot *plot,
                                                         GogAxisSet filter);
GogAxis*            gog_plot_get_axis                   (GogPlot const *plot,
                                                         GogAxisType type);
void                gog_plot_update_3d                  (GogPlot *plot);
void                gog_plot_guru_helper                (GogPlot *plot);

typedef             GogPlotView;


Object Hierarchy


  GObject
   +----GogObject
         +----GogPlot

Properties


  "guru-hints"               gchararray            : Read / Write
  "interpolation"            gchararray            : Read / Write
  "plot-group"               gchararray            : Read / Write
  "vary-style-by-element"    gboolean              : Read / Write
  "x-axis"                   guint                 : Read / Write
  "y-axis"                   guint                 : Read / Write

Description

Details

GogPlot

typedef struct _GogPlot GogPlot;


GogPlotBoundInfo

typedef struct {
	struct {
		double minima, maxima;
	} val, logical;
	gboolean is_discrete;
	gboolean center_on_ticks;
	GOFormat *fmt;
} GogPlotBoundInfo;


gog_plot_new_by_type ()

GogPlot*            gog_plot_new_by_type                (GogPlotType const *type);

type :
Returns :

gog_plot_new_by_name ()

GogPlot*            gog_plot_new_by_name                (char const *id);

id :
Returns :

gog_plot_make_similar ()

gboolean            gog_plot_make_similar               (GogPlot *dst,
                                                         GogPlot const *src);

As much as possible have dst use similar formatting and data allocation to src.

return TRUE on failue

dst :
src :
Returns :

gog_plot_request_cardinality_update ()

void                gog_plot_request_cardinality_update (GogPlot *plot);

plot :

gog_plot_get_cardinality ()

void                gog_plot_get_cardinality            (GogPlot *plot,
                                                         unsigned *full,
                                                         unsigned *visible);

Return the number of logical elements in the plot. See gog_chart_get_cardinality.

full and visible may be NULL.

plot : GogPlot
full : placeholder for full cardinality
visible : placeholder for visible cardinality

gog_plot_foreach_elem ()

void                gog_plot_foreach_elem               (GogPlot *plot,
                                                         gboolean only_visible,
                                                         GogEnumFunc handler,
                                                         gpointer data);

plot :
only_visible :
handler :
data :

gog_plot_get_series ()

GSListconst *       gog_plot_get_series                 (GogPlot const *plot);

A list of the series in plot. Do not modify or free the list.

plot : GogPlot
Returns :

gog_plot_get_axis_bounds ()

GOData*             gog_plot_get_axis_bounds            (GogPlot *plot,
                                                         GogAxisType axis,
                                                         GogPlotBoundInfo *bounds);

Queries plot for its axis preferences for axis and stores the results in bounds. All elements of bounds are initialized to sane values before the query _ACCEPT_ ::fmt. The caller is responsible for initializing it. This is done so that once on plot has selected a format the others need not do the lookup too if so desired.

Caller is responsible for unrefing ::fmt.

plot : GogPlot
axis : GogAxisType
bounds : GogPlotBoundInfo
Returns :

gog_plot_supports_vary_style_by_element ()

gboolean            gog_plot_supports_vary_style_by_element
                                                        (GogPlot const *plot);

plot :
Returns :

gog_plot_new_series ()

GogSeries*          gog_plot_new_series                 (GogPlot *plot);

plot :
Returns :

gog_plot_description ()

GogPlotDescconst *  gog_plot_description                (GogPlot const *plot);

plot :
Returns :

gog_plot_axis_set_pref ()

GogAxisSet          gog_plot_axis_set_pref              (GogPlot const *plot);

plot :
Returns :

gog_plot_axis_set_is_valid ()

gboolean            gog_plot_axis_set_is_valid          (GogPlot const *plot,
                                                         GogAxisSet type);

plot :
type :
Returns :

gog_plot_axis_set_assign ()

gboolean            gog_plot_axis_set_assign            (GogPlot *plot,
                                                         GogAxisSet type);

plot :
type :
Returns :

gog_plot_axis_clear ()

void                gog_plot_axis_clear                 (GogPlot *plot,
                                                         GogAxisSet filter);

A utility method to clear all existing axis associations flagged by filter

plot : GogPlot
filter : GogAxisSet

gog_plot_get_axis ()

GogAxis*            gog_plot_get_axis                   (GogPlot const *plot,
                                                         GogAxisType type);

plot :
type :
Returns :

gog_plot_update_3d ()

void                gog_plot_update_3d                  (GogPlot *plot);

plot :

gog_plot_guru_helper ()

void                gog_plot_guru_helper                (GogPlot *plot);

plot :

GogPlotView

typedef GogView		GogPlotView;

Property Details

The "guru-hints" property

  "guru-hints"               gchararray            : Read / Write

Semicolon separated list of hints for automatic addition of objects in guru dialog.

Default value: NULL


The "interpolation" property

  "interpolation"            gchararray            : Read / Write

Default type of series line interpolation.

Default value: "linear"


The "plot-group" property

  "plot-group"               gchararray            : Read / Write

Name of plot group if any.

Default value: NULL


The "vary-style-by-element" property

  "vary-style-by-element"    gboolean              : Read / Write

Use a different style for each segments.

Default value: FALSE


The "x-axis" property

  "x-axis"                   guint                 : Read / Write

Reference to X axis.

Allowed values: <= G_MAXINT

Default value: 0


The "y-axis" property

  "y-axis"                   guint                 : Read / Write

Reference to Y axis.

Allowed values: <= G_MAXINT

Default value: 0