PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US

  • Drawing Parameter
  • 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
gr3DSParameter (Function)
In French: grParamètre3DS
Retrieves or modifies a parameter for drawing a chart in 3D Spatial mode.
This function can only be used with the charts created by programming (grCreate). This function must not be used on the Chart controls found in the report editor.
This function is equivalent to grParameter.
Example
// Modify the type of animation played when
// displaying the chart named "MyChart"
// The bars will be built progressively and
// the chart will appear with a rotation effect
gr3DSParameter("MyChart", gr3DSPropAnimation, 10)
Syntax

Retrieving the value of a drawing parameter Hide the details

<Result> = gr3DSParameter(<Chart Name> , <Drawing Parameter>)
<Result>: Integer, real or boolean
Value of drawing parameter. The type depends on the specified drawing 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 Chart control created in the window editor.
<Drawing Parameter>: Integer constant
Drawing parameter whose value is requested:
gr3DSPropAnimationType of animation played when displaying the chart.
gr3DSPropAutoZoomAutomatic zoom of chart.
gr3DSPropColorPlaneXColor of vertical plane (axis to right or to left).
gr3DSPropColorPlaneYColor of horizontal plane (axis above or below).
gr3DSPropColorPlaneZColor of background plane.
gr3DSPropDistanceZoom of chart.
gr3DSPropElevationRotation angle of chart around the vertical axis (Y axis).
gr3DSPropLegendOverlapThe chart legend and title are stacked.
gr3DSPropLightXX coordinate of the light that is lighting the chart.
gr3DSPropLightYY coordinate of the light that is lighting the chart.
gr3DSPropRotationRotation angle of chart around the horizontal axis (X axis).
gr3DSPropTransparencyTransparency level for the bars or sections of chart.

Modifying the value of a drawing parameter Hide the details

gr3DSParameter(<Chart Name> , <Drawing 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 Chart control created in the window editor.
<Drawing Parameter>: Constant
Drawing parameter to modify:
gr3DSPropAnimationType of animation played when displaying the chart.
gr3DSPropAutoZoomAutomatic zoom of chart.
gr3DSPropColorPlaneXColor of vertical plane (axis to right or to left).
gr3DSPropColorPlaneYColor of horizontal plane (axis above or below).
gr3DSPropColorPlaneZColor of background plane.
gr3DSPropDistanceZoom of chart.
gr3DSPropElevationRotation angle of chart around the vertical axis (Y axis).
gr3DSPropLegendOverlapThe chart legend and title are stacked.
gr3DSPropLightXX coordinate of the light that is lighting the chart.
gr3DSPropLightYY coordinate of the light that is lighting the chart.
gr3DSPropRotationRotation angle of chart around the horizontal axis (X axis).
gr3DSPropTransparencyTransparency level for the bars or sections of chart.
<Value>: Integer, real or boolean
Value of drawing parameter. The type depends on the specified drawing parameter (see the Notes).
Remarks

Drawing Parameter

The parameters for drawing a 3D spatial chart are as follows:
ConstantEffectValue of drawing parameter
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
RGB component of the color (returned by RGB) or a preset color.
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
RGB component of the color (returned by RGB) or a preset color.
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
RGB component of the color (returned by RGB) or a preset color.
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 stacked.Boolean
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 chartReal
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 sections.Integer
The possible values are included between 0 (opaque) and 100 (transparent/invisible).
The default value is 27%.

Various

No error is returned if gr3DSParameter is used on a type of chart other than 3D Spatial. The information is stored and it will be used when the type of the chart is modified (by grType or with the popup menu of the chart).
Components
WINDEVReports and Queries wd230grf.dll
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment