GogAxis: Goffice Reference Manual

Functions

GogAxisType	gog_axis_get_atype ()
gboolean	gog_axis_is_center_on_ticks ()
gboolean	gog_axis_is_discrete ()
gboolean	gog_axis_is_inverted ()
gboolean	gog_axis_get_bounds ()
void	gog_axis_set_bounds ()
void	gog_axis_set_extents ()
GOFormat *	gog_axis_get_format ()
gboolean	gog_axis_set_format ()
unsigned	gog_axis_get_ticks ()
GOData *	gog_axis_get_labels ()
double	gog_axis_get_entry ()
void	gog_axis_add_contributor ()
void	gog_axis_del_contributor ()
GSList const *	gog_axis_contributors ()
void	gog_axis_clear_contributors ()
void	gog_axis_bound_changed ()
GogGridLine *	gog_axis_get_grid_line ()
double	gog_axis_get_circular_rotation ()
const GODateConventions *	gog_axis_get_date_conv ()
GOFormat *	gog_axis_get_effective_format ()
double	gog_axis_get_polar_perimeter ()
void	gog_axis_set_polar_unit ()
GogAxisPolarUnit	gog_axis_get_polar_unit ()

Properties

gchar *	assigned-format-string-XL	Read / Write
gdouble	circular-rotation	Read / Write
gboolean	invert-axis	Read / Write
gchar *	map-name	Read / Write
gchar *	polar-unit	Read / Write
gint	type	Read / Write

Types and Values

	GogAxis
enum	GogAxisSet
enum	GogAxisType
enum	GogAxisElemType
enum	GogAxisPolarUnit

Object Hierarchy

    GObject
    ╰── GogObject
        ╰── GogStyledObject
            ╰── GogAxisBase
                ╰── GogAxis

Implemented Interfaces

GogAxis implements GOStyledObject and GogDataset.

Description

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".

Functions

gog_axis_get_atype ()

GogAxisType
gog_axis_get_atype (GogAxis const *axis);

gog_axis_is_center_on_ticks ()

gboolean
gog_axis_is_center_on_ticks (GogAxis const *axis);

Parameters

axis

GogAxis

Returns

TRUE if labels are centered on ticks when axis is discrete

gog_axis_is_discrete ()

gboolean
gog_axis_is_discrete (GogAxis const *axis);

Parameters

axis

GogAxis

Returns

TRUE if axis enumerates a set of discrete items, rather than a continuous value

gog_axis_is_inverted ()

gboolean
gog_axis_is_inverted (GogAxis const *axis);

Parameters

axis

GogAxis

Returns

TRUE if axis is inverted.

gog_axis_get_bounds ()

gboolean
gog_axis_get_bounds (GogAxis const *axis,
                     double *minima,
                     double *maxima);

Parameters

axis	GogAxis
minima	non-NULL storage for result
maxima	non-NULL storage for result

Returns

TRUE if the bounds stored in minima and maxima are sane

gog_axis_set_bounds ()

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.

Parameters

axis	GogAxis
minimum	axis low bound
maximum	axis high bound

gog_axis_set_extents ()

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.

Parameters

axis	GogAxis
start	axis start bound
stop	axis stop bound

gog_axis_get_format ()

GOFormat *
gog_axis_get_format (GogAxis const *axis);

Parameters

axis

GogAxis

Returns

the format assigned to axis but does not add a reference.

gog_axis_set_format ()

gboolean
gog_axis_set_format (GogAxis *axis,
                     GOFormat *fmt);

Absorbs a reference to fmt , and accepts NULL.

Parameters

axis	GogAxis
fmt	GOFormat

Returns

TRUE if things changed

gog_axis_get_ticks ()

unsigned
gog_axis_get_ticks (GogAxis *axis,
                    GogAxisTick **ticks);

An accessor to axis->ticks .

Parameters

axis	GogAxis
ticks	an array of GogAxisTick

Returns

number of ticks

gog_axis_get_labels ()

GOData *
gog_axis_get_labels (GogAxis const *axis,
                     GogPlot **plot_that_labeled_axis);

Parameters

axis	a GogAxis
plot_that_labeled_axis	a GogPlot

Returns

the possibly NULL GOData used as a label for this axis along with the plot that it was associated with

gog_axis_get_entry ()

double
gog_axis_get_entry (GogAxis const *axis,
                    GogAxisElemType i,
                    gboolean *user_defined);

Parameters

axis	GogAxis
user_defined	an optionally NULL pointr to gboolean

Returns

the value of axis element i and sets user_defined or NaN on error

gog_axis_add_contributor ()

void
gog_axis_add_contributor (GogAxis *axis,
                          GogObject *contrib);

Register contrib as taking part in the negotiation of axis 's bounds.

Parameters

axis	GogAxis
contrib	GogObject (can we relax this to use an interface ?)

gog_axis_del_contributor ()

void
gog_axis_del_contributor (GogAxis *axis,
                          GogObject *contrib);

contrib no longer takes part in the negotiation of axis 's bounds.

Parameters

axis	GogAxis
contrib	GogObject (can we relax this to use an interface ?)

gog_axis_contributors ()

GSList const *
gog_axis_contributors (GogAxis *axis);

gog_axis_clear_contributors ()

void
gog_axis_clear_contributors (GogAxis *axis);

gog_axis_bound_changed ()

void
gog_axis_bound_changed (GogAxis *axis,
                        GogObject *contrib);

Parameters

axis	GogAxis
contrib	GogObject

gog_axis_get_grid_line ()

GogGridLine *
gog_axis_get_grid_line (GogAxis *axis,
                        gboolean major);

