grCategoryLabel (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Managing the category labels

Related examples

See also

grCategoryLabel (Function)

In french: grEtiquetteCatégorie

Allows you to:

Initialize the label of data category (or section) in a chart.
Not available.
Versions 25 and later
Find out the label of data category (or section) in a chart.
New in version 25
Find out the label of data category (or section) in a chart.
Find out the label of data category (or section) in a chart.

Example of category label:

Reminder: A chart element has no label by default.

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.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 19 and later

This function is now available for Android applications.

New in version 19

This function is now available for Android applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 23 and later

This function is now available for PHP sites.

New in version 23

This function is now available for PHP sites.

This function is now available for PHP sites.

Versions 25 and later

This function is now available in browser code.

New in version 25

This function is now available in browser code.

Example

// Initialize the "January" label of second data category
// in "MyChart"
grCategoryLabel("MyChart", 2, "January")

// Initialize the "January" label of second data category
// in "MyChart"
grCategoryLabel(CHART_MyChart, 2, "January")

Versions 25 and later

// Read label of second data category
// in "MyChart"
MyLabel is string = grCategoryLabel(CHART_MyChart, 2)

New in version 25

// Read label of second data category
// in "MyChart"
MyLabel is string = grCategoryLabel(CHART_MyChart, 2)

Syntax

Not available

Initializing the label of data category (or section) in a chart Hide the details

grCategoryLabel(<Chart name> , <Subscript> , <Label>)

<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.
Only the Chart controls are available.
Only the interactive Chart controls are available.

<Subscript>: Integer

Subscript of data in the series.

<Label>: Character string

Caption of label to initialize.
Versions 23 and later
This parameter can also correspond to a duration, a date, a time or a date-time.
Remark: If you are using a temporal abscissa scale, grCategoryLabel must be systematically called whenever adding data into the chart with grAddData.
New in version 23
This parameter can also correspond to a duration, a date, a time or a date-time.
Remark: If you are using a temporal abscissa scale, grCategoryLabel must be systematically called whenever adding data into the chart with grAddData.
This parameter can also correspond to a duration, a date, a time or a date-time.
Remark: If you are using a temporal abscissa scale, grCategoryLabel must be systematically called whenever adding data into the chart with grAddData.

Versions 25 and later

Finding out the label of data category (or section) in a chart Hide the details

<Result> = grCategoryLabel(<Chart name> , <Subscript>)

<Result>: Character string

Label caption.

<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.
Only the Chart controls are available.
Only the interactive Chart controls are available.

<Subscript>: Integer

Subscript of data (whose label is searched for) in the series.

New in version 25

Finding out the label of data category (or section) in a chart Hide the details

<Result> = grCategoryLabel(<Chart name> , <Subscript>)

<Result>: Character string

Label caption.

<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.
Only the Chart controls are available.
Only the interactive Chart controls are available.

<Subscript>: Integer

Subscript of data (whose label is searched for) in the series.

Finding out the label of data category (or section) in a chart Hide the details

<Result> = grCategoryLabel(<Chart name> , <Subscript>)

<Result>: Character string

Label caption.

<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.
Only the Chart controls are available.
Only the interactive Chart controls are available.

<Subscript>: Integer

Subscript of data (whose label is searched for) in the series.

Remarks

Managing the category labels

The category labels are displayed:

below the horizontal marks for the Line charts and Stock charts (Candlestick and BarCharts),
below the X axis for the column charts and MinMax charts.

The category labels cannot be used with the Scatter charts.

The category labels are defined by grCategoryLabel.

The data defined by grCategoryLabel will be taken into account during the next call to grDraw.

The label font can be modified by grLabelFont.

The category labels defined by grCategoryLabel can be displayed in the label of Pie charts (grShowLabel constant used with grLabel).

Related Examples:

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.

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 control

[ + ] Using the Chart control to display different types of charts:
- Pie (or pie chart)
- Line
- Column chart
- Area

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 / GUI classification : Neutral code

Component : wd250grf.dll