steplineerr

The stepline function creates a stepped line plot by connecting data points with a stepped line and drawing x and/or y errorbars. This is a non-class function equivalent to the CPlotView:StepLine method. The x and y points at the same array index are presumed to correspond to the same point. The data for x, y, x error bars, and y error bars are each held in lua arrays (1-dimensional indexed tables). To plot without errorbars, use stepline.

This function creates a new plot window and returns a CPlotView object and a CPlot object for the plot and the plot series it creates. These objects 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 which are compared here.

Syntax

CPlotView, CPlot = steplineerr( x, y, xe, ye )

CPlotView, CPlot = steplineerr( x, y, xe, ye, sLabelX )

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

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

CPlotView, CPlot = steplineerr( 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 y 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 are assigned default values.

Return values:

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

CPlot is returned as 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 4 arguments, the (x,y) data, are required. If you want to use the other arguments, you must include a nil 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 data using the random number generator and creates a stepped line plot with default plot labels. Error bars are plotted for the y axis, but not for the x axis. Only the first 3 parameters are required.

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
steplineerr( x, y, nil, ye, "My X", "My Y" )	-- create the stepped line plot

Syntax

Remarks

Examples

Related Topics