## GogColorScale

GogColorScale — Displays the color scale used by an axis.

## Synopsis

                        GogColorScale;
    GogAxis *           gog_color_scale_get_axis            (GogColorScale *scale);
    void                gog_color_scale_set_axis            (GogColorScale *scale,
                                                             GogAxis *axis);

## Object Hierarchy

      GObject
       +----GogObject
             +----GogStyledObject
                   +----GogColorScale

## Implemented Interfaces

GogColorScale implements GOStyledObject.

## Properties

      "axis"                     gchar*                : Read / Write
      "horizontal"               gboolean              : Read / Write
      "tick-size-pts"            gint                  : Read / Write
      "width"                    gdouble               : Read / Write

## Description

A color scale has two parts: an axis, and a rectangle filled by the colors corresponding to the axis scale. It can be displayed horizontally or vertically.

## Details

### GogColorScale

    typedef struct _GogColorScale GogColorScale;

### gog_color_scale_get_axis ()

    GogAxis *           gog_color_scale_get_axis            (GogColorScale *scale);

Gets the axis mapping to the colors and associated with `scale`

`scale` : | GogColorScale
Returns : | the associated axis. [transfer none]

### gog_color_scale_set_axis ()

    void                gog_color_scale_set_axis            (GogColorScale *scale,
                                                             GogAxis *axis);

Associates the axis with `scale`.

`scale` : | GogColorScale
`axis` : | a color or pseudo-3d axis

## Property Details

### The `"axis"` property

      "axis"                     gchar*                : Read / Write

Reference to the color or pseudo-3d axis.

Default value: NULL

### The `"horizontal"` property

      "horizontal"               gboolean              : Read / Write

Whether to display the scale horizontally.

Default value: FALSE

### The `"tick-size-pts"` property

      "tick-size-pts"            gint                  : Read / Write

Size of the tick marks, in points.

Allowed values: [0,20]

Default value: 4

### The `"width"` property

      "width"                    gdouble               : Read / Write

Color scale thickness.

Allowed values: [1,255]

Default value: 10