GogChart

GogChart — A chart.

Functions

Properties

gboolean cardinality-valid Read
gint columns Read / Write
gboolean is-plot-area-manual Read / Write
gchar * plot-area Read / Write
gint rows Read / Write
gint xpos Read / Write
gint ypos Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GogObject
        ╰── GogStyledObject
            ╰── GogOutlinedObject
                ╰── GogChart

Implemented Interfaces

GogChart implements GOStyledObject.

Description

GogChart wraps one or more GogPlot objects, so that you can superimpose them on top of each other. In addition, the chart can have a title and a legend.

Functions

gog_axis_set_from_str ()

GogAxisSet
gog_axis_set_from_str (char const *str);


gog_chart_get_position ()

gboolean
gog_chart_get_position (GogChart const *chart,
                        unsigned *x,
                        unsigned *y,
                        unsigned *cols,
                        unsigned *rows);

Parameters

chart

const GogChart

 

Returns

TRUE if the chart has been positioned.


gog_chart_set_position ()

void
gog_chart_set_position (GogChart *chart,
                        unsigned int x,
                        unsigned int y,
                        unsigned int cols,
                        unsigned int rows);

Parameters

chart

GogChart

 

gog_chart_get_plot_area ()

gboolean
gog_chart_get_plot_area (GogChart *chart,
                         GogViewAllocation *plot_area);

Stores plot area in plot_area, in fraction of chart size.

Parameters

chart

GogChart

 

plot_area

GogViewAllocation

 

Returns

TRUE if plot area position is manual.


gog_chart_set_plot_area ()

void
gog_chart_set_plot_area (GogChart *chart,
                         GogViewAllocation const *plot_area);

If plot_area != NULL, sets plot area size and location, in fraction of chart size, and sets GogChart::is_plot_area_manual flag to TRUE. If plot_area == NULL, sets GogChart::is_plot_area_manual to FALSE.

Parameters

chart

GogChart

 

plot_area

GogViewAllocation

 

gog_chart_request_cardinality_update ()

void
gog_chart_request_cardinality_update (GogChart *chart);


gog_chart_get_cardinality ()

void
gog_chart_get_cardinality (GogChart *chart,
                           unsigned *full,
                           unsigned *visible);

Update and cache cardinality values if required, and returns full and visible cardinality. Full cardinality is the number of chart elements that require a different style. Visible cardinality is the number of chart elements shown in chart legend.

full and visible may be NULL.

Parameters

chart

a GogChart

 

full

placeholder for full cardinality

 

visible

placeholder for visible cardinality

 

gog_chart_foreach_elem ()

void
gog_chart_foreach_elem (GogChart *chart,
                        gboolean only_visible,
                        GogEnumFunc handler,
                        gpointer data);


gog_chart_get_plots ()

GSList *
gog_chart_get_plots (GogChart const *chart);


gog_chart_get_axis_set ()

GogAxisSet
gog_chart_get_axis_set (GogChart const *chart);


gog_chart_axis_set_is_valid ()

gboolean
gog_chart_axis_set_is_valid (GogChart const *chart,
                             GogAxisSet type);


gog_chart_axis_set_assign ()

gboolean
gog_chart_axis_set_assign (GogChart *chart,
                           GogAxisSet type);


gog_chart_get_axes ()

GSList *
gog_chart_get_axes (GogChart const *chart,
                    GogAxisType target);

Parameters

chart

GogChart

 

target

GogAxisType

 

Returns

a list which the caller must free of all axis of type target associated with chart .


gog_chart_get_grid ()

GogGrid *
gog_chart_get_grid (GogChart const *chart);

Parameters

chart

GogChart

 

Returns

the grid associated with chart if one exists otherwise NULL.


gog_chart_view_get_plot_area ()

GogViewAllocation const *
gog_chart_view_get_plot_area (GogView const *view);


gog_chart_is_3d ()

gboolean
gog_chart_is_3d (GogChart const *chart);

Types and Values

GogChart

typedef struct _GogChart GogChart;

Property Details

The “cardinality-valid” property

  “cardinality-valid”        gboolean

Is the charts cardinality currently valid.

Flags: Read

Default value: FALSE


The “columns” property

  “columns”                  gint

Number of columns in graph grid.

Flags: Read / Write

Allowed values: >= 1

Default value: 1


The “is-plot-area-manual” property

  “is-plot-area-manual”      gboolean

Is plot area manual.

Flags: Read / Write

Default value: FALSE


The “plot-area” property

  “plot-area”                gchar *

Position and size of plot area, in percentage of chart size.

Flags: Read / Write

Default value: "0 0 1 1"


The “rows” property

  “rows”                     gint

Number of rows in graph grid.

Flags: Read / Write

Allowed values: >= 1

Default value: 1


The “xpos” property

  “xpos”                     gint

Horizontal chart position in graph grid.

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “ypos” property

  “ypos”                     gint

Vertical chart position in graph grid.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

See Also

GogPlot