GetSeriesLabelling PowerScript function
Description
Determines
whether the data for a given series is labeled in a DirectX 3D graph.
Controls
Graph controls in windows and user objects, and graphs in
DataWindow controls
Syntax
|
1 |
<span>controlname</span>.<span></span><span>GetSeriesLabelling</span> ({<span>graphcontrol</span>,} <span>series</span>, <span>value</span>) |
|
Argument |
Description |
|---|---|
|
controlname |
The name of the graph from which you |
|
graphcontrol (DataWindow control |
{Optional} A string |
|
series |
The string that names the series for |
|
value |
A boolean passed by reference that indicates |
Return Values
Returns 1 if it succeeds and -1 if an error occurs. If any
argument’s value is null, GetSeriesLabelling returns
null.
Usage
GetSeriesLabelling retrieves the data from
DirectX 3D Area, Bar, Col, or Line graphs. You cannot use this method
with DirectX 3D Pie graphs.
Examples
These statements obtain the number of the series
and datapoint for the graph gr_1 in
the DataWindow control dw_employee and
then set the series label.
|
1 |
integer SeriesNbr, ItemNbr |
|
1 |
boolean refB |
|
1 |
string ls_SeriesName |
|
1 |
grObjectType clickedtype |
|
1 |
|
1 |
// Get the number of the series and datapoint |
|
1 |
clickedtype = this.ObjectAtPointer("gr_1", & |
|
1 |
SeriesNbr, ItemNbr) |
|
1 |
|
1 |
//Get the name of series |
|
1 |
ls_SeriesName = dw_employee.SeriesName("gr_1", & |
|
1 |
SeriesNbr) |
|
1 |
|
1 |
// Set Series label |
|
1 |
dw_employee.<span>GetSeriesLabelling</span>("gr_1", & |
|
1 |
ls_SeriesName, refB) |
These statements obtain the number of the series
and datapoint for the graph gr_1 and
then set the series label.
|
1 |
integer SeriesNbr, ItemNbr |
|
1 |
boolean refB |
|
1 |
string ls_SeriesName |
|
1 |
grObjectType clickedtype |
|
1 |
|
1 |
clickedtype = gr_1.ObjectAtPointer(SeriesNbr, & |
|
1 |
ItemNbr) |
|
1 |
|
1 |
ls_SeriesName = gr_1.SeriesName(SeriesNbr) |
|
1 |
|
1 |
gr_1.<span>GetSeriesLabelling</span>(ls_SeriesName, refB) |