ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Chart functions
  • Managing the category labels
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Allows you to:
  • Initialize the label of a data category (or section) in a chart.
    WEBDEV - Browser code Not available.
  • Get the label of a data category (or section) in a chart.
Example of category label:
Category label
Reminder: A chart element has no label by default.
Linux Caution: A specific configuration is required to use this function in Linux. For more details, see The charts.
Example
// Initialize the "February" label of the second data category
// in "MyChart"
grCategoryLabel("MyChart", 2, "February")
// Initialize the "February" label of the second data category
// in "MyChart"
grCategoryLabel(CHART_MyChart, 2, "February")
// Read label of second data category
// in "MyChart"
MyLabel is string = grCategoryLabel(CHART_MyChart, 2)
Syntax
WEBDEV - Browser code Not available in browser code

Initializing the label of a data category (or section) in a chart Hide the details

grCategoryLabel(<Chart name> , <Index> , <Label>)
<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.
Android Only Chart controls are available.
PHP Only the interactive Chart controls are available.
<Index>: Integer
Data index in the series.
<Label>: Character string
Caption of label to initialize.
This parameter can also correspond to a duration, a date, a time or a date-time.
Remark: If you are using a temporal abscissa scale, grCategoryLabel must be systematically called whenever adding data into the chart with grAddData.

Getting the label of a data category (or section) in a chart Hide the details

<Result> = grCategoryLabel(<Chart name> , <Index>)
<Result>: Character string
Label caption.
<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.
Android Only Chart controls are available.
PHP Only the interactive Chart controls are available.
<Index>: Integer
Data index (with the desired label) in the series.
Remarks

Managing the category labels

The category labels are displayed:
  • below the horizontal marks for Line and Stock charts (Candlestick and BarCharts),
  • below the X-axis for Column and MinMax charts.
Category label
Category labels cannot be used in Scatter charts.
The position of the category labels cannot be changed.
The category labels are defined by grCategoryLabel.
The data defined by grCategoryLabel will be taken into account during the next call to grDraw.
The label font can be modified by grLabelFont.
The category labels defined by grCategoryLabel can be displayed in the label of Pie charts (grShowLabel constant used with grLabel).
Related Examples:
WD 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.
The Chart functions 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
The Chart functions 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, ...)
The Chart control Unit examples (WINDEV Mobile): The Chart control
[ + ] Using the Chart control to display different types of charts:
- Pie (or pie chart)
- Line
- Column chart
- Area
The Chart functions 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, ...)
Business / UI classification: Neutral code
Component: wd290grf.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 06/22/2023

Send a report | Local help