CPlotView:Line

The Line methods creates a line plot by drawing markers with line segments between them. This is CPlotView class version of the non-class line function. The x and y points at the same array index are presumed to correspond to the same point. This function also can plot x and y error bars. The data for x, y, x error bars, and y error bars are each held in a 1-dimensional array. The PlotLine method takes its data from the CPlotView class data matrix rather than from x and y tables. Also see the Connect, Scatter, and StepLine commands in the CPlotView class.

This method creates a new plot window and returns a CPlot object for plot series it creates. This object can be used to enhance or add to the plot or extract plot data for further analysis.

Syntax

CPlot = CPlotView:Line( x, y )

CPlot = CPlotView:Line( x, y, xe )

CPlot = CPlotView:Line( x, y, xe, ye )

CPlot = CPlotView:Line( x, y, xe, ye, sLabelX )

CPlot = CPlotView:Line( x, y, xe, ye, sLabelX, sLabelY )

CPlot = CPlotView:Line( x, y, xe, ye, sLabelX, sLabelY, sCaption )

CPlot = CPlotView:Line( x, y, xe, ye, sLabelX, sLabelY, sCaption, sWindowTitle )

x is a 1-dimensional array containing the x values.

y is a 1-dimensional array containing the x values.

xe is an optional 1-dimensional array containing the x error bar values.

ye is an optional 1-dimensional array containing the y error bar values.

sLabelX is an optional label for the x axis.

sLabelY is an optional label for the y axis.

sCaption is an optional plot caption.

sWindowTitle is an optional plot window title.

Parameters that are nil or missing to the right adopt default values.

Return Values:

CPlot is a new CPlot object attached to the current plot series. It is nil on failure.

Remarks

This function creates a quick plot using just one line of code. The returned parameters permit access to the plotted data. You can also change the plot properties including the marker attributes, labels, scaling, and others using commands such as Series Attributes and Plot Attributes.

Only the first 2 arguments, the (x,y) data, are required. If you want to use the other arguments, you must include a placeholder to fill any holes between the arguments. For example, to include y error bars but not x error bars, use nil in place of the xe parameter.

Examples

The script below creates some data from the random number generator and creates a line plot with default plot labels. Since none of the optional parameters is used, only the x and y arrays need to be specified.

V = new_plotview()	-- create a CPlotView object.
x = random( 10, 10, 20 )	-- 10 values between 10 and 20
y = random( 10, 20, 40 )	-- 10 values between 20 and 40
V:Line( x, y )	-- create the line plot

The second example, below, repeats the above plot but adds axis labels and error bars on the y axis.

V = new_plotview()	-- create a CPlotView object.
x = random( 10, 10, 20 )	-- 10 values between 10 and 20
y = random( 10, 20, 40 )	-- 10 values between 20 and 40
ye = random( 10, 1, 3 )	-- 10 values between 1 and 3
V:Line( x, y, nil, ye, "My X", "My Y" )	-- create the line plot

Syntax

Remarks

Examples

Related Topics