grCreate (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Functions for managing charts

Creating and drawing a chart by programming

Drawing several charts at the same time

Charts and threads

Default values of a chart created by programming

Related examples

See also

grCreate (Function)

In french: grCrée

Creates a specific type of chart.

Remarks:

It is recommended to create a Chart control directly rather than using grCreate. Indeed, the Chart control offers many more features.
This function can only be used to create a chart by programming. This function cannot be used in the window editor, page editor or report editor.

Versions 15 and later

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The charts for more details.

New in version 15

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The charts for more details.

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The charts for more details.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Example

// Create a column chart
// (and save the parameters modified by the user)
grCreate("MyChart", grColumn)

Syntax

grCreate(<Chart name> , <Chart type> [, <Persistence>])

<Chart name>: Character string (with quotes)

Name of chart to create. This name will be used by all functions for chart management. Caution: this name must not correspond to the name of a Chart control.

<Chart type>: Constant

Specifies the type of chart to create:
gr3DSAreaStacked 3D chart of stacked areas.
This constant is not available.
gr3DSAreaDepth 3D chart of areas shown one behind the other.
This constant is not available.
gr3DSLine 3D line chart.
This constant is not available.
gr3DSCylinderColStacked 3D stacked bar chart.
The bars are represented by cylinders.
This constant is not available.
gr3DSCylinderColClustered 3D clustered column chart
The bars are represented by cylinders.
This constant is not available.
gr3DSCylinderColDepth 3D column chart in depth: the series are represented in perspective.
The bars are represented by cylinders.
This constant is not available.
gr3DSColumnStacked 3D stacked bar chart.
The bars are represented by 3D rectangles. This type of chart does not support the negative values.
This constant is not available.
gr3DSColumnClustered 3D clustered column chart.
The bars are represented by 3D rectangles.
This constant is not available.
gr3DSColumnDepth 3D column chart in depth: the series are represented in perspective.
The bars are represented by 3D rectangles.
This constant is not available.
gr3DSMinMax 3D Stock chart displaying the difference between the minimum stock value and the maximum stock value
This constant is not available.
gr3DSScatter 3D Scatter chart.
This constant is not available.
gr3DSPie 3D Pie chart.
This constant is not available.
grArea Area chart (see example of Area chart).
grBarCharts Stock chart (see example of Stock chart).
grCandlestick Candlestick stock chart (see example of Stock chart).
grCurve Line chart (see example of Line chart).
grDonut Donut chart. See example of Donut chart.
Versions 17 and later
grFunnel
New in version 17
grFunnel
grFunnel Funnel chart. See example of Funnel chart.
Versions 16 and later
grBubbleChart
New in version 16
grBubbleChart
grBubbleChart Bubble chart (see example of bubble chart).
Versions 21 and later
grHeatMap
New in version 21
grHeatMap
grHeatMap Heatmap chart (see example of Heatmap chart).
grSemiCircular Semi-circular chart (see example of Semi-circular chart).
grColumn Column chart (see example of Column chart).
grColumnStacked Stacked Column chart. This type of chart does not support the negative values.
grMinMax Stock chart displaying the difference between the minimum stock value and the maximum stock value (see example of Stock chart)
grScatter Scatter chart (see example of Scatter chart).
Versions 23 and later
grScatter3D
New in version 23
grScatter3D
grScatter3D 3D Scatter chart (see example of 3D Scatter chart).
Versions 24 and later
grPyramid
New in version 24
grPyramid
grPyramid Pyramid chart (see example of a Pyramid chart).
grRadar Radar chart (see example of Radar chart).
grPie Pie chart (see example of Pie chart).
Versions 20 and later
grSunburst
New in version 20
grSunburst
grSunburst Sunburst chart. See example of Sunburst chart.
Versions 18 and later
grSurface
New in version 18
grSurface
grSurface Surface chart (see example of Surface chart).
This constant is not available.
Versions 19 and later
grWaterfall
New in version 19
grWaterfall
grWaterfall Waterfall chart (see example of Waterfall chart).

The type of chart can be modified later by grType.

<Persistence>: Optional boolean

True (default value) to save the modifications made to the chart by the user via the popup menu,
False not to save these modifications.

Remarks

Creating and drawing a chart by programming

To create and draw a chart:

create the chart (grCreate),
add data (grAddData, grStockAddData and grScatterAddDataXY),
define the chart destination with the following functions:
- grDestinationBMP,
- grDestinationControl,
- grDestinationEMF,
- grDestinationWnd,
- Versions 19 and later
  grDestinationImage,
  New in version 19
  grDestinationImage,
  grDestinationImage,
- grDestinationWMF.
draw the chart (grDraw).

Drawing several charts at the same time

Several charts with the same name cannot exist at the same time.

To draw several charts at the same time (in one or more windows for example), different chart names must be specified.

Charts and threads

A single chart can be handled in a thread.

Consequences:

Two threads cannot handle the same chart.
A chart created in a thread is automatically destroyed at the end of this thread. The chart exists in the thread that contains the call to grCreate.

Default values of a chart created by programming

The default values of a chart are as follows:

Popup menu enabled (can be configured by grMenu and grMenuOption).
The popup menus are not available.
Automatic marks on axes (can be configured by grGraduate).
The colors are selected according to a preset order among a set of 13 colors (can be configured by grSeriesColor).
The color gradients are available (can be configured by grGradient).
File size (can be configured by grWndSize).
Window size (can be configured by grWndSize).
No display can be performed in a window.
No label for the series (can be configured by grSeriesLabel).
No caption for the elements (can be configured by grCategoryLabel and grLabel).
No legend (can be configured by grLegend).
No title for the chart (can be configured by grTitle).
No title for the axes (can be configured by grAxisTitle).
No gridlines (can be configured by grGridlines).
No data (elements can be added by grAddData).
No destination (can be configured by grDestinationBMP, grDestinationControl, grDestinationEMF, grDestinationWnd and grDestinationWMF).
No chart display (to draw the chart, use grDraw).
No raised effect (can be configured by grRaised).
For the pie charts, the start angle is equal to 0 (can be configured by grPieStartAngle).
For the bar charts and the MinMax charts, the spacing between two categories is equal to 10 pixels (can be configured by grColumnSpacing).
For scatter charts, the points are linked and their size is equal to 1 (can be configured by grScatterLinkPoint and grScatterPointSize).

Related Examples:

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

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, ...)

Business / UI classification : Neutral code

Component : wd260grf.dll