grMask (Function) In french: grMasque
grMask(CHART_MyChart, grMaskPercent, "99.99%") grLabel(CHART_MyChart, grShowPercent, True) grDraw(CHART_MyChart)
Syntax
grMask(<Chart name> , <Type of mask> , <Mask value>)
<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, page editor or report editor.
<Type of mask>: Numeric constant Mask used: | | grMaskAxis | The specified mask is used to format the values displayed on the chart axes. Example: Displays the value in the current currency: the value of the mask is "+99,999,999,999.99 $". | Versions 21 and latergrMaskTimeAxis New in version 21grMaskTimeAxis grMaskTimeAxis | The specified mask is used to format the dates or times displayed on the chart axes. Example: Displays the date in "MM/DD/YYYY" format: the value of the mask is "MM/DD/YYYY".
grMask("MyChart", grMaskTimeAxis, "MM/DD/YYYY")
This constant is supported by the types of charts that can include a time axis: Column, Horizontal column, Line and Area.
| grMaskPercent | The specified mask is used to format the percentages displayed in the chart (grLabel(<Chart Name>, grShowPercent, True)) Caution: the % symbol must be found in <Mask Value>. Example: "99.99%" displays the percentage with 2 digits after the decimal point. | grMaskValue | The 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 value of the mask is "+99,999,999,999.99 $". |
<Mask value>: Character string (with quotes) Description of the mask to use.- For the grMaskValue constant: Empty string ("", default value) to disable the display mask.
- For the grMaskPercent constant: "99%": default value.
Versions 21 and laterFor 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.
New in version 21For 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.
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.
The masks are defined via characters: "9", ".", ",", "+", "-" and space characters. 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 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 affects charts that display values or percentages.
Related Examples:
|
Training (WINDEV): WD Chart
[ + ] This example shows the different uses of the chart control. The following charts are presented: - Semi-circular - Donut - Pie - Sunburst - Line - Scatter - 3D Scatter - Column - Area - Bubble - Radar - Funnel - Surface - Waterfall - Composite - Comparative The main features presented in this example are the customization of charts by programming, as well as the method used to fill a chart from an HFSQL 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, ...)
|
This page is also available for…
|
|
|