GetDataLabelling

Description

Determines whether the data at a given data point is labeled in a DirectX 3D graph.

Applies to

Graph controls in windows and user objects, and graphs in DataWindow controls

Syntax

controlname.GetDataLabelling ({graphcontrol,} series, datapoint, value)

Argument

Description

controlname

The name of the graph from which you want data, or the name of the DataWindow control containing the graph.

graphcontrol (DataWindow control only)

(Optional) A string whose value is the name of the graph in the DataWindow control.

seriesnumber

The number that identifies the series for which you want the data label setting.

datapoint

The data point for which you want to obtain a label.

value

A boolean passed by reference that indicates whether the data point has a label.


Return value

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.

integer SeriesNbr, ItemNbr
boolean refB
grObjectType clickedtype
 
clickedtype = this.ObjectAtPointer("gr_1", &
   SeriesNbr, ItemNbr)
 
this.GetDataLabelling("gr_1", SeriesNbr, &
   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.

integer SeriesNbr, ItemNbr
boolean refB
grObjectType clickedtype
 
clickedtype = this.ObjectAtPointer(SeriesNbr, ItemNbr)
 
this.GetDataLabelling(SeriesNbr, ItemNbr, refB) 

See also

GetSeriesLabelling

SetDataLabelling

SetSeriesLabelling