SetSeriesLabelling

Description

Set the series label for a DirectX 3D graph.

Applies to

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

Syntax

controlname.SetSeriesLabelling ({graphcontrol, } series, value )

Argument

Description

controlname

The name of the graph in which you want to set 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 in which you want to change the series label setting.

value

Indicates whether to label the series with its values.

Returns

Returns 1 if it succeeds and -1 if an error occurs. If any argument’s value is null, SetSeriesLabelling returns null.

Usage

SetSeriesLabelling is used to indicate whether or not to label the series with the data numbers for 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 series and data point of graph gr_1 in the DataWindow control dw_employee.

integer SeriesNbr, ItemNbr

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.SetSeriesLabelling("gr_1", & 

		ls_SeriesName, true)

Example 2

These statements obtain the series and data point of graph gr_1.

integer SeriesNbr, ItemNbr

string ls_SeriesName

grObjectType clickedtype


clickedtype = gr_1.ObjectAtPointer(SeriesNbr, &

		ItemNbr)


ls_SeriesName = gr_1.SeriesName(SeriesNbr)


gr_1.SetSeriesLabelling(ls_SeriesName, true)

See also