NAME

cxGeoPlotDataStrSet - use a string to set an attribute of the current dataset to be plotted

C SPECIFICATION

#include <cx/Geometry.h>

enum cxGeoDataSetting
{
 CX_GEO_DATA_LSTYLE,
 CX_GEO_DATA_MARKERS,
 CX_GEO_DATA_LINE_COLOR,
 CX_GEO_DATA_LINE_PATTERN,
 CX_GEO_DATA_LINE_WIDTH,
 CX_GEO_DATA_MARKER_COLOR,
 CX_GEO_DATA_FILLED,
 CX_GEO_DATA_LABEL,
 CX_GEO_DATA_FILL_COLOR,
 CX_GEO_DATA_FILL_VALUE,
};

cxErrorCode cxGeoPlotDataStrSet (cxGeoPlotSetting type, char* str)

PARAMETERS

type

The attribute of the current dataset to be set.

str

A string to be used to set the attribute.

FUNCTION RETURN VALUE

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

DESCRIPTION

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

CX_GEO_DATA_LABEL

The dataset label is used by the plot legend to identify the curve for this dataset. The legend may be added via a call to cxGeoPlotLegendAdd (3E).

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

SEE ALSO

cxGeoPlotBegin (3E), cxGeoPlotGetLastError (3E), cxGeoPlotLegendAdd (3E), cxGeoPlotDefine (3E)

The source of the LineGraph module may be found at $EXPLORERHOME/src/LineGraph/linegraph.c (UNIX) and %EXPLORERHOME%\src\LineGraph\linegraph.c (NT). It illustrates the use of many of the cxGeoPlot* routines.

Last modified: Aug 04 14:57 1999
[ Documentation Home ]