<Chart>.Color (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

How to retrieve the components of the color?
Colors of chart elements (legends, ...)
Colors in the charts (series, section, ...)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Chart>.Color (Function)

In french: <Graphe>.Couleur

Returns and initializes the color of different chart elements.

Caution: In Linux, this function requires a specific configuration. For more details, see The charts.

Example

// Modification des couleurs dans un champ Graphe
GRF_Graphe1.Couleur(grColorLegend, LightRed)
GRF_Graphe1.Dessine() // Bordure de la légende dessinée en rouge
GRF_Graphe1.Couleur(grColorLegend, LightBlue) // La bordure apparaît toujours en rouge
GRF_Graphe1.Dessine() // Bordure de la légende dessinée en bleu

Syntax

Finding out the color of an element in a Chart control Hide the details

<Result> = <Chart control>.Color(<Element>)

<Result>: Integer

Color of the specified element in RGB format.
Warning The value returned may differ depending on the display configuration (resolution, etc.).

<Chart control>: Control name

Name of the Chart control to use (in the window, page or report editor).
Only interactive Chart controls are available.

<Element>: Integer constant

Chart element whose color you want to get. This element can correspond to one of the following constants:
grColorAxis Color of axes.
grColorAxisSide Color of raised part of axes.
This constant is not available.
grColorBorder Color of border for the chart elements (for the charts other than 3D charts). Used to find out the border color for a bar in a column chart for example.
grColorBullishCandlestick Color of bars in a candlestick when the closing value is greater than the opening value.
This constant is not available.
grColorGridlines Gridline color.
grColorGridlinesSide Color of raised part of gridlines.
This constant is not available.
grColorLegend Color of legend border.
grColorLegendBackground Legend background color.

Modifying the color of an element in a Chart control Hide the details

<Chart control>.Color(<Element> [, <New color>])

<Chart control>: Control name

Name of the Chart control to use (in the window, page or report editor).

<Element>: Integer constant

Chart element whose color must be modified. This element can correspond to one of the following constants:
grColorAxis Color of axes.
grColorAxisSide Color of raised part of axes.
This constant is not available.
grColorBorder Color of border for the chart elements (for the charts other than 3D charts). Used to find out the border color for a bar in a column chart for example.
grColorBullishCandlestick Color of bars in a candlestick when the closing value is greater than the opening value.
This constant is not available.
grColorGridlines Gridline color.
grColorGridlinesSide Color of raised part of gridlines.
This constant is not available.
grColorLegend Color of legend border.
grColorLegendBackground Legend background color.

<New color>: Integer or constant (optional)

Color of the specified element. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color (see the preset colors of WLanguage).

Remarks

How to retrieve the components of the color?

To retrieve the components of the color returned by <Chart>.Color:

To get the red component, use RGBRed (or perform a division modulo 256 of <Result>),
To get the green component, use RGBGreen (or perform a division modulo 256 of <Result>/256),
To get the blue component, use RGBBlue (or perform a division modulo 256 of <Result>/256/256).

Colors of chart elements (legends, ...)

The settings defined with <Chart>.Color will be taken into account the next time <Chart>.Draw is called or the next time the chart is drawn (host control is resized, context menu is modified, etc.).
The transparent color can only be used for the background color of the legend (grColorLegendBackground constant).
Print graph If white color is associated with axes (constant grColorAxis), gridlines (constant grGridColor), the legend (constant grLegendColor) and border (constant grColorBorder), then the drawing will be printed in black.

Colors in the charts (series, section, ...)

The color of Bearish candlesticks is defined by the color of the series.
<Chart>.SeriesColor is used to modify the color of a series.
<Chart>.CategoryColor is used to modify the color of categories for the Pie and Color charts.
<Chart>.ScatterSeriesColor is used to initialize the color of a series in a "Scatter" chart.
<Chart>.SunburstSectionColor is used to change the color of a section in a Sunburst chart.
<Chart>.SurfaceAltitudeColor is used to define the color used for the altitude (Z axis) in a Surface chart.
<Chart>.WaterfallColor indicates the color for a type of category in a Waterfall chart.
<Chart>.HMColor is used to define the color of values in a Heatmap chart.

Component: wd300grf.dll