PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE


  • Chart parameters
  • Various
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Retrieves or modifies a chart parameter.
This function can only be used with the Chart controls found in a window and with the charts created by programming (grCreate). This function must not be used on the Chart controls found in the report editor.
Note: This function proposes all the options of gr3DSParameter.
Versions 15 and later
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
Linux Caution: A specific configuration is required to use this function in Linux. See The charts for more details.
New in version 15
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
Linux Caution: A specific configuration is required to use this function in Linux. See The charts for more details.
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
Linux Caution: A specific configuration is required to use this function in Linux. See The charts for more details.
Versions 16 and later
WINDEVLinux This function is now available for the WINDEV applications in Linux.
New in version 16
WINDEVLinux This function is now available for the WINDEV applications in Linux.
WINDEVLinux This function is now available for the WINDEV applications in Linux.
Versions 17 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Versions 23 and later
PHP This function is now available for the PHP sites.
New in version 23
PHP This function is now available for the PHP sites.
PHP This function is now available for the PHP sites.
Example
// Disables the optimization of marks on the X axis of CHART_Chart1
grParameter(CHART_Chart1, grOptimizedMarksX, False)
Syntax

Retrieving the value of a chart parameter Hide the details

<Result> = grParameter(<Chart Name> , <Parameter>)
<Result>: Integer, real or boolean
Parameter value. The type depends on the specified parameter (see the notes).
<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).
PHP Only the interactive Chart controls are available.
<Parameter>: Integer constant
Chart parameter whose value is requested:
gr3DSPropAnimationType of animation played when displaying the chart.
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropAutoZoomAutomatic zoom of chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropColorPlaneXColor of vertical plane (axis to right or to left)
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropColorPlaneYColor of horizontal plane (axis above or below)
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropColorPlaneZColor of background plane
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropDistanceZoom of chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropElevationRotation angle of chart around the vertical axis (Y axis)
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropLegendOverlapThe chart legend and title are stacked
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropLightXX coordinate of the light that is lighting the chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropLightYY coordinate of the light that is lighting the chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropRotationRotation angle of chart around the horizontal axis (X axis)
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropTransparencyTransparency level for the bars or sections of chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
Versions 17 and later
grAlgoFunnel
New in version 17
grAlgoFunnel
grAlgoFunnel
Mode for representing the data in a Funnel chart.
Windows MobileUniversal Windows 10 App This constant is not available.
Versions 22 and later
grScrollbarZoomAlwaysVisible
New in version 22
grScrollbarZoomAlwaysVisible
grScrollbarZoomAlwaysVisible
Management of scrollbars during a zoom on the chart.
PHP This constant is not available.
Versions 23 and later
grSamplingEnabled
New in version 23
grSamplingEnabled
grSamplingEnabled
Management of sub sampling.
Versions 16 and later
grOptimizedLocation
New in version 16
grOptimizedLocation
grOptimizedLocation
Enable the optimization used to fill the available space for the Pie, Semi-circular and Donut charts displayed in a control or in a window.
PHP This constant is not available.
grOptimizedMarksXEnable the optimization of marks on the horizontal axis (X axis).
PHP This constant is not available.
grOptimizedMarksYEnable the optimization of marks on the vertical axis (Y axis).
PHP This constant is not available.
Versions 21 and later
grHMDisplayColor
New in version 21
grHMDisplayColor
grHMDisplayColor
Mode for displaying colors in a Heatmap chart.
WEBDEV - Server codeWindows Mobile This constant is not available.
Windows Mobile This constant is not available.
Versions 20 and later
grSunburstCaptionPerpendicularSection
New in version 20
grSunburstCaptionPerpendicularSection
grSunburstCaptionPerpendicularSection
Mode for displaying the caption of the section in a Sunburst chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only. This constant is ignored for a Chart control found in a report.
Versions 23 and later
grProjection3DScatter
New in version 23
grProjection3DScatter
grProjection3DScatter
Mode for displaying the projections on a 3D Scatter chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
Versions 20 and later
grInteractiveSunburst
New in version 20
grInteractiveSunburst
grInteractiveSunburst
Enable the interactive mode in a Sunburst chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
Versions 20 and later
grSunburstMaxLevel
New in version 20
grSunburstMaxLevel
grSunburstMaxLevel
Define the maximum number of levels found in a Sunburst chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
Versions 22 and later
grInfiniteZoomOut
New in version 22
grInfiniteZoomOut
grInfiniteZoomOut
Enable the infinite zoom out mode. If the infinite zoom out is enabled, you have the ability to unzoom a chart even if this one is displayed at 100%.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.

Modifying the value of a chart parameter Hide the details

