blob: 00995259b3a70bcd2041d615f5f3c5e7cf40b58a [file] [log] [blame]
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +01001#ifndef GRAPH_H
2#define GRAPH_H
3
4struct graph;
5
Stephen M. Cameroncae08722012-03-07 14:47:38 +01006
Jens Axboef3e84402012-03-07 13:14:32 +01007struct graph *graph_new(unsigned int xdim, unsigned int ydim, const char *font);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +01008/* graph_new() Returns a new graph structure of the given dimensions and font */
Stephen M. Cameron3ea48b82012-03-07 19:40:58 +01009void graph_set_size(struct graph *g, unsigned int xdim, unsigned int ydim);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010010/* graph_set_size() Changes the size of a graph to the given dimensions. */
Stephen M. Cameron57f9d282012-03-11 11:36:51 +010011void graph_set_position(struct graph *g, double xoffset, double yoffset);
12/* graph_set_position() sets the x- and y-offset to translate the graph */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010013void bar_graph_draw(struct graph *g, cairo_t *cr);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010014/* bar_graph_draw() draws the given graph as a bar graph */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010015void line_graph_draw(struct graph *g, cairo_t *cr);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010016/* line_graph_draw draws the given graph as a line graph */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010017void line_graph_set_data_count_limit(struct graph *g, int per_label_limit);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010018/* line_graph_set_data_count_limit() limits the amount of data which can
19 * be added to a line graph. Once the limit is reached, the oldest data
20 * is discarded as new data is added
21 */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010022void graph_title(struct graph *g, const char *title);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010023/* graph_title() sets the main title of the graph to the given string */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010024void graph_x_title(struct graph *g, const char *title);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010025/* graph_x_title() sets the title of the x axis to the given string */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010026void graph_y_title(struct graph *g, const char *title);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010027/* graph_y_title() sets the title of the y axis to the given string */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010028void graph_add_label(struct graph *g, const char *label);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010029/* graph_add_label() adds a new "stream" of data to be graphed.
30 * For line charts, each label is a separate line on the graph.
31 * For bar charts, each label is a grouping of columns on the x-axis
32 * For example:
33 *
34 * | * | **
35 * | * xxxxxxxx | **
36 * | *** x | ** **
37 * | *x **** | ** ** **
38 * | xxxx* ***** | ** xx ** xx **
39 * | x ** | ** xx ** xx ** xx
40 * | x | ** xx ** xx ** xx
41 * ----------------------- -------------------------
42 * A B C
43 *
44 * For a line graph, the 'x's For a bar graph,
45 * would be on one "label", and 'A', 'B', and 'C'
46 * the '*'s would be on another are the labels.
47 * label.
48 */
49
Stephen M. Cameron09ad20f2012-03-11 11:34:38 +010050int graph_add_data(struct graph *g, const char *label, const double value);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010051/* graph_add_data() is used to add data to the labels of a bar graph */
Stephen M. Cameron09ad20f2012-03-11 11:34:38 +010052int graph_add_xy_data(struct graph *g, const char *label,
Jens Axboe93e2db22012-03-13 09:45:22 +010053 const double x, const double y, const char *tooltip);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010054/* graph_add_xy_data is used to add data to the labels of a line graph */
55
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010056void graph_set_color(struct graph *g, const char *label,
57 double red, double green, double blue);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010058#define INVISIBLE_COLOR (-1.0)
59/* graph_set_color is used to set the color used to plot the data in
60 * a line graph. INVISIBLE_COLOR can be used to plot the data invisibly.
61 * Invisible data will have the same effect on the scaling of the axes
62 * as visible data.
63 */
64
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010065void graph_free(struct graph *bg);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010066/* free a graph allocated by graph_new() */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010067
Stephen M. Cameron7175d912012-03-11 11:35:10 +010068typedef void (*graph_axis_unit_change_callback)(struct graph *g, int power_of_ten);
69void graph_x_axis_unit_change_notify(struct graph *g, graph_axis_unit_change_callback f);
70void graph_y_axis_unit_change_notify(struct graph *g, graph_axis_unit_change_callback f);
Stephen M. Cameronba35aa82012-03-11 11:36:14 +010071/* The labels used on the x and y axes may be shortened. You can register for callbacks
72 * so that you can know how the labels are shorted, typically used to adjust the axis
73 * titles to display the proper units. The power_of_ten parameter indicates what power
74 * of ten the labels have been divided by (9, 6, 3, or 0, corresponding to billions,
75 * millions, thousands and ones.
76 */
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010077
Stephen M. Camerondef0ac22012-03-12 07:32:57 +010078void graph_add_extra_space(struct graph *g, double left_percent, double right_percent,
79 double top_percent, double bottom_percent);
80/* graph_add_extra_space() adds extra space to edges of the the graph
81 * so that the data doesn't go to the very edges.
82 */
83
Jens Axboe93e2db22012-03-13 09:45:22 +010084extern int graph_has_tooltips(struct graph *g);
85extern const char *graph_find_tooltip(struct graph *g, int x, int y);
86extern int graph_contains_xy(struct graph *p, int x, int y);
87
Jens Axboed8fbeef2012-03-14 10:25:44 +010088extern void graph_set_base_offset(struct graph *g, unsigned int base_offset);
89
Stephen M. Cameronaf58ef32012-03-07 07:56:16 +010090#endif
91