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, nSeries* )

bullet.gif    sText is the description text to save.

bullet.gif    nSeries is an optional argument specifying 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 1. Series 1 would be the first (or only) series in the CPlotView window:

P = new_plotview()

-- create a new CPlotView

 

-- do something with the plot

P:SetDescription( "My plot", 2 )

-- save a description to series 2

Related Topics

CPlotView class, GetDescription


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