grParameter(<Chart Name> , <Parameter> , <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 or page editor).
PHP Only the interactive Chart controls are available.
<Parameter>: Integer constant
Chart parameter to modify:
gr3DSPropAnimationType of animation played when displaying the chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropAutoZoomAutomatic zoom of chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropColorPlaneXColor of vertical plane (axis to right or to left)
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropColorPlaneYColor of horizontal plane (axis above or below)
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropColorPlaneZColor of background plane.
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropDistanceZoom of chart
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropElevationRotation angle of chart around the vertical axis (Y axis).
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropLegendOverlapThe chart legend and title are stacked.
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropLightXX coordinate of the light that is lighting the chart.
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropLightYY coordinate of the light that is lighting the chart.
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropRotationRotation angle of chart around the horizontal axis (X axis).
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
gr3DSPropTransparencyTransparency level for the bars or sections of chart.
WINDEVWindowsLinux This constant is available in the WINDEV applications for Windows and Linux only.
Versions 17 and later
grAlgoFunnel
New in version 17
grAlgoFunnel
grAlgoFunnel
Mode for representing the data in a Funnel chart.
Windows MobileUniversal Windows 10 App This constant is not available.
Versions 22 and later
grScrollbarZoomAlwaysVisible
New in version 22
grScrollbarZoomAlwaysVisible
grScrollbarZoomAlwaysVisible
Management of scrollbars during a zoom on the chart.
PHP This constant is not available.
Versions 23 and later
grSamplingEnabled
New in version 23
grSamplingEnabled
grSamplingEnabled
Management of sub sampling.
Versions 16 and later
grOptimizedLocation
New in version 16
grOptimizedLocation
grOptimizedLocation
Enable the optimization used to fill the available space for the Pie, Semi-circular and Donut charts displayed in a control or in a window.
PHP This constant is not available.
grOptimizedMarksXEnable the optimization of marks on the horizontal axis (X axis).
PHP This constant is not available.
grOptimizedMarksYEnable the optimization of marks on the vertical axis (Y axis).
PHP This constant is not available.
Versions 21 and later
grHMDisplayColor
New in version 21
grHMDisplayColor
grHMDisplayColor
Mode for displaying colors in a Heatmap chart.
WEBDEV - Server codeWindows Mobile This constant is not available.
Windows Mobile This constant is not available.
Versions 20 and later
grSunburstCaptionPerpendicularSection
New in version 20
grSunburstCaptionPerpendicularSection
grSunburstCaptionPerpendicularSection
Mode for displaying the caption of the section in a Sunburst chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
Versions 23 and later
grProjection3DScatter
New in version 23
grProjection3DScatter
grProjection3DScatter
Mode for displaying the projections on a 3D Scatter chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
Versions 20 and later
grInteractiveSunburst
New in version 20
grInteractiveSunburst
grInteractiveSunburst
Enable the interactive mode in a Sunburst chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
Versions 20 and later
grSunburstMaxLevel
New in version 20
grSunburstMaxLevel
grSunburstMaxLevel
Define the maximum number of levels found in a Sunburst chart.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
Versions 22 and later
grInfiniteZoomOut
New in version 22
grInfiniteZoomOut
grInfiniteZoomOut
Enable the infinite zoom out mode. If the infinite zoom out is enabled, you have the ability to unzoom a chart even if this one is displayed at 100%.
WINDEVWindows This constant is available in the WINDEV applications for Windows only.
<Value>: Integer, real or boolean
Parameter value. The type depends on the specified parameter (see the notes).
Remarks

Chart parameters

The different chart parameters are as follows:
ConstantEffectParameter value
gr3DSPropAnimationType of animation played when displaying the chartInteger
The possible values are:
  • 0: no animation
  • 1: zoom in
  • 2: rotating effect
  • 4: progressive drawing of bars/sections
  • 8: progressive display of colors
These values can be added.
The default value is 15.
gr3DSPropAutoZoomAutomatic zoom of chartBoolean
  • True (by default) if the zoom must be automatically calculated,
  • False otherwise.
If the zoom is automatically calculated, the value of gr3DSPropDistance constant is ignored.
gr3DSPropColorPlaneXColor of vertical plane (axis to right or to left)Integer
To avoid drawing this axis, use the Transparent constant.
This constant is taken into account by the bar charts and by the line charts only.
The default value is LightGray.
gr3DSPropColorPlaneYColor of horizontal plane (axis above or below)Integer
To avoid drawing this axis, use the Transparent constant.
This constant is taken into account by the bar charts and by the line charts only.
The default value is LightGray.
gr3DSPropColorPlaneZColor of background planeInteger
To avoid drawing this axis, use the Transparent constant.
This constant is taken into account by the bar charts and by the line charts only.
The default value is LightGray.
gr3DSPropDistanceZoom of chartReal
The possible values are included between 0 and infinity.
This constant is taken into account only if the gr3DSPropAutoZoom constant is set to False.
The default value is 189.
gr3DSPropElevationRotation angle (in degrees) of the chart around the vertical axis (Y axis)Real
The possible values are included between 0 and 360.
The value 0 displays a frontal view of chart.
The value 90 displays the chart from above.
The best rotation angle is automatically calculated by default.
gr3DSPropLegendOverlapThe chart legend and title are stackedBoolean.
  • True if the legend and the title are superimposed to the chart,
  • False (by default) otherwise.
