NAME

cxGeoPlotStrSet - set an attribute of the current plot using a string

C SPECIFICATION

#include <cx/Geometry.h>

enum cxGeoPlotSetting
{
 CX_GEO_PLOT_AXIS_COLOR,
 CX_GEO_PLOT_GRID_COLOR,
 CX_GEO_PLOT_GRID_PATTERN,
 CX_GEO_PLOT_GRID_LINE_WIDTH,
 CX_GEO_PLOT_AXIS_LINE_WIDTH,
 CX_GEO_PLOT_XAXIS_LABEL,
 CX_GEO_PLOT_YAXIS_LABEL,
 CX_GEO_PLOT_XMARGIN,
 CX_GEO_PLOT_YMARGIN,
 CX_GEO_PLOT_XMIN,
 CX_GEO_PLOT_XMAX,
 CX_GEO_PLOT_YMIN,
 CX_GEO_PLOT_YMAX,
 CX_GEO_PLOT_XGRID_VISIBLE,
 CX_GEO_PLOT_YGRID_VISIBLE,
 CX_GEO_PLOT_XAXIS_TYPE,
 CX_GEO_PLOT_YAXIS_TYPE,
 CX_GEO_PLOT_XAXIS_ARROW,
 CX_GEO_PLOT_YAXIS_ARROW,
 CX_GEO_PLOT_XAXIS_INVERSE_TICKS,
 CX_GEO_PLOT_YAXIS_INVERSE_TICKS,
 CX_GEO_PLOT_XAXIS_LABEL_CENTRE,
 CX_GEO_PLOT_YAXIS_LABEL_CENTRE,
 CX_GEO_PLOT_XAXIS_SCALE,
 CX_GEO_PLOT_YAXIS_SCALE,
 CX_GEO_PLOT_LEGEND_BORDER_COLOR,
 CX_GEO_PLOT_LEGEND_BACK_COLOR,
 CX_GEO_PLOT_LEGEND_TEXT_COLOR,
};

cxErrorCode cxGeoPlotStrSet (cxGeoPlotSetting type, char* str)

PARAMETERS

type: The attribute of the current plot to be set.
str: A string to be used to set the attribute.

FUNCTION RETURN VALUE

cxGeoPlotStrSet returns a pointer to an error code. This is an enumerated integer with cx_err_none (zero) indicating success. Any other value indicates an improper input (see below) or the absence of a prior call to cxGeoPlotBegin (3E). A description of the error can be obtained by immediately calling cxGeoPlotGetLastError (3E).

DESCRIPTION

This function sets an attribute of the current plot using a string. Meaningful results will only be obtained for those attributes that require a string value. These are:

`CX_GEO_PLOT_XAXIS_LABEL`	- the label for the X axis (if present)
`CX_GEO_PLOT_YAXIS_LABEL`	- the label for the Y axis (if present)

Attempting to set other attributes using this function will generate an error..

NAME

C SPECIFICATION

PARAMETERS

FUNCTION RETURN VALUE

DESCRIPTION

SEE ALSO