line

line (LinePlot)

The line function creates a line plot by drawing line segments between data points. This is non-class equivalent of the CPlotView:Line method. The x and y points at the same array index are presumed to correspond to the same point. This function does not plot x or y error bars; to include error bars, use lineerr. The data for x and y are in a lua array (1-dimensional indexed table). This function creates a new plot window and returns a CPlotView object and CPlot object for the plot window and plot series it creates. This object can be used to enhance or add to the plot or extract plot data for further analysis. There are four similar versions of this command as shown in the Comparison of non-class plotting functions.

Syntax

CPlotView, CPlot = line( x, y )

CPlotView, CPlot = line( x, y, sLabelX )

CPlotView, CPlot = line( x, y, sLabelX, sLabelY )

CPlotView, CPlot = line( x, y, sLabelX, sLabelY, sCaption )

CPlotView, CPlot = line( x, y, sLabelX, sLabelY, sCaption, sWindowTitle )

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

y is a 1-dimensional array containing the x 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 are assigned default values.

Return Values:

CPlotView is a new CPlotView object attached to the plot window. It is nil on failure.

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 values of V and P provide access to the CPlotView window and current CPlot buffer. 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. Use a placeholder, like 0 or nil, to fill holes created by unused 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.

x = random( 10, 10, 20 )	-- 10 values between 10 and 20
y = random( 10, 20, 40 )	-- 10 values between 20 and 40
line( x, y )	-- create the line plot

Syntax

Remarks

Examples

Related Topics