SeriesName
PowerScript function
Description
Obtains the series name associated with the specified series
number.
Applies to
Graph controls in windows and user objects, and graphs in DataWindow
controls
Syntax
|
1 |
controlname.SeriesName ( { graphcontrol, } seriesnumber ) |
|
Argument |
Description |
|---|---|
|
controlname |
The name of the graph in which you want the name of a |
|
graphcontrol (DataWindow control only) (optional) |
A string whose value is the name of the graph in the |
|
seriesnumber |
The number of the series for which you want to obtain the |
Return value
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 2 |
string ls_SeriesName ls_SeriesName = gr_product_data.SeriesName(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 2 3 |
string ls_SeriesName ls_SeriesName = & dw_equipment.SeriesName("gr_computers", 5) |
See also