CPlotView:StepLine

The Stepline method creates a stepped line plot by connecting data points with a stepped line. This is a CPlotView class version of the non-class stepline 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 PlotStepline method takes its data from the CPlotView class data matrix rather than from x and y tables. Also see the Connect, Line, and Scatter commands in the CPlotView class.

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

Syntax

CPlot = CPlotView:StepLine( x, y )

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

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

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

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

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

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

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

bullet.gif    y is a 1-dimensional array containing the y values.

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

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

bullet.gif    sLabelX is an optional label for the x axis.

bullet.gif    sLabelY is an optional label for the y axis.

bullet.gif    sCaption is an optional plot caption.

bullet.gif    sWindowTitle is an optional plot window title.

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

Return values:

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

Remarks

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 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 some data from the random number generator and creates a stepped 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:StepLine( x, y )

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

-- create the stepped line plot

Related Topics

CPlotView class, non-class stepline function, Plotting Functions, Comparison of non-Class Plotting Functions


Mira Pro x64 Script User's Guide, Copyright Ⓒ 2023 Mirametrics, Inc. All Rights Reserved.