## GogSeriesLabels

GogSeriesLabels

## Synopsis

                        GogDataLabel;
                        GogSeriesLabelElt;
    enum                GogSeriesLabelsPos;
                        GogSeriesLabels;
    GogSeriesLabelElt const * gog_data_label_get_element    (GogDataLabel const *lbl);
    GogSeriesLabelsPos  gog_data_label_get_position         (GogDataLabel const *lbl);
    void                gog_data_label_set_allowed_position (GogDataLabel *lbl,
                                                             unsigned  allowed);
    void                gog_data_label_set_default_position (GogDataLabel *lbl,
                                                             GogSeriesLabelsPos pos);
    void                gog_data_label_set_position         (GogDataLabel *lbl,
                                                             GogSeriesLabelsPos pos);
    GogSeriesLabelsPos  gog_series_labels_get_position      (GogSeriesLabels const *lbls);
    GogSeriesLabelElt const * gog_series_labels_scalar_get_element
                                                            (GogSeriesLabels const *lbls);
    void                gog_series_labels_set_allowed_position
                                                            (GogSeriesLabels *lbls,
                                                             unsigned  allowed);
    void                gog_series_labels_set_default_position
                                                            (GogSeriesLabels *lbls,
                                                             GogSeriesLabelsPos pos);
    void                gog_series_labels_set_position      (GogSeriesLabels *lbls,
                                                             GogSeriesLabelsPos pos);
    GogSeriesLabelElt const * gog_series_labels_vector_get_element
                                                            (GogSeriesLabels const *lbls,
                                                             unsigned  n);

## Object Hierarchy

      GObject
       +----GogObject
             +----GogStyledObject
                   +----GogOutlinedObject
                         +----GogDataLabel

      GBoxed
       +----GogSeriesLabelElt

      GObject
       +----GogObject
             +----GogStyledObject
                   +----GogOutlinedObject
                         +----GogSeriesLabels

## Implemented Interfaces

GogDataLabel implements GOStyledObject and GogDataset.

GogSeriesLabels implements GOStyledObject and GogDataset.

## Properties

      "format"                   gchar*                : Read / Write
      "index"                    gint                  : Read / Write
      "offset"                   guint                 : Read / Write
      "position"                 gchar*                : Read / Write
      "format"                   gchar*                : Read / Write
      "offset"                   guint                 : Read / Write
      "position"                 gchar*                : Read / Write

## Description

## Details

### GogDataLabel

    typedef struct _GogDataLabel GogDataLabel;

### GogSeriesLabelElt

    typedef struct {
    	GOString *str;
    	int legend_pos;
    	GogObject *point;
    } GogSeriesLabelElt;

GOString *`str`; | the string to display.
int `legend_pos`; | the label position.
GogObject *`point`; | GogObject }

### enum GogSeriesLabelsPos

    typedef enum {
    	GOG_SERIES_LABELS_DEFAULT_POS = 0,
    	GOG_SERIES_LABELS_CENTERED = 1,
    	GOG_SERIES_LABELS_TOP = 1 << 1,
    	GOG_SERIES_LABELS_BOTTOM = 1 << 2,
    	GOG_SERIES_LABELS_LEFT = 1 << 3,
    	GOG_SERIES_LABELS_RIGHT = 1 << 4,
    	GOG_SERIES_LABELS_OUTSIDE = 1 << 5,
    	GOG_SERIES_LABELS_INSIDE = 1 << 6,
    	GOG_SERIES_LABELS_NEAR_ORIGIN = 1 << 7,
    } GogSeriesLabelsPos;

`GOG_SERIES_LABELS_DEFAULT_POS` | default position.
`GOG_SERIES_LABELS_CENTERED` | centered.
`GOG_SERIES_LABELS_TOP` | at top.
`GOG_SERIES_LABELS_BOTTOM` | at bottom.
`GOG_SERIES_LABELS_LEFT` | at left.
`GOG_SERIES_LABELS_RIGHT` | at right.
`GOG_SERIES_LABELS_OUTSIDE` | outside the element.
`GOG_SERIES_LABELS_INSIDE` | inside the element.
`GOG_SERIES_LABELS_NEAR_ORIGIN` | near origin.

### GogSeriesLabels

    typedef struct _GogSeriesLabels GogSeriesLabels;

### gog_data_label_get_element ()

    GogSeriesLabelElt const * gog_data_label_get_element    (GogDataLabel const *lbl);

### gog_data_label_get_position ()

    GogSeriesLabelsPos  gog_data_label_get_position         (GogDataLabel const *lbl);

### gog_data_label_set_allowed_position ()

    void                gog_data_label_set_allowed_position (GogDataLabel *lbl,
                                                             unsigned  allowed);

### gog_data_label_set_default_position ()

    void                gog_data_label_set_default_position (GogDataLabel *lbl,
                                                             GogSeriesLabelsPos pos);

### gog_data_label_set_position ()

    void                gog_data_label_set_position         (GogDataLabel *lbl,
                                                             GogSeriesLabelsPos pos);

### gog_series_labels_get_position ()

    GogSeriesLabelsPos  gog_series_labels_get_position      (GogSeriesLabels const *lbls);

### gog_series_labels_scalar_get_element ()

    GogSeriesLabelElt const * gog_series_labels_scalar_get_element
                                                            (GogSeriesLabels const *lbls);

### gog_series_labels_set_allowed_position ()

    void                gog_series_labels_set_allowed_position
                                                            (GogSeriesLabels *lbls,
                                                             unsigned  allowed);

### gog_series_labels_set_default_position ()

    void                gog_series_labels_set_default_position
                                                            (GogSeriesLabels *lbls,
                                                             GogSeriesLabelsPos pos);

### gog_series_labels_set_position ()

    void                gog_series_labels_set_position      (GogSeriesLabels *lbls,
                                                             GogSeriesLabelsPos pos);

### gog_series_labels_vector_get_element ()

    GogSeriesLabelElt const * gog_series_labels_vector_get_element
                                                            (GogSeriesLabels const *lbls,
                                                             unsigned  n);

## Property Details

### The `"format"` property

      "format"                   gchar*                : Read / Write

Label format.

Default value: ""

### The `"index"` property

      "index"                    gint                  : Read / Write

Index of the corresponding data element.

Allowed values: >= 0

Default value: 0

### The `"offset"` property

      "offset"                   guint                 : Read / Write

Offset to add to the label position.

Allowed values: <= 20

Default value: 0

### The `"position"` property

      "position"                 gchar*                : Read / Write

Position of the label relative to the data graphic element.

Default value: "default"

### The `"format"` property

      "format"                   gchar*                : Read / Write

Label format.

Default value: ""

### The `"offset"` property

      "offset"                   guint                 : Read / Write

Offset to add to the label position.

Allowed values: <= 20

Default value: 0

### The `"position"` property

      "position"                 gchar*                : Read / Write

Position of the label relative to the data graphic element.

Default value: "default"