GetSeriesLabelling

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

controlname.GetSeriesLabelling ({graphcontrol,} series, 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.
series	The string that names the series for which you want the series label setting.
value	A boolean passed by reference that indicates whether the series has a label.

Returns

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

Example 1

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.

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)

Example 2

These statements obtain the number of the series and datapoint for the graph gr_1 and then set the series label.

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)