GetDataLabelling

Description

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

Applies to

DataWindow control

Syntax

integer dwcontrol.GetDataLabelling (string graphcontrol, string series, int datapoint, REF boolean value)

Argument

Description

dwcontrol

A reference to the DataWindow control containing the graph.

graphcontrol

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

series

The string that identifies the series in which you want the data labelling value.

datapoint

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

value

Boolean passed by reference to indicate 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 and determine whether the label is set for that data point.

integer SeriesNbr, ItemNbr
boolean refB
grObjectType clickedtype
 
// Get the number of the series and data point
clickedtype = this.ObjectAtPointer("gr_1", &
   SeriesNbr, ItemNbr)
 
// Get data label
this.GetDataLabelling("gr_1", SeriesNbr, & 
      ItemNbr, refB)

See also

GetSeriesLabelling

SetDataLabelling

SetSeriesLabelling