grScatterGetDataXY (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Chart functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

grScatterGetDataXY (Function)

In french: grNuageRécupèreDonnéeXY

Retrieves a data from a "Scatter" chart.

New in SaaS
Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 2. For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.

Example

// Display data in the "CHART_MyChart" control ("Scatter" chart). 
// This data is the first X-coordinate of first series.
Info(grScatterGetDataXY(CHART_MyChart, 1, 1, grXValue))

Syntax

<Result> = grScatterGetDataXY(<Chart name> , <Series number> , <Index> , <Value to retrieve>)

<Result>: Real

Retrieved value.

<Chart name>: Control name or character string

Name of the chart to be used. This name corresponds to:
the chart name defined through programming with grCreate,
the name of the Chart control (in the window, page or report editor).

<Series number>: Integer

Number of the series for which a value will be retrieved.
If the specified series does not exist, the retrieved value is 0.

<Index>: Integer

Index of data in the series for which the value will be retrieved.
If the data corresponding to the specified index does not exist in the series, the retrieved value is 0.

<Value to retrieve>: Integer constant

Indicates the value to retrieve:
grXValue X value of series.
grYValue Y value of series.

Remarks

To retrieve data from a Stock chart, it is recommended to use grStockGetData.
To retrieve data from a Surface chart, it is recommended to use grSurfaceGetData.
To retrieve data from another type of chart (Pie, Column, Line, etc.), we recommend that you use grGetData.
To retrieve data from a Sunburst chart, it is recommended to use grSunburstGetData.
To retrieve data from a Heatmap chart, it is recommended to use grHMGetData.

We recommend that you use grScatterGetDataXY to retrieve data from "Scatter" charts. You can also use grGetData.
The following syntax:

grScatterGetDataXY(CHART_MyChart, i, 1, grXValue)
grScatterGetDataXY(CHART_MyChart, i, 1, grYValue)

est is equivalent to the syntax:

grGetData(CHART_MyChart, i*2-1, 1)
grGetData(CHART_MyChart, i*2, 1)

By default, a chart created by grCreate contains no data.

Component: wd300grf.dll