TcxGridChartController.GetValueHintText(TcxGridChartSeries,Integer) Method

Determines a value hint text for a specific chart value.

Declaration

function GetValueHintText(ASeries: TcxGridChartSeries; AValueIndex: Integer): string; virtual;

Parameters

Name	Type
ASeries	TcxGridChartSeries
AValueIndex	Integer

Returns

Type
string

Remarks

A chart value is referenced by a series and the value index in the Values collection of this series. These values are passed as the ASeries and AValueIndex parameters, respectively.

By default, a value hint’s text includes the following:

• the display text for the corresponding series;

• labels on the category and series values which correspond to the value currently located under the mouse pointer.

The resulting text is determined using the format string specified by the scxGridChartValueHintFormat resource string.

To customize value hint text, handle the View’s OnGetValueHint event which uses the GetValueHintText function’s return value as its initial value string.

Use the View’s OptionsBehavior.ValueHints property to control the visibility of value hints in the View.