CPlotView:GetDescription

The GetDescription method returns the text description associated with a plot series. The series description is simply additional text stored in the plot series but not displayed in the plot window.

Syntax

sText = CPlotView:GetDescription( nSeries )

sText = CPlotView:GetDescription()

nSeries is an optional argument specifying the index of the plot series, starting at 1. If not provided, the current plot series is used

sText is a string containing the description.

Example

The following script returns the text description from plot series 1. Series 1 would be the first (or only) series in the CPlotView window:

V = new_plotview()	-- create a new CPlotView
-- add points to the series
Printf("%s\n", V:GetDescription(2) )	-- display the description of series 2

Syntax

Example

Related Topics