CPlotView:GetCaption


The GetCaption method returns the caption string for a plot series. Each plot series has its own caption that appears above the plot.

Syntax

sText = CPlotView:GetCaption()

sText = CPlotView:GetCaption( nSeries )

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

    sText is the caption for the plot series.

    On success, this method returns the caption as a string.

    On failure, this method returns 0.

Example

The following script returns the text caption for plot series 2:

 

P = CPlotView:new()

-- create a new CPlotView

 

-- create the plot...

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

-- displays the caption for series 2

Related Topics

SetCaption

GetDescription

CPlotView Class