CPlotView:SetDescription

The SetDescription method saves a text description to a plot series. The series description is simply additional text stored in the plot series that is not displayed in the plot window.

Syntax

CPlotView:SetDescription( sText )

CPlotView:SetDescription( sText, nSeries )

sText is the description text to save.

nSeries specifies the index of the plot series, starting at 1. If not provided, the current plot series is used.

Example

The following script saves a text description to plot series 2:

P = CPlotView:new()	-- create a new CPlotView
	-- do something with the plot
P:SetDescription( "My plot", 2 )	-- save a description to series 2