GetDataValue method (Graphs in DataWindows)

Description

Obtains the value of a data point in a series in a graph.

In the Web ActiveX, there are several methods, each handling
a different datatype.

Controls

PowerBuilder DataWindow DataWindow
control

DataWindow Web ActiveX DataWindow
control

Syntax

[PowerBuilder]

integer <span>dwcontrol</span>.<span>GetDataValue</span> ( string <span>graphcontrol</span>, <br>    integer <span>seriesnumber</span>, long <span>datapoint</span>, REF date <span>datavariable</span> <br>    {, grDataType <span>XorY</span> } )<br>integer <span>dwcontrol</span>.<span>GetDataValue</span> ( string <span>graphcontrol</span>, <br>    integer <span>seriesnumber</span>, long <span>datapoint</span>, REF datetime <span>datavariable</span> <br>    {, grDataType <span>XorY</span> } )<br>integer <span>dwcontrol</span>.<span>GetDataValue</span> ( string <span>graphcontrol</span>, <br>    integer <span>seriesnumber</span>, long <span>datapoint</span>, REF double <span>datavariable</span> <br>    {, grDataType <span>XorY</span> } )<br>integer <span>dwcontrol</span>.<span>GetDataValue</span> ( string <span>graphcontrol</span>, <br>    integer <span>seriesnumber</span>, long <span>datapoint</span>, REF string <span>datavariable</span> <br>    {, grDataType <span>XorY</span> } )<br>integer <span>dwcontrol</span>.<span>GetDataValue</span> ( string <span>graphcontrol</span>, <br>    integer <span>seriesnumber</span>, long <span>datapoint</span>, REF time <span>datavariable</span> <br>    {, grDataType <span>XorY</span> } )

integer dwcontrol.GetDataValue ( string graphcontrol, integer seriesnumber, long datapoint, REF date datavariable {, grDataType XorY } ) integer dwcontrol.GetDataValue ( string graphcontrol, integer seriesnumber, long datapoint, REF datetime datavariable {, grDataType XorY } ) integer dwcontrol.GetDataValue ( string graphcontrol, integer seriesnumber, long datapoint, REF double datavariable {, grDataType XorY } ) integer dwcontrol.GetDataValue ( string graphcontrol, integer seriesnumber, long datapoint, REF string datavariable {, grDataType XorY } ) integer dwcontrol.GetDataValue ( string graphcontrol, integer seriesnumber, long datapoint, REF time datavariable {, grDataType XorY } )

[Web ActiveX]

number <span>dwcontrol</span>.<span>GetDataDate</span> ( string <span>graphcontrol</span> , <br>    number <span>seriesnumber</span>, number <span>datapoint</span> , number <span>XorY</span> )<br>number <span>dwcontrol</span>.<span>GetDataNumber</span> ( string <span>graphcontrol</span> , <br>    number <span>seriesnumber</span>, number <span>datapoint</span> , number <span>XorY</span> )<br>number <span>dwcontrol</span>.<span>GetDataString</span> ( string <span>graphcontrol</span> , <br>    number <span>seriesnumber</span>, number <span>datapoint</span> , number <span>XorY</span> )

number dwcontrol.GetDataDate ( string graphcontrol , number seriesnumber, number datapoint , number XorY ) number dwcontrol.GetDataNumber ( string graphcontrol , number seriesnumber, number datapoint , number XorY ) number dwcontrol.GetDataString ( string graphcontrol , number seriesnumber, number datapoint , number XorY )

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.
seriesnumber	The number that identifies the series from which you want data.
datapoint	The number of the data point for which you want the value.
datavariable	The name of a variable that will hold the data value. The variable’s datatype can be date, DateTime, double, string, or time. The variable must have the same datatype as the values axis of the graph. In the Web ActiveX, call the GetDataDateVariable, GetDataNumberVariable, or GetDataStringVariable to get the value, instead of using the reference variable.
xory (scatter graph only) (optional)	A value of the grDataType enumerated datatype (in PowerBuilder) or an integer (in the Web ActiveX) specifying whether you want the x or y value of the data point in a scatter graph. For values, see grDataType.

Return Values

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

Usage

GetDataValue retrieves data from any graph.
The data is stored in datavariable, whose
datatype must match the datatype of the graph’s values
axis, or returned by a method that corresponds to the axis datatype.
If the values axis is numeric, you can also use the GetData function.

Calling GetDataValue when the datatype
of datavariable is not the same as the datatype
of the data produces undefined results.

If a variable’s datatype is non-numeric and the datatype
of datavariable is double, GetDataValue returns
the number of the datapoint in datavariable.

If a variable’s datatype is date, time,
or DateTime, GetDataValue returns
1 when the datatype of datavariable is any
of those datatypes. However, if the variable’s datatype
is time and the datatype of datavariable is date, GetDataValue returns
00/00/00 in datavariable,
and if the variable’s datatype is date and
the datatype of datavariable is time, GetDataValue returns
00:00:00 in datavariable.

Examples

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

integer SeriesNbr, rtn

1	integer SeriesNbr, rtn

double data_value

1	double data_value

// Get the number of the series.

1	// Get the number of the series.

SeriesNbr = dw_equipment.FindSeries( &amp;

1	SeriesNbr = dw_equipment.FindSeries( &

        "gr_computers", "Costs")

1	"gr_computers", "Costs")

rtn = dw_equipment.<span>GetDataValue</span>( &amp;

1	rtn = dw_equipment.<span>GetDataValue</span>( &

<span>    </span>    "gr_computers" <span>,</span> SeriesNbr, 3, data_value)

1	<span> </span> "gr_computers" <span>,</span> SeriesNbr, 3, data_value)

GetDataValue – PB Docs 125