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

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

bullet.gif    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:

P = new_plotview()

-- create a new CPlotView

 

-- build up the plot series

Printf("%s\n", P:GetDescription(2) )

-- displays the description of series 2

Related Topics

CPlotView class, SetDescription


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