| GOffice Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
enum GogAxisElemType; enum GogAxisPolarUnit; GogAxisTick; enum GogAxisSet; enum GogAxisType; void gog_axis_add_contributor (GogAxis *axis,GogObject *contrib); void gog_axis_bound_changed (GogAxis *axis,GogObject *contrib); void gog_axis_clear_contributors (GogAxis *axis); GSList const * gog_axis_contributors (GogAxis *axis); void gog_axis_del_contributor (GogAxis *axis,GogObject *contrib); GogAxisType gog_axis_get_atype (GogAxis const *axis); gboolean gog_axis_get_bounds (GogAxis const *axis,double *minima,double *maxima); double gog_axis_get_circular_rotation (GogAxis *axis); GogAxisColorMap const * gog_axis_get_color_map (GogAxis *axis); const GODateConventions * gog_axis_get_date_conv (GogAxis const *axis); GOFormat * gog_axis_get_effective_format (GogAxis const *axis); void gog_axis_get_effective_span (GogAxis const *axis,double *start,double *end); double gog_axis_get_entry (GogAxis const *axis,GogAxisElemType i,gboolean *user_defined); GOFormat * gog_axis_get_format (GogAxis const *axis); GogGridLine * gog_axis_get_grid_line (GogAxis *axis,gboolean major); GOData * gog_axis_get_labels (GogAxis const *axis,GogPlot **plot_that_labeled_axis); double gog_axis_get_polar_perimeter (GogAxis *axis); GogAxisPolarUnit gog_axis_get_polar_unit (GogAxis *axis); unsigned gog_axis_get_ticks (GogAxis *axis,GogAxisTick **ticks); gboolean gog_axis_is_center_on_ticks (GogAxis const *axis); gboolean gog_axis_is_discrete (GogAxis const *axis); gboolean gog_axis_is_inverted (GogAxis const *axis); void gog_axis_set_bounds (GogAxis *axis,double minimum,double maximum); void gog_axis_set_extents (GogAxis *axis,double start,double stop); gboolean gog_axis_set_format (GogAxis *axis,GOFormat *fmt); GogAxisSet gog_axis_set_from_str (char const *str); void gog_axis_set_polar_unit (GogAxis *axis,GogAxisPolarUnit unit);
An axis of a GogPlot. The axis handles things like the bounds, ticks, and tick value formats. When used in plots with X/Y/Z axes, it can optionally have one GogLabel objects in the role "Label".
typedef enum {
GOG_AXIS_ELEM_MIN = 0,
GOG_AXIS_ELEM_MAX,
GOG_AXIS_ELEM_MAJOR_TICK,
GOG_AXIS_ELEM_MINOR_TICK,
GOG_AXIS_ELEM_CROSS_POINT,
GOG_AXIS_ELEM_MAX_ENTRY
} GogAxisElemType;
The indices of the GOData associated to the axis.
| minimum value. | |
| maximum value. | |
| distance between two major ticks. | |
| distance between two minor ticks. | |
| position of the other axis crossing. | |
| maximum value, should not occur. |
typedef enum {
GOG_AXIS_POLAR_UNIT_DEGREES,
GOG_AXIS_POLAR_UNIT_RADIANS,
GOG_AXIS_POLAR_UNIT_GRADS,
GOG_AXIS_POLAR_UNIT_MAX
} GogAxisPolarUnit;
typedef struct {
double position;
GogAxisTickTypes type;
GOString *str;
} GogAxisTick;
| position on the axis. | |
GogAxisTickTypes |
GogAxisTickTypes |
GOString * |
label, might be rich text. |
typedef enum {
GOG_AXIS_SET_UNKNOWN = -1,
GOG_AXIS_SET_NONE = 0,
GOG_AXIS_SET_X = (1 << GOG_AXIS_X),
GOG_AXIS_SET_XY = (1 << GOG_AXIS_X) | (1 << GOG_AXIS_Y),
GOG_AXIS_SET_XY_pseudo_3d = (1 << GOG_AXIS_X) | (1 << GOG_AXIS_Y) | (1 << GOG_AXIS_PSEUDO_3D),
GOG_AXIS_SET_XY_COLOR = (1 << GOG_AXIS_X) | (1 << GOG_AXIS_Y) | (1 << GOG_AXIS_COLOR),
GOG_AXIS_SET_XY_BUBBLE = (1 << GOG_AXIS_X) | (1 << GOG_AXIS_Y) | (1 << GOG_AXIS_BUBBLE),
GOG_AXIS_SET_XYZ = (1 << GOG_AXIS_X) | (1 << GOG_AXIS_Y) | (1 << GOG_AXIS_Z),
GOG_AXIS_SET_RADAR = (1 << GOG_AXIS_CIRCULAR) | (1 << GOG_AXIS_RADIAL),
GOG_AXIS_SET_FUNDAMENTAL = ((1 << GOG_AXIS_VIRTUAL) - 1),
GOG_AXIS_SET_ALL = ((1 << GOG_AXIS_TYPES) -1)
} GogAxisSet;
Gives the needed axes for a plot.
| unkown, should not occur. | |
| no axis. | |
| only an X axis. | |
| both X and Y axes. | |
| X, Y, and pseudo-3D axes. | |
| X, Y, and color axes. | |
| X, Y, and bubble axes. | |
| X, Y, and Z axes. | |
| circular and radial axes. | |
| mask for all fundamental axes. | |
| mask for all known axis types. |
typedef enum {
GOG_AXIS_UNKNOWN = -1,
GOG_AXIS_X = 0,
GOG_AXIS_Y,
GOG_AXIS_Z,
GOG_AXIS_CIRCULAR,
GOG_AXIS_RADIAL,
GOG_AXIS_VIRTUAL,
GOG_AXIS_PSEUDO_3D = GOG_AXIS_VIRTUAL,
GOG_AXIS_COLOR,
GOG_AXIS_BUBBLE,
GOG_AXIS_TYPES
} GogAxisType;
| invalid, should not occur. | |
| X axis. | |
| Y axis. | |
| Z axis. | |
| circular axis/ | |
| radial axis. | |
| start of virtual axes. | |
| pseudo-3d axis. | |
| color axis. | |
| bubble axis. | |
| maximum value, should not occur. |
void gog_axis_add_contributor (GogAxis *axis,GogObject *contrib);
Register contrib as taking part in the negotiation of axis's bounds.
GSList const * gog_axis_contributors (GogAxis *axis);
|
GogAxis |
Returns : |
the list of the axis contributors. [element-type GogObject][transfer none GogObject] |
void gog_axis_del_contributor (GogAxis *axis,GogObject *contrib);
contrib no longer takes part in the negotiation of axis's bounds.
gboolean gog_axis_get_bounds (GogAxis const *axis,double *minima,double *maxima);
GogAxisColorMap const * gog_axis_get_color_map (GogAxis *axis);
Retrieves the GogAxisColorMap associated to the axis or NULL.
|
a GogAxis |
Returns : |
the color map used by the axis if any. [transfer none] |
const GODateConventions * gog_axis_get_date_conv (GogAxis const *axis);
|
|
Returns : |
GOFormat * gog_axis_get_effective_format (GogAxis const *axis);
|
GogAxis |
Returns : |
the GOFormat used for the axis labels. Differs from gog_axis_get_format in that it never returns a general format (see go_format_is_general). [transfer none] |
void gog_axis_get_effective_span (GogAxis const *axis,double *start,double *end);
|
|
|
|
|
double gog_axis_get_entry (GogAxis const *axis,GogAxisElemType i,gboolean *user_defined);
|
GogAxis |
|
an optionally NULL pointr to gboolean |
Returns : |
the value of axis element i and sets user_defined or
NaN on error
|
GOFormat * gog_axis_get_format (GogAxis const *axis);
|
GogAxis |
Returns : |
the format assigned to axis but does not add
a reference. [transfer none]
|
GogGridLine * gog_axis_get_grid_line (GogAxis *axis,gboolean major);
|
GogAxis |
|
whether to retrieve major or minor grid line. |
Returns : |
a pointer to GridLine object associated to given axis, NULL if it doesn't exists. [transfer none] |
GOData * gog_axis_get_labels (GogAxis const *axis,GogPlot **plot_that_labeled_axis);
double gog_axis_get_polar_perimeter (GogAxis *axis);
|
|
Returns : |
GogAxisPolarUnit gog_axis_get_polar_unit (GogAxis *axis);
|
a GogAxis |
Returns : |
unit of axis if it's a circular axis of a polar
axis set, -1 otherwise.
|
unsigned gog_axis_get_ticks (GogAxis *axis,GogAxisTick **ticks);
An accessor to axis->ticks.
|
GogAxis |
|
an array of GogAxisTick |
Returns : |
number of ticks |
gboolean gog_axis_is_center_on_ticks (GogAxis const *axis);
|
GogAxis |
Returns : |
TRUE if labels are centered on ticks when axis is discrete
|
gboolean gog_axis_is_discrete (GogAxis const *axis);
|
GogAxis |
Returns : |
TRUE if axis enumerates a set of discrete items, rather than a
continuous value
|
gboolean gog_axis_is_inverted (GogAxis const *axis);
|
GogAxis |
Returns : |
TRUE if axis is inverted.
|
void gog_axis_set_bounds (GogAxis *axis,double minimum,double maximum);
Sets axis bounds. If minimum or maximum are not finite values, corresponding bound remains unchanged.
|
GogAxis |
|
axis low bound |
|
axis high bound |
void gog_axis_set_extents (GogAxis *axis,double start,double stop);
Set axis exents. It's a convenience function that sets axis bounds taking into account invert flag.
|
GogAxis |
|
axis start bound |
|
axis stop bound |
gboolean gog_axis_set_format (GogAxis *axis,GOFormat *fmt);
Absorbs a reference to fmt, and accepts NULL.
void gog_axis_set_polar_unit (GogAxis *axis,GogAxisPolarUnit unit);
Sets unit of a circular axis. See GogAxisPolarUnit for valid values.
|
a GogAxis |
|
GogAxisPolarUnit |