gog_axis_get_circular_rotation ()

double
gog_axis_get_circular_rotation (GogAxis *axis);

Parameters

axis

a GogAxis

Returns

rotation of a circular GogAxis.

gog_axis_get_date_conv ()

const GODateConventions *
gog_axis_get_date_conv (GogAxis const *axis);

gog_axis_get_effective_format ()

GOFormat *
gog_axis_get_effective_format (GogAxis const *axis);

gog_axis_get_polar_perimeter ()

double
gog_axis_get_polar_perimeter (GogAxis *axis);

gog_axis_set_polar_unit ()

void
gog_axis_set_polar_unit (GogAxis *axis,
                         GogAxisPolarUnit unit);

Sets unit of a circular axis. See GogAxisPolarUnit for valid values.

Parameters

axis	a GogAxis
unit	GogAxisPolarUnit

gog_axis_get_polar_unit ()

GogAxisPolarUnit
gog_axis_get_polar_unit (GogAxis *axis);

Parameters

axis

a GogAxis

Returns

unit of axis if it's a circular axis of a polar axis set, -1 otherwise.

Types and Values

GogAxis

typedef struct _GogAxis GogAxis;

enum GogAxisSet

Members

GOG_AXIS_SET_UNKNOWN
GOG_AXIS_SET_NONE
GOG_AXIS_SET_X
GOG_AXIS_SET_XY
GOG_AXIS_SET_XY_pseudo_3d
GOG_AXIS_SET_XY_COLOR
GOG_AXIS_SET_XY_BUBBLE
GOG_AXIS_SET_XYZ
GOG_AXIS_SET_RADAR
GOG_AXIS_SET_FUNDAMENTAL
GOG_AXIS_SET_ALL

enum GogAxisType

Members

GOG_AXIS_UNKNOWN
GOG_AXIS_X
GOG_AXIS_Y
GOG_AXIS_Z
GOG_AXIS_CIRCULAR
GOG_AXIS_RADIAL
GOG_AXIS_VIRTUAL
GOG_AXIS_PSEUDO_3D
GOG_AXIS_COLOR
GOG_AXIS_BUBBLE
GOG_AXIS_TYPES

enum GogAxisElemType

Members

GOG_AXIS_ELEM_MIN
GOG_AXIS_ELEM_MAX
GOG_AXIS_ELEM_MAJOR_TICK
GOG_AXIS_ELEM_MINOR_TICK
GOG_AXIS_ELEM_CROSS_POINT
GOG_AXIS_ELEM_MAX_ENTRY

enum GogAxisPolarUnit

Members

GOG_AXIS_POLAR_UNIT_DEGREES
GOG_AXIS_POLAR_UNIT_RADIANS
GOG_AXIS_POLAR_UNIT_GRADS
GOG_AXIS_POLAR_UNIT_MAX

Property Details

The `“assigned-format-string-XL”` property

  “assigned-format-string-XL” gchar *

The user assigned format to use for non-discrete axis labels (XL format).

Flags: Read / Write

Default value: "General"

The `“circular-rotation”` property

  “circular-rotation”        gdouble

Rotation of circular axis.

Flags: Read / Write

Allowed values: [-180,180]

Default value: 0

The `“invert-axis”` property

  “invert-axis”              gboolean

Scale from high to low rather than low to high.

Flags: Read / Write

Default value: FALSE

The `“map-name”` property

  “map-name”                 gchar *

The name of the map for scaling.

Flags: Read / Write

Default value: "linear"

The `“polar-unit”` property

  “polar-unit”               gchar *

Polar axis set unit.

Flags: Read / Write

Default value: "Degrees"

The `“type”` property

  “type”                     gint

Numerical type of this axis.

Flags: Read / Write

Allowed values: [-1,8]

Default value: -1

GogAxis

Functions

Properties

Types and Values

Object Hierarchy

Implemented Interfaces

Description

Functions

gog_axis_get_atype ()

gog_axis_is_center_on_ticks ()

Parameters

Returns

gog_axis_is_discrete ()

Parameters

Returns

gog_axis_is_inverted ()

Parameters

Returns

gog_axis_get_bounds ()

Parameters

Returns

gog_axis_set_bounds ()

Parameters

gog_axis_set_extents ()

Parameters

gog_axis_get_format ()

Parameters

Returns

gog_axis_set_format ()

Parameters

Returns

gog_axis_get_ticks ()

Parameters

Returns

gog_axis_get_labels ()

Parameters

Returns

gog_axis_get_entry ()

Parameters

Returns

gog_axis_add_contributor ()

Parameters

gog_axis_del_contributor ()

Parameters

gog_axis_contributors ()

gog_axis_clear_contributors ()

gog_axis_bound_changed ()

Parameters

gog_axis_get_grid_line ()

gog_axis_get_circular_rotation ()

Parameters

Returns

gog_axis_get_date_conv ()

gog_axis_get_effective_format ()

gog_axis_get_polar_perimeter ()

gog_axis_set_polar_unit ()

Parameters

gog_axis_get_polar_unit ()

Parameters

Returns

Types and Values

GogAxis

enum GogAxisSet

Members

enum GogAxisType

Members

enum GogAxisElemType

Members

enum GogAxisPolarUnit

Members

Property Details

The “assigned-format-string-XL” property

The “circular-rotation” property

The “invert-axis” property

The “map-name” property

The “polar-unit” property

The “type” property

The `“assigned-format-string-XL”` property

The `“circular-rotation”` property

The `“invert-axis”` property

The `“map-name”` property

The `“polar-unit”` property

The `“type”` property