GetSeriesTransparency

Description

Obtains the transparency percentage of a series in a DirectX 3D graph (those with 3D rendering).

Applies to

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

Syntax

controlname.GetSeriesTransparency ( { graphcontrol, } series, transparency )

Argument

Description

controlname

The name of the graph from which you want series transparency 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 from which you want the series data.

series

The string that identifies the series from which you want the transparency value.

transparency

Integer value for percent transparency. A value of 0 means that the series is opaque and a value of 100 means that it is completely transparent.


Return value

Integer.

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

Usage

GetSeriesTransparency retrieves data from any DirectX 3D graph (those with 3D rendering).

Examples

These statements obtain the transparency value of the series named Costs in the graph gr_computers in the DataWindow control dw_equipment:

string SeriesName
integer rtn, ser_transp_value
 
// Get the number of the series.
SeriesNbr = dw_equipment.FindSeries( &
    "gr_computers", "Costs")
rtn = dw_equipment.GetSeriesTransparency( &
    "gr_computers" , SeriesNbr, ser_transp_value)

These statements obtain the transparency value of the series named Income in the graph gr_1.

string SeriesName
integer rtn, ser_transp_value
 
SeriesNbr = gr_1.FindSeries("Income")
rtn = gr_1.GetSeriesTransparency(SeriesName, &
      ser_transp_value)

See also

FindSeries

GetDataTransparency

SetDataTransparency

SetSeriesTransparency