ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage functions / Controls, pages and windows / Chart functions
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Formats the data displayed by grLabel or by grTooltip
Linux Caution: In Linux, this function requires a specific configuration. For more details, see The charts.
Example
grMask(GRF_MonGraphe, grMaskPercent, "99,99%")
grLabel(GRF_MonGraphe, grShowPercent, True)
grDraw(GRF_MonGraphe)
Syntax
grMask(<Chart name> , <Type of mask> , <Mask value>)
<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.
<Type of mask>: Numeric constant
Mask used:
grMaskAxisThe specified mask is used to format the values displayed on the chart axes.
Example Displays the value in the current currency: the mask value is "+99.999.999.999,99 $".
grMaskPercentThe specified mask is used to format the percentages displayed in the chart (grLabel(<Chart Name>, grShowPercent, True))
Attention: the % sign must be present in the <Mask value> parameter.
Example: "99.99%" allows displaying the percentage with 2 decimal places.
grMaskTimeAxisThe specified mask is used to format the dates or times displayed on the chart axes.
Example Displays the date in "DD/MM/YYYY" format: the value of the mask is "DD/MM/YYYY".
grMask("MonGraphe", grMaskTimeAxis, "JJ/MM/AAAA")
This constant is supported only by chart types that can have a time axis: Histogram, Horizontal histogram, Curve and Area.
grMaskValueThe specified mask is used to format the values displayed in the chart (grLabel(<Chart Name>, grShowValue, True))
Example Displays the value in the current currency: the mask value is "+99.999.999.999,99 $".
<Mask value>: Character string
Description of the mask to use.
  • For the constant grMaskValue Empty string ("", default value) to disable display mask.
  • For the constant grMasquePercent constant: "99%": default value.
  • For the grMaskTimeAxis constant:
    • If the value to display is a date, it must be in "YYYYMMDD" format. The supported masks are identical to the ones used by DateToString.
    • If the value to display is a time, it must be in "HHMMSSCC" format. The supported masks are identical to the ones used by TimeToString.
Masks are defined using the following characters: "9", ".", ",", "+", "-" and spaces.. For example: "99.999,99". For the currency masks, use up to 17 significant digits for the integer part and 6 for the decimal part. For example: "99 999 999 999 999,999999".
Remarks:
  • In order for the number to be filled with zeros on the left, the "0" character must be used on the left of the mask. For example: "099.999.99".
  • To force the signs, use the "+" character on the left. For example: "+9999".
Remarks
This function only has an effect on graphs that display values or percentages.
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 (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 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, ...)
Component: wd300grf.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 03/28/2025

Send a report | Local help