SeriesName PowerScript function
Description
Obtains the series name associated with the specified series
number.
Controls
Graph controls in windows and user objects, and graphs in
DataWindow controls
Syntax
|
1 |
<span>controlname</span>.<span>SeriesName</span> ( { <span>graphcontrol</span>, } <span>seriesnumber</span> ) |
|
Argument |
Description |
|---|---|
|
controlname |
The name of the graph in which you want |
|
graphcontrol (DataWindow control |
A string whose value is the name of the |
|
seriesnumber |
The number of the series for which you |
Return Values
String. Returns the name assigned to
the series. If an error occurs, it returns the empty string (“”).
If any argument’s value is null, SeriesName returns null.
Usage
Series are numbered consecutively, from 1 to the value returned
by SeriesCount. When you delete a series, the
series are renumbered to keep the numbering consecutive. You can
use SeriesName to find out the name of the series
associated with a series number.
Examples
These statements store in the variable ls_SeriesName the
name of series 5 in the graph gr_product_data:
|
1 |
string ls_SeriesName |
|
1 |
ls_SeriesName = gr_product_data.<span>SeriesName</span>(5) |
These statements store in the variable ls_SeriesName the
name of series 5 in the graph gr_computers in
the DataWindow control dw_equipment:
|
1 |
string ls_SeriesName |
|
1 |
ls_SeriesName = & |
|
1 |
dw_equipment.<span>SeriesName</span>("gr_computers", 5) |