CPlotView:GetDescription

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

Syntax

sText = CPlotView:GetDescription()

sText = CPlotView:GetDescription( nSeries )

nSeries is the index of the plot series, starting at 1. If not specified, the current series is selected.

sText is a string containing the description.

Example

The following script returns the text description from plot series 2:

P = CPlotView:new()	-- create a new CPlotView
	-- build up the plot series
Printf("%s\n", P:GetDescription(2) )	-- displays the description of series 2