GogPlot

GogPlot — A plot.

Functions

GogPlot * gog_plot_new_by_type ()
GogPlot * gog_plot_new_by_name ()
void gog_plot_request_cardinality_update ()
void gog_plot_get_cardinality ()
void gog_plot_update_cardinality ()
void gog_plot_foreach_elem ()
GSList const * gog_plot_get_series ()
GOData * gog_plot_get_axis_bounds ()
gboolean gog_plot_supports_vary_style_by_element ()
GogSeries * gog_plot_new_series ()
GogPlotDesc const * gog_plot_description ()
GogAxisSet gog_plot_axis_set_pref ()
gboolean gog_plot_axis_set_is_valid ()
gboolean gog_plot_axis_set_assign ()
void gog_plot_axis_clear ()
void gog_plot_set_axis ()
GogAxis * gog_plot_get_axis ()
void gog_plot_update_3d ()
void gog_plot_guru_helper ()
void gog_plot_clear_series ()
int gog_plot_view_get_data_at_point ()

Properties

gchar * guru-hints Read / Write
gchar * interpolation Read / Write
gchar * plot-group Read / Write
gboolean vary-style-by-element Read / Write
guint x-axis Read / Write
guint y-axis Read / Write

Types and Values

  GogPlot
  GogPlotClass
  GogPlotBoundInfo
  GogPlotView

Object Hierarchy

    GObject
    ├── GogObject
    │   ╰── GogPlot
    ╰── GogView
        ╰── GogPlotView

Description

This is the object that visualizes data. To manipulate the data shown in the plot, use gog_plot_new_series() and gog_plot_clear_series()

Plots are implemented as plug-ins, so make sure the plug-in system is initialized before trying to create one. See go_plugins_init()

GOffice ships a number of common plot implementations by default.

Functions

gog_plot_new_by_type ()

GogPlot *
gog_plot_new_by_type (GogPlotType const *type);

Returns

gog_plot_new_by_name ()

GogPlot *
gog_plot_new_by_name (char const *id);

Returns

gog_plot_request_cardinality_update ()

void
gog_plot_request_cardinality_update (GogPlot *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.

Parameters

plot

GogPlot

  

full

placeholder for full cardinality

  

visible

placeholder for visible cardinality

  

gog_plot_update_cardinality ()

void
gog_plot_update_cardinality (GogPlot *plot,
                             int index_num);

Update cardinality and cache result. See gog_chart_get_cardinality .

Parameters

plot

GogPlot

  

index_num

index offset for this plot

  

gog_plot_foreach_elem ()

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

gog_plot_get_series ()

GSList const *
gog_plot_get_series (GogPlot const *plot);

Parameters

plot

GogPlot

  

Returns

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

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 _EXCEPT_ ::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.

Parameters

plot

GogPlot

  

axis

GogAxisType

  

bounds

GogPlotBoundInfo

  

Returns

The data providing the bound (does not add a ref)

gog_plot_supports_vary_style_by_element ()

gboolean
gog_plot_supports_vary_style_by_element
                               (GogPlot const *plot);

Returns

gog_plot_new_series ()

GogSeries *
gog_plot_new_series (GogPlot *plot);

Parameters

plot

GogPlot

  

Returns

a new GogSeries of a type consistent with plot .

gog_plot_description ()

GogPlotDesc const *
gog_plot_description (GogPlot const *plot);

Returns

gog_plot_axis_set_pref ()

GogAxisSet
gog_plot_axis_set_pref (GogPlot const *plot);

Returns

gog_plot_axis_set_is_valid ()

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

Returns

gog_plot_axis_set_assign ()

gboolean
gog_plot_axis_set_assign (GogPlot *plot,
                          GogAxisSet 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

Parameters

plot

GogPlot

  

filter

GogAxisSet

  

gog_plot_set_axis ()

void
gog_plot_set_axis (GogPlot *plot,
                   GogAxis *axis);

Connect axis and plot .

Parameters

plot

GogPlot

  

axis