gr3DSPropLightXX coordinate of the light that is lighting the chart.Real
The possible values are included between 0 and infinity.
The default value is 78.
gr3DSPropLightYY coordinate of the light that is lighting the chart.Real
The possible values are included between 0 and infinity.
The default value is 80.
gr3DSPropRotationRotation angle (in degrees) of the chart around the horizontal axis (X axis).Real
The possible values are included between 0 and 360.
The value 0 displays a frontal view of chart.
The value 90 displays a right view of chart.
The best rotation angle is automatically calculated by default.
gr3DSPropTransparencyTransparency level (in percentage) for the bars or chart sectionsInteger
The possible values are included between 0 (opaque) and 100 (transparent/invisible).
The default value is 27%.
Versions 17 and later
grAlgoFunnel
New in version 17
grAlgoFunnel
grAlgoFunnel
Mode for representing the data in a Funnel chart.Integer constant:
  • grFunnelArea: The value is symbolized by the area of funnel section.
  • grFunnelHeight: The value is symbolized by the height of funnel section.
Versions 22 and later
grScrollbarZoomAlwaysVisible
New in version 22
grScrollbarZoomAlwaysVisible
grScrollbarZoomAlwaysVisible
Management of scrollbars during a zoom. Boolean.
  • True (by default) if the zoom scrollbars must always be visible, even when the chart is displayed at 100%.
  • False if the zoom scrollbars must become invisible when the chart is displayed at 100%.
Versions 23 and later
grSamplingEnabled
New in version 23
grSamplingEnabled
grSamplingEnabled
Management of data sampling. Boolean.
  • True if the data sampling is enabled.
  • False if the data sampling is disabled.
Versions 16 and later
grOptimizedLocation
New in version 16
grOptimizedLocation
grOptimizedLocation
Enable the optimization used to fill the available space for the Pie, Semi-circular and Donut charts displayed in a control or in a window.Boolean.
If the optimization of the fill is enabled, the Pie, Semi-circular and Donut charts will occupy the entire available space when they are displayed in a control or in a window.
The optimization of the fill is enabled by default.
grOptimizedMarksXEnable the optimization of marks on the horizontal axis (X axis).Boolean.
If the optimization of marks is enabled, only some marks are displayed to avoid the overlapping effects.
The optimization of marks is enabled by default ("Mark" option set to "Default" in the description window of Chart control).
grOptimizedMarksYEnable the optimization of marks on the vertical axis (Y axis).Boolean.
If the optimization of marks is enabled, only some marks are displayed to avoid the overlapping effects.
The optimization of marks is enabled by default ("Mark" option set to "Default" in the description window of Chart control).
Versions 21 and later
grHMDisplayColor
New in version 21
grHMDisplayColor
grHMDisplayColor
Mode for displaying colors between two values in a Heatmap chart. The possible values are:
  • grColorGradient (by default): A linear gradient is applied to the intermediate values.
  • grLowerLevel: The display of colors is done by level. All the values less than or equal to the level will take the color given by grHMColor.
  • grHigherLevel: The display of colors is done by level. All the values greater than or equal to the level will take the color given by grHMColor.
Versions 20 and later
grSunburstCaptionPerpendicularSection
New in version 20
grSunburstCaptionPerpendicularSection
grSunburstCaptionPerpendicularSection
Enable the display of captions perpendicular to sections.Boolean.
The captions are displayed in the width of the section by default. If this option is enabled (True), the caption will be displayed in the section height.
Versions 23 and later
grProjection3DScatter
New in version 23
grProjection3DScatter
grProjection3DScatter
Mode for displaying the projections on a 3D Scatter chart.The projections have been defined by grScatter3DProjection.
The possible values are:
  • grProjectionNone: No projection is performed.
  • grProjectionClick: The projections are visible during the click on the point.
  • grProjectionAlwaysVisible (by default): These projections are always visible.
Versions 20 and later
grInteractiveSunburst
New in version 20
grInteractiveSunburst
grInteractiveSunburst
Mode for managing the interactivity of Sunburst chart. Boolean.
  • True (default option): the Sunburst chart is interactive: a click on a section is used to display the sections of sub-levels.
  • False: the Sunburst chart is not interactive.
Versions 20 and later
grSunburstMaxLevel
New in version 20
grSunburstMaxLevel
grSunburstMaxLevel
Maximum number of levels displayed in a Sunburst chart. Integer.
Default value: 0 (corresponds to no limit).
Versions 22 and later
grInfiniteZoomOut
New in version 22
grInfiniteZoomOut
grInfiniteZoomOut
Management of zoom out (unzoom)Boolean.
  • True to allow the zoom out in a chart (which means to use a negative zoom when the chart is displayed at 100%)
  • False (by default) to forbid the zoom out.
WINDEVReports and QueriesUser code (UMC)

Various

No error is returned if grParameter is used on a type of chart other than 3D Spatial. If the options for drawing in 3 dimensions are not available, the information is stored and it will be used when the type of chart is modified (by grType or with the popup menu of the chart).
Related Examples:
WD Chart Training (WINDEV): WD Chart
[ + ] This educational example present 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

The main features presented in this example are the ability to customize the charts by programming as well as the method used to fill a chart from a HFSQL file or in the editor.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230grf.dll
Windows Mobile wp230grf.dll
Linux wd230grf.so
Minimum required version
  • Version 14
This page is also available for…
Comments
Click [Add] to post a comment