grInfoXY (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Functions for managing charts

See also

grInfoXY (Function)

In french: grInfoXY

Returns information about the series found at a specific chart point. This information is identical to the one displayed in the tooltip.

Note: This function is not available for the 3D charts and for the Surface charts.

Versions 15 and later

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The charts for more details.

New in version 15

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The charts for more details.

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The charts for more details.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 19 and later

This function is now available for Android applications.

New in version 19

This function is now available for Android applications.

Versions 20 and later

This function is now available in browser code.

New in version 20

This function is now available in browser code.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// Click code on a chart
Information is string = ...
"(" + MouseXPos() + "," + MouseYPos() + ")" + CR + ...
"grSeries -->" + TAB + grInfoXY(MySelf, grSeries, MouseXPos(), MouseYPos()) + CR + ...
"grCategory -->" + TAB + grInfoXY(MySelf, grCategory, ...
MouseXPos(), MouseYPos()) + CR + ...
"grValue -->" + TAB + grInfoXY(MySelf, grValue, ...
MouseXPos(), MouseYPos()) + CR + ...
"grXValue -->" + TAB + grInfoXY(MySelf, ...
MouseXPos(), MouseYPos()) + CR + ...
"grMinValue -->" + TAB + grInfoXY(MySelf, grMinValue, ...
MouseXPos(), MouseYPos()) + CR + ...
"grYValue -->" + TAB + grInfoXY(MySelf, grYValue, ...
MouseXPos(), MouseYPos()) + CR + ...
"grMaxValue -->" + TAB + grInfoXY(MySelf, grMaxValue, ...
MouseXPos(), MouseYPos()) + CR + ...
"grStartValue -->" + TAB + grInfoXY(MySelf, grStartValue, ...
MouseXPos(), MouseYPos()) + CR + ...
"grEndValue -->" + TAB + grInfoXY(MySelf, grEndValue, MouseXPos(), MouseYPos())

Versions 19 and later

New in version 19

Syntax

<Result> = grInfoXY(<Chart name> , <Type of information> [, <X> , <Y>])

<Result>: Integer or real

Requested information.
If no chart element is found under the mouse,
-1 (grSeries and grCategory constants)
0 (grValueXXXX constant).

<Chart name>: Character string (with or without quotes)

Name of chart to use. This name corresponds to:
the chart name defined by programming with grCreate.
the name of Chart control (found in the window editor or page editor).
Only the Chart controls are available.
Only the interactive Chart controls are available ("Interactive chart" in the "Details" tab of the description window of control).

<Type of information>: Constant

Requested type of information:
grCategory Number of pointed category.
Versions 23 and later
grTheoreticalCategory
New in version 23
grTheoreticalCategory
grTheoreticalCategory Number of the category that corresponds to a pointed X coordinate (regardless of the series) and even if the cursor is not on the chart drawing.
This constant is not available.
Versions 20 and later
grPath
New in version 20
grPath
grPath Path of section in the Sunburst chart.
This constant is not available.
Versions 22 and later
grXCoord
New in version 22
grXCoord
grXCoord X coordinate of chart point.
This constant is not available.
Versions 22 and later
grYCoord
New in version 22
grYCoord
grYCoord Y coordinate of chart point.
This constant is not available.
Versions 22 and later
grSecondaryYCoord
New in version 22
grSecondaryYCoord
grSecondaryYCoord Y coordinate according to the secondary axis of chart point.
This constant is not available.
grSeries Series number.
Note: There is one series on 4 or on 2 for the Stock charts and for the Scatter charts.
grValue Value of series.
grStartValue Start value of the series for a Stock chart.
This constant is not available.
grEndValue End value of the series for a Stock chart.
This constant is not available.
grMaxValue Maximum value of the series for a Stock chart.
This constant is not available.
grMinValue Minimum value of the series for a Stock chart.
This constant is not available.
grXValue X value of series for a Scatter chart.
This constant is not available.
grYValue Y value of series for a Scatter chart.
This constant is not available.

<X>: Optional integer

X coordinate (in pixels) to study. This coordinate is expressed in relation to the control.
If this parameter is not specified, the position used during the last call to grInfoXY is taken into account.

<Y>: Optional integer

Y coordinate (in pixels) to study. This coordinate is expressed in relation to the control.
If this parameter is not specified, the position used during the last call to grInfoXY is taken into account.

Remarks

X and Y positions

The <X> and <Y> parameters must be specified at least once.

A WLanguage error occurs if the chart has changed between 2 calls to grInfoXY and if the X and Y positions are not specified.

Column chart

When clicking a bar of the column chart, the area taken into account will be a little bit larger (at the top and at the bottom).

Related Examples:

Unit examples (WINDEV): The Chart control (click management)

[ + ] Customizing the click on a Pie chart.
Here, the section clicked by the user is pulled out by the application.
To implement this behavior, all you have to do is use grInfoXY (to identify the section clicked) and grPiePullOut (to pull out the section).

Cross-platform examples (WINDEV Mobile): WM Click on Chart

[ + ] The "WM Click on Chart" example proposes a solution for pulling out the sections of a Pie chart via a simple click.
This example includes a control template named "TPLC_PullOutChart". This control template is used to pull out the chart sections via a simple click.
To include this feature in another application, all you have to do is import the "TPLC_PullOutChart" template.

Mobile (WINDEV Mobile): Pocket Click on Chart

[ + ] The "Pocket Click on Chart" example proposes a solution for pulling out the sections of a pie chart via a simple user click.

This example includes a control template named "TPLC_PullOutChart". This control template is used to enable the pulling out of a chart section via a simple click.

To make this feature available in another application, all you have to do is import the control template named "TPLC_PullOutChart".

Component : wd240grf.dll