Top |
Functions
#define | GOG_PLOT_GET_CLASS() |
void | gog_plot_axis_clear () |
gboolean | gog_plot_axis_set_assign () |
gboolean | gog_plot_axis_set_is_valid () |
GogAxisSet | gog_plot_axis_set_pref () |
void | gog_plot_clear_series () |
GogPlotDesc const * | gog_plot_description () |
void | gog_plot_foreach_elem () |
GogAxis * | gog_plot_get_axis () |
GOData * | gog_plot_get_axis_bounds () |
void | gog_plot_get_cardinality () |
double | gog_plot_get_percent_value () |
GSList const * | gog_plot_get_series () |
void | gog_plot_guru_helper () |
GogPlot * | gog_plot_new_by_name () |
GogPlot * | gog_plot_new_by_type () |
GogSeries * | gog_plot_new_series () |
void | gog_plot_request_cardinality_update () |
void | gog_plot_set_axis () |
gboolean | gog_plot_supports_vary_style_by_element () |
void | gog_plot_update_3d () |
void | gog_plot_update_cardinality () |
int | gog_plot_view_get_data_at_point () |
Properties
guint | bubble-axis | Read / Write |
guint | circ-axis | Read / Write |
guint | color-axis | Read / Write |
gchar * | guru-hints | Read / Write |
gchar * | interpolation | Read / Write |
gchar * | plot-group | Read / Write |
guint | pseudo-3d-axis | Read / Write |
guint | radial-axis | Read / Write |
gboolean | vary-style-by-element | Read / Write |
guint | x-axis | Read / Write |
guint | y-axis | Read / Write |
guint | z-axis | Read / Write |
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_GET_CLASS()
#define GOG_PLOT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GOG_TYPE_PLOT, GogPlotClass))
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
gog_plot_axis_set_is_valid ()
gboolean gog_plot_axis_set_is_valid (GogPlot const *plot
,GogAxisSet type
);
gog_plot_foreach_elem ()
void gog_plot_foreach_elem (GogPlot *plot
,gboolean only_visible
,GogEnumFunc handler
,gpointer data
);
Executes funcfor
each plot element. Used to build a legend.
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.
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.
gog_plot_get_percent_value ()
double gog_plot_get_percent_value (GogPlot *plot
,unsigned series
,unsigned index
);
gog_plot_supports_vary_style_by_element ()
gboolean
gog_plot_supports_vary_style_by_element
(GogPlot const *plot
);
gog_plot_update_cardinality ()
void gog_plot_update_cardinality (GogPlot *plot
,int index_num
);
Update cardinality and cache result. See gog_chart_get_cardinality
.
gog_plot_view_get_data_at_point ()
int gog_plot_view_get_data_at_point (GogPlotView *view
,double x
,double y
,GogSeries **series
);
Search a data represented at (x
,y
) in view
and set series
on success.
Types and Values
GogPlotClass
typedef struct { GogObjectClass base; GogPlotDesc desc; GType series_type; GogAxisSet axis_set; /* Virtuals */ GOData *(*axis_get_bounds) (GogPlot *plot, GogAxisType axis, GogPlotBoundInfo *bounds); gboolean (*supports_vary_style_by_element) (GogPlot const *plot); /* %TRUE if the plot prefers to display series in reverse order for * legends (e.g. stacked plots want top element to be the last series) */ gboolean (*enum_in_reverse) (GogPlot const *plot); void (*foreach_elem) (GogPlot *plot, gboolean only_visible, GogEnumFunc handler, gpointer data); void (*update_3d) (GogPlot *plot); void (*guru_helper) (GogPlot *plot, char const *hint); double (*get_percent) (GogPlot *plot, unsigned series, unsigned index); } GogPlotClass;
Members
GogObjectClass |
||
GogPlotDesc |
||
series type. |
||
GogAxisSet |
set of use axes. |
|
requests the axis bounds |
||
|
||
|
||
enumerates the elements visible in the legend. |
||
updates 3D (and contour) plots. |
||
customizes a new plot in the graph editor dialog. |
||
get the value as a percentage. |
GogPlotViewClass
typedef struct { GogViewClass base; int (*get_data_at_point) (GogPlotView *view, double x, double y, GogSeries **series); } GogPlotViewClass;
GogPlotBoundInfo
typedef struct { struct _GogPlotBound { double minima, maxima; } val, logical; gboolean is_discrete; gboolean center_on_ticks; GOFormat *fmt; const GODateConventions *date_conv; } GogPlotBoundInfo;
Used by plots to give formating informations to each axis. GogPlotBoundInfo::val are the values limits, GogPlotBoundInfo::logical are the actual needed display limits.
Members
whether the data are discrete. |
||
whether to center data on ticks. |
||
GOFormat * |
GOFormat to use. |
|
const GODateConventions * |
the used GODateConventions. |
Property Details
The “bubble-axis”
property
“bubble-axis” guint
Reference to bubble axis.
Flags: Read / Write
Allowed values: <= G_MAXINT
Default value: 0
The “circ-axis”
property
“circ-axis” guint
Reference to circular axis.
Flags: Read / Write
Allowed values: <= G_MAXINT
Default value: 0
The “color-axis”
property
“color-axis” guint
Reference to color axis.
Flags: Read / Write
Allowed values: <= G_MAXINT
Default value: 0
The “guru-hints”
property
“guru-hints” gchar *
Semicolon separated list of hints for automatic addition of objects in guru dialog.
Flags: Read / Write
Default value: NULL
The “interpolation”
property
“interpolation” gchar *
Default type of series line interpolation.
Flags: Read / Write
Default value: "linear"
The “plot-group”
property
“plot-group” gchar *
Name of plot group if any.
Flags: Read / Write
Default value: NULL
The “pseudo-3d-axis”
property
“pseudo-3d-axis” guint
Reference to pseudo-3D axis.
Flags: Read / Write
Allowed values: <= G_MAXINT
Default value: 0
The “radial-axis”
property
“radial-axis” guint
Reference to radial axis.
Flags: Read / Write
Allowed values: <= G_MAXINT
Default value: 0
The “vary-style-by-element”
property
“vary-style-by-element” gboolean
Use a different style for each segment.
Flags: Read / Write
Default value: FALSE
The “x-axis”
property
“x-axis” guint
Reference to X axis.
Flags: Read / Write
Allowed values: <= G_MAXINT
Default value: 0
The “y-axis”
property
“y-axis” guint
Reference to Y axis.
Flags: Read / Write
Allowed values: <= G_MAXINT
Default value: 0