grTimeLevelMax (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Chart functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

grTimeLevelMax (Function)

In french: grNiveauTemporelMax

Defines the number of levels to display in the time scale of a chart as well as the maximum level.

Note: This function can be used in conjunction with grTimeLevelMask to define a mask for one level of the graph's time scale..

Example

// Fixe le nombre de niveaux maximum à afficher à 2
grTimeLevelMax(GRF_MonGraphe, 2)

// Interdit l'affichage des années pour GRF_MonGraphe
grTimeLevelMax(GRF_MonGraphe, 3, grtlMonth)

// Définition de l'échelle temporelle pour afficher plusieurs valeur par mois
// mais en affichant uniquement les mois dans l'échelle 
// (les jours ne sont pas affichés)
grTimeLevelMask(GRF_MonGraphe, grtlMonth, "Mmm")
grTimeLevelMax(GRF_MonGraphe, 1, grtlMonth)

Syntax

grTimeLevelMax(<Chart name> , <Number of levels> [, <Maximum level>])

<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 or page editor.

<Number of levels>: Integer

Maximum number of levels displayed in the chart.

<Maximum level>: Optional Integer constant

Maximum level to display:
grtlDay Maximum level displayed: days.
grtlHour Maximum level displayed: hours.
grtlMillisecond Maximum level displayed: milliseconds.
grtlMinute Maximum level displayed: minutes.
grtlMonth Maximum level displayed: months.
grtlSecond Maximum level displayed: seconds.
grtlYear Maximum level displayed: years.

Remarks

When displaying a time scale on DateTime data, the chart designer draws several levels corresponding to the different time units displayed.

The minimum level to display is defined according to the range of data.
The maximum level is defined by using two parameters:
- Maximum number of levels to be displayed in the graph (default: 3).
- The maximum level allowed for display (default: year).

grTimeLevelMax is used to modify these parameters. This allows you not to overload the chart or not to display some levels without relevance for the data displayed.

For example:

to avoid displaying the years, all you have to do is set the maximum level with the grtlMonth constant.
to avoid displaying more than two time levels in the chart, all you have to do is set the <Number of Levels> parameter to 2.

Component: wd300grf.dll