GetSeriesLabelling

Description

Determines whether the data for a given series is labeled in a DirectX 3D graph.

Applies to

DataWindow control

Syntax

integer dwcontrol.GetSeriesLabelling (string graphcontrol, string series, 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 names the series in which you want the series label setting.

value

A boolean passed by reference to indicate whether the series has labels.


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 data point for the graph gr_1 in the DataWindow control dw_employee and then get the series label setting.

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)
 
// Get Series label
dw_employee.GetSeriesLabelling("gr_1", & 
      ls_SeriesName, refB)

See also

GetDataLabelling

SetDataLabelling

SetSeriesLabelling