grLegend (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

Chart legend
Manual legend positioning: grLegend without effect

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

grLegend (Function)

In french: grLégende

Indicates the presence and position of legend in a chart.

Example of legend in a chart:

Remark: The legend groups together the colors and labels of the series (or sectors) of a chart..

Caution: Using this function under Linux requires a specific configuration.. For more details, see The charts.

Example

// Graphe créé par programmation
grCreate("MonGraphe", grColumn)
grDestinationWnd("MonGraphe", "", "Titre de la fenêtre")
// La légende est affichée à droite du graphe "MonGraphe"
grLegend("MonGraphe", grAtRight)
...
grDraw("MonGraphe")

// Manipulation d'un champ Graphe
// La légende est affichée à gauche du graphe GRF_MonGraphe
grLegend(GRF_MonGraphe, grAtLeft)
...
grDraw(GRF_MonGraphe)

Syntax

grLegend(<Chart name> , <Position>)

<Chart name>: Control name or character string

Name of the chart to be used. This name corresponds to:
the name of the chart defined programmatically with grCreate.
the name of the Chart control in the window, page or report editor.
Only Chart controls are available.
Only interactive Chart controls are available.

<Position>: Integer

Position of chart legend:
grAtBottom Legend displayed below the chart.
grAtLeft Legend displayed on the left of chart.
grAtRight Legend displayed on the right of chart.
grAtTop Chart legend displayed above the chart.
grNone No legend.

Remarks

Chart legend

The set of series labels correspond to the chart legend.

Serial labels cannot be used with pie charts.

Series labels are defined with grSeriesLabel.

The legend font can be changed with grLegendFont.

grLegend indicates the presence and position of the legend (i. e. all series labels). Any changes made with grLegend will take effect the next time grDraw is called. You can change the position of the chart legend via a context menu.

Note: To define series labels in scatter charts, we recommend using the grScatterSeriesLabel function. . For more details, see Legends of a chart.

Manual legend positioning: grLegend without effect

grLegend has no effect if the legend is positioned manually ("Manual positioning" in the chart legend window).

Related Examples:

Unit examples (WINDEV): The Chart functions

[ + ] Using the main chart designer features of WINDEV:
- Create a Pie, Column or Line chart
- Define the display area of a chart
- Define the chart options (legend, percentage, ...)
- Draw a line on a chart

Training (WINDEV): WD Chart

[ + ] This example presents the different uses of the Chart control.
Different types of charts are presented:
- Pie
- Sunburst
- Line
- Scatter
- Column
- Area
- etc.

The main features presented here are the possibility to customize of charts from the code, as well as to fill the chart from an HFSQL data file, or in the editor.

Unit examples (WEBDEV): The Chart functions

[ + ] This example presents the main features of the chart designer of WEBDEV and it allows you to:
- Create a chart: Pie, Column or Line
- Define the display area of a chart
- Define the options of the chart (legend, percentage, ...)

Unit examples (WINDEV Mobile): The Chart functions

[ + ] Using the Chart functions:
- create a Pie, Column or Line chart by programming
- define the chart options (legend, percentage, ...)

Component: wd300grf.dll