TcxGridChartView.OnGetValueHint Event

Occurs when the text of a hint for a series value in the View needs to be determined.

Declaration

property OnGetValueHint: TcxGridChartGetValueHintEvent read; write;

Remarks

To provide detailed information on the values (their data markers) shown in the chart, Chart Views are capable of displaying value hints when an end-user hovers the mouse over the values. Handle the View’s OnGetValueHint event to customize the text of the value hint for a series value in the View specified by the Sender parameter. The series value is addressed by the ASeries and AValueIndex parameters which specify the series and the index of the series value in the Values collection of the corresponding series, respectively. The text of the value hint is returned via the AHint parameter which initially equals the GetValueHintText function’s return value.

By default, the text of the value hints which is returned by the GetValueHintText function includes the display text for the corresponding series and string representations of the corresponding category label and series value (as they appear in the chart according to the corresponding formats applied) for the value which is currently under the mouse pointer.

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