BScatterSeries

BScatterSeries — Object holding X and Y data for a scatter/line plot.

Functions

BData * b_scatter_series_set_x_array ()
BData * b_scatter_series_set_y_array ()
void b_scatter_series_set_line_color_from_string ()
void b_scatter_series_set_marker_color_from_string ()
gboolean b_scatter_series_get_show ()

Properties

BDashing dashing Read / Write / Construct
gboolean draw-line Read / Write / Construct
gchar * label Read / Write
gpointer line-color Read / Write
gdouble line-width Read / Write / Construct
BMarker marker Read / Write / Construct
gpointer marker-color Read / Write
gdouble marker-size Read / Write / Construct
gboolean show Read / Write / Construct
BVector * x-data Read / Write
BData * x-err Read / Write
BVector * y-data Read / Write
BData * y-err Read / Write

Types and Values

  BScatterSeries
enum BMarker
enum BDashing

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── BScatterSeries

Description

Controls for a pair of X and Y data shown in a line/scatter plot. Holds X and Y vectors and style information.

Functions

b_scatter_series_set_x_array ()

BData *
b_scatter_series_set_x_array (BScatterSeries *ss,
                              const double *arr,
                              guint n);

Creates a BValVector and adds to the series as its X vector.

Parameters

ss

a BScatterSeries

  

arr

array of doubles.

[array length=n]

n

length of array

  

Returns

the BValVector as a BData.

[transfer none]

b_scatter_series_set_y_array ()

BData *
b_scatter_series_set_y_array (BScatterSeries *ss,
                              const double *arr,
                              guint n);

Creates a BValVector and adds to the series as its Y vector.

Parameters

ss

a BScatterSeries

  

arr

array of doubles.

[array length=n]

n

length of array

  

Returns

the BValVector as a BData.

[transfer none]

b_scatter_series_set_line_color_from_string ()

void
b_scatter_series_set_line_color_from_string
                               (BScatterSeries *ss,
                                gchar *colorstring);

Set the color to use to draw the line in a scatter plot for the data in ss .

Parameters

ss

a BScatterSeries

  

colorstring

a string specifying a color, e.g. "ff0000"

  

b_scatter_series_set_marker_color_from_string ()

void
b_scatter_series_set_marker_color_from_string
                               (BScatterSeries *ss,
                                gchar *colorstring);

Set the color to use to draw markers in a scatter plot for the data in ss .

Parameters

ss

a BScatterSeries

  

colorstring

a string specifying a color, e.g. "ff0000"

  

b_scatter_series_get_show ()

gboolean
b_scatter_series_get_show (BScatterSeries *ss);

Get whether to actually draw the series.

Returns TRUE if the series should be drawn.

Parameters

ss

a BScatterSeries

  

Types and Values

BScatterSeries

typedef struct _BScatterSeries BScatterSeries;

enum BMarker

Enum values used to specify whether and what to use for the marker in a scatter plot.

Members

B_MARKER_NONE

no marker

  

B_MARKER_CIRCLE

a filled circle

  

B_MARKER_SQUARE

a filled square

  

B_MARKER_DIAMOND

a filled diamond

  

B_MARKER_X

a filled X

  

B_MARKER_PLUS

a plus symbol

  

B_MARKER_OPEN_CIRCLE

an unfilled circle

  

B_MARKER_OPEN_SQUARE

an unfilled square

  

B_MARKER_OPEN_DIAMOND

an unfilled diamond

  

enum BDashing

Enum values used to specify line dashing in a scatter plot.

Members

B_DASHING_SOLID

solid line

  

B_DASHING_DOTTED

a dotted line

  

B_DASHING_DASHED

a dashed line

  

B_DASHING_DOT_DASH

a dot-dashed line

  

Property Details

The “dashing” property

  “dashing”                  BDashing

Preset line dashing.

Flags: Read / Write / Construct

Default value: B_DASHING_SOLID

The “draw-line” property

  “draw-line”                gboolean

Whether to draw a line between points.

Flags: Read / Write / Construct

Default value: TRUE

The “label” property

  “label”                    gchar *

The string associated with the series. Used, for example, in the legend.

Flags: Read / Write

Default value: "Untitled"

The “line-color” property

  “line-color”               gpointer

The line color.

Flags: Read / Write

The “line-width” property

  “line-width”               gdouble

The line width in pixels.

Flags: Read / Write / Construct

Allowed values: [0,100]

Default value: 1

The “marker” property

  “marker”                   BMarker

The marker.

Flags: Read / Write / Construct

Default value: B_MARKER_NONE

The “marker-color” property

  “marker-color”             gpointer

The marker color.

Flags: Read / Write

The “marker-size” property

  “marker-size”              gdouble

The marker size in pixels.

Flags: Read / Write / Construct

Allowed values: [1,100]

Default value: 5

The “show” property

  “show”                     gboolean

Whether to draw the series.

Flags: Read / Write / Construct

Default value: TRUE

The “x-data” property

  “x-data”                   BVector *

Vector for horizontal axis.

Flags: Read / Write

The “x-err” property

  “x-err”                    BData *

Error bar data for horizontal axis. Can be a #YScalar or #YVector.

Flags: Read / Write

The “y-data” property

  “y-data”                   BVector *

Vector for vertical axis.

Flags: Read / Write

The “y-err” property

  “y-err”                    BData *

Error bar data for vertical axis. Can be a #YScalar or #YVector.

Flags: Read / Write

Generated by GTK-Doc V1.28