|  |  |  | Goffice Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
GogAxis; enum GogAxisSet; enum GogAxisType; enum GogAxisElemType; GogAxisType gog_axis_get_atype (GogAxis const *axis); 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); gboolean gog_axis_get_bounds (GogAxis const *axis,double *minima,double *maxima); void gog_axis_set_bounds (GogAxis *axis,double minimum,double maximum); void gog_axis_set_extents (GogAxis *axis,double start,double stop); GOFormat * gog_axis_get_format (GogAxis const *axis); gboolean gog_axis_set_format (GogAxis *axis,GOFormat *fmt); unsigned gog_axis_get_ticks (GogAxis *axis,GogAxisTick **ticks); GOData * gog_axis_get_labels (GogAxis const *axis,GogPlot **plot_that_labeled_axis); double gog_axis_get_entry (GogAxis const *axis,GogAxisElemType i,gboolean *user_defined); void gog_axis_add_contributor (GogAxis *axis,GogObject *contrib); void gog_axis_del_contributor (GogAxis *axis,GogObject *contrib); GSList const * gog_axis_contributors (GogAxis *axis); void gog_axis_clear_contributors (GogAxis *axis); void gog_axis_bound_changed (GogAxis *axis,GogObject *contrib); GogGridLine * gog_axis_get_grid_line (GogAxis *axis,gboolean major); double gog_axis_get_circular_rotation (GogAxis *axis); const GODateConventions * gog_axis_get_date_conv (GogAxis const *axis); GOFormat * gog_axis_get_effective_format (GogAxis const *axis); enum GogAxisPolarUnit; double gog_axis_get_polar_perimeter (GogAxis *axis); void gog_axis_set_polar_unit (GogAxis *axis,GogAxisPolarUnit unit); GogAxisPolarUnit gog_axis_get_polar_unit (GogAxis *axis);
"assigned-format-string-XL" gchar* : Read / Write "circular-rotation" gdouble : Read / Write "invert-axis" gboolean : Read / Write "map-name" gchar* : Read / Write "polar-unit" gchar* : Read / Write "type" gint : Read / Write
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_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;
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;
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;
gboolean            gog_axis_is_center_on_ticks         (GogAxis const *axis);
| 
 | GogAxis | 
| Returns : | TRUE if labels are centered on ticks when axisis discrete | 
gboolean            gog_axis_is_discrete                (GogAxis const *axis);
| 
 | GogAxis | 
| Returns : | TRUE if axisenumerates a set of discrete items, rather than a
	continuous value | 
gboolean            gog_axis_is_inverted                (GogAxis const *axis);
| 
 | GogAxis | 
| Returns : | TRUE if axisis inverted. | 
gboolean gog_axis_get_bounds (GogAxis const *axis,double *minima,double *maxima);
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 | 
GOFormat *          gog_axis_get_format                 (GogAxis const *axis);
| 
 | GogAxis | 
| Returns : | the format assigned to axisbut does not add a reference. | 
gboolean gog_axis_set_format (GogAxis *axis,GOFormat *fmt);
Absorbs a reference to fmt, and accepts NULL.
unsigned gog_axis_get_ticks (GogAxis *axis,GogAxisTick **ticks);
An accessor to axis->ticks.
| 
 | GogAxis | 
| 
 | an array of GogAxisTick | 
| Returns : | number of ticks | 
GOData * gog_axis_get_labels (GogAxis const *axis,GogPlot **plot_that_labeled_axis);
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 iand setsuser_definedor
	NaN on error | 
void gog_axis_add_contributor (GogAxis *axis,GogObject *contrib);
Register contrib as taking part in the negotiation of axis's bounds.
void gog_axis_del_contributor (GogAxis *axis,GogObject *contrib);
contrib no longer takes part in the negotiation of axis's bounds.
GogGridLine * gog_axis_get_grid_line (GogAxis *axis,gboolean major);
| 
 | |
| 
 | |
| Returns : | 
const GODateConventions * gog_axis_get_date_conv        (GogAxis const *axis);
| 
 | |
| Returns : | 
GOFormat *          gog_axis_get_effective_format       (GogAxis const *axis);
| 
 | |
| Returns : | 
typedef enum {
	GOG_AXIS_POLAR_UNIT_DEGREES,
	GOG_AXIS_POLAR_UNIT_RADIANS,
	GOG_AXIS_POLAR_UNIT_GRADS,
	GOG_AXIS_POLAR_UNIT_MAX
} GogAxisPolarUnit;
double              gog_axis_get_polar_perimeter        (GogAxis *axis);
| 
 | |
| Returns : | 
void gog_axis_set_polar_unit (GogAxis *axis,GogAxisPolarUnit unit);
Sets unit of a circular axis. See GogAxisPolarUnit for valid values.
| 
 | a GogAxis | 
| 
 | GogAxisPolarUnit | 
GogAxisPolarUnit    gog_axis_get_polar_unit             (GogAxis *axis);
| 
 | a GogAxis | 
| Returns : | unit of axisif it's a circular axis of a polar
	axis set, -1 otherwise. | 
"assigned-format-string-XL" property"assigned-format-string-XL" gchar* : Read / Write
The user assigned format to use for non-discrete axis labels (XL format).
Default value: "General"
"circular-rotation" property"circular-rotation" gdouble : Read / Write
Rotation of circular axis.
Allowed values: [-180,180]
Default value: 0
"invert-axis" property"invert-axis" gboolean : Read / Write
Scale from high to low rather than low to high.
Default value: FALSE
"map-name" property"map-name" gchar* : Read / Write
The name of the map for scaling.
Default value: "linear"
"polar-unit" property"polar-unit" gchar* : Read / Write
Polar axis set unit.
Default value: "Degrees"
"type" property"type" gint : Read / Write
Numerical type of this axis.
Allowed values: [-1,8]
Default value: -1