GetSeriesLabelling
PowerScript function
Description
Determines whether the data for a given series is labeled in a
DirectX 3D graph.
Applies to
Graph controls in windows and user objects, and graphs in DataWindow
controls
Syntax
|
1 |
controlname.GetSeriesLabelling ({graphcontrol,} series, value) |
|
Argument |
Description |
|---|---|
|
controlname |
The name of the graph from which you want data, or |
|
graphcontrol (DataWindow control only) |
{Optional} A string whose value is the name of the |
|
series |
The string that names the series for which you want |
|
value |
A boolean passed by reference that indicates whether |
Return value
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 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
integer SeriesNbr, ItemNbr boolean refB string ls_SeriesName grObjectType clickedtype // Get the number of the series and datapoint clickedtype = this.ObjectAtPointer("gr_1", & SeriesNbr, ItemNbr) //Get the name of series ls_SeriesName = dw_employee.SeriesName("gr_1", & SeriesNbr) // Set Series label dw_employee.GetSeriesLabelling("gr_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 2 3 4 5 6 7 8 9 10 11 |
integer SeriesNbr, ItemNbr boolean refB string ls_SeriesName grObjectType clickedtype clickedtype = gr_1.ObjectAtPointer(SeriesNbr, & ItemNbr) ls_SeriesName = gr_1.SeriesName(SeriesNbr) gr_1.GetSeriesLabelling(ls_SeriesName, refB) |
See also