1 /* acre - A cairo-based library for creating plots and charts.
3 * Copyright © 2009 Carl Worth <cworth@cworth.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 #include <pango/pangocairo.h>
25 typedef struct _acre acre_t;
26 typedef struct _acre_data acre_data_t;
28 /* Create a new, empty plot. */
34 acre_destroy (acre_t *acre);
37 acre_set_title (acre_t *acre, const char *title);
40 acre_set_x_axis_label (acre_t *acre, const char *label);
43 acre_set_y_axis_label (acre_t *acre, const char *label);
45 /* Get the range of data values in the X dimension. */
47 acre_get_x_axis_data_range (acre_t *acre, double *x_min, double *x_max);
49 /* Get the range of the currently viewable X axis. */
51 acre_get_x_axis_range (acre_t *acre, double *x_min, double *x_max);
53 /* Set the range of the currently viewable X axis. */
55 acre_set_x_axis_range (acre_t *acre, double x_min, double x_max);
57 /* Set the X axis viewable range to be sized automatically.
59 * If both X and Y axes are sized automatically, then the X range will
60 * be set to the full range of data in the X dimension.
62 * But if the Y axis has been set to a limited viewable range, (with
63 * acre_set_y_axis_range), then the X axis will be set to the
64 * corresponding X range of data that lies within that set Y range. */
66 acre_set_x_axis_range_auto (acre_t *acre);
68 /* Get the range of data values in the Y dimnension. */
70 acre_get_y_axis_data_range (acre_t *acre, double *y_min, double *y_max);
72 /* Get the range of the currently viewable Y axis. */
74 acre_get_y_axis_range (acre_t *acre, double *y_min, double *y_max);
76 /* Set the range of the currently viewable Y axis. */
78 acre_set_y_axis_range (acre_t *acre, double y_min, double y_max);
80 /* Set the Y axis viewable range to be sized automatically.
82 * If both X and Y axes are sized automatically, then the Y range will
83 * be set to the full range of data in the Y dimension.
85 * But if the X axis has been set to a limited viewable range, (with
86 * acre_set_x_axis_range), then the Y axis will be set to the
87 * corresponding Y range of data that lies within that set X range. */
89 acre_set_y_axis_range_auto (acre_t *acre);
91 /* Add a dataset to the plot. The plot assumes ownership of the
92 * dataset so it is not necessary to call acre_data_destroy on it. */
94 acre_add_data (acre_t *acre, acre_data_t *data);
96 /* Draw the plot to the given cairo context within a user-space
97 * rectangle from (0, 0) to (width, height). This size includes all
98 * space for extra-plot elements (such as the title, the axis labels,
102 acre_draw (acre_t *acre, cairo_t *cr, int width, int height);
104 /* Create a new dataset---a collection of (x, y) datapoints. A single
105 * plot can contain multiple datasets, (see acre_add_data). */
107 acre_data_create (void);
109 /* Destroy an acre dataset. Do not call this function if the dataset
110 * has been added to an acre_t plot with acre_add_data. */
112 acre_data_destroy (acre_data_t *data);
114 /* Set the label for this dataset (to appear in the plot's key). */
116 acre_data_set_name (acre_data_t *data, const char *name);
118 /* Add a datapoint to the given dataset. */
120 acre_data_add_point_2d (acre_data_t *data, double x, double y);
122 /* Add a datapoint with a name to the given dataset. */
124 acre_data_add_point_2d_named (acre_data_t *data, double x, double y,