GetDataLabelling PowerScript function
Description
Determines
whether the data at a given data point 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>GetDataLabelling</span> ({<span>graphcontrol</span>,} <span>series</span>, <span>datapoint</span>, <span>value</span>) |
|
Argument |
Description |
|---|---|
|
controlname |
The name of the graph from which you |
|
graphcontrol (DataWindow control |
(Optional) A string whose value is the |
|
seriesnumber |
The number that identifies the series |
|
datapoint |
The data point for which you want to |
|
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, GetDataLabelling returns
null.
Usage
GetDataLabelling determines whether a data
label is set for data points from DirectX 3D Area, Bar, Col, or
Line graphs. You cannot use this method with DirectX 3D Pie graphs.
Examples
In a DataWindow Clicked event, these statements obtain
the number of the series and data point clicked by the user in gr_1 and
determine whether the label is set for that data point.
|
1 |
integer SeriesNbr, ItemNbr |
|
1 |
boolean refB |
|
1 |
grObjectType clickedtype |
|
1 |
|
1 |
clickedtype = this.ObjectAtPointer("gr_1", & |
|
1 |
SeriesNbr, ItemNbr) |
|
1 |
|
1 |
this.<span>GetDataLabelling</span>("gr_1", SeriesNbr, & |
|
1 |
ItemNbr, refB) |
These statements obtain the number of the series
and data point clicked by the user in a graph object and determine
whether the label is set for that data point.
|
1 |
integer SeriesNbr, ItemNbr |
|
1 |
boolean refB |
|
1 |
grObjectType clickedtype |
|
1 |
|
1 |
clickedtype = this.ObjectAtPointer(SeriesNbr, ItemNbr) |
|
1 |
|
1 |
this.<span>GetDataLabelling</span>(SeriesNbr, ItemNbr, refB) |