TdxChartDiagramToolTipOptions.PointToolTipFormat Property

Specifies the formatting pattern for series point tooltips at the diagram level.

Declaration

property PointToolTipFormat: TdxChartTextFormat read; write;

Property Value

Type	Description
TdxChartTextFormat	The formatting pattern for series point tooltips.

Remarks

Series point tooltips display additional information on series points, such as arguments, values, and corresponding series captions. This tooltip appears when the mouse pointer hovers over a series point and the Chart control’s ToolTips.SimpleToolTipOptions.ShowForPoints property is set to True.

Use SeriesToolTipFormat and PointToolTipFormat properties to define formatting patterns for series caption and series point text displayed in simple tooltips at the diagram level. The PointToolTipFormat property also defines a formatting pattern displayed for a series in a Crosshair Cursor label.

A tooltip formatting pattern can consist of static content and one or more placeholder fields. A placeholder field is an expression enclosed in curly brackets that starts with a supported placeholder variable followed by a colon and a value formatting expression.

Series Tooltip Formatting Patterns

The following properties define formatting patterns for series caption and series point text at the level of individual series and have higher priority than SeriesToolTipFormat and PointToolTipFormat properties:

TdxChartSeriesToolTipOptions.SeriesToolTipFormat

Specifies a formatting pattern for the series tooltip.

TdxChartSeriesToolTipOptions.PointToolTipFormat

Specifies a formatting pattern for series point tooltips.

Tooltip Format Example

The following expression displays a tooltip with a series argument followed by a series value with two decimal places and a measurement unit: '{A}: {V:0.00}M sq.km'.

Supported Placeholder Field Variables

{V}

A series point value. If custom display text is defined for a series point value, the {V} placeholder variable displays this text instead of the actual value.

{A}

A series point argument. If custom display text is defined for a series point argument, the {A} placeholder variable displays this text instead of the actual argument.

{S}

A series caption (the Caption property value).

Supported Formatting Expressions

The Chart control supports all Spreadsheet-compatible formats as well as the following formatting expressions for date/time values in {V} and {A} placeholder fields:

c

A tooltip displays a date followed by a time value. ShortDateFormat and LongTimeFormat field values define date and time formats, respectively.

Note

The time value is hidden if it matches midnight.

ddddd

A tooltip displays only a date value. The ShortDateFormat field value defines the date format.

dddddd

A tooltip displays only a date value. The LongDateFormat field value defines the date format.

t

A tooltip displays only a time value. The ShortTimeFormat field value defines the time format.

tt

A tooltip displays only a time value. The LongTimeFormat field value defines the time format.

Placeholder Field Errors

A tooltip displays the following string if the formatting pattern contains an unsupported placeholder field: 'Variable "" not found!'.

Default Value

The PointToolTipFormat property’s default value is an empty string.

Simple Series

The default PointToolTipFormat property value indicates that a point tooltip in a simple series displays an argument and a value separated by a colon and a space character:

The default simple point tooltip formatting corresponds to the following formatting pattern: '{A}: {V}'.

XY Series

The default PointToolTipFormat property value indicates that a point tooltip in an XY series displays the Caption property value followed by an argument and a value separated by a colon and a space character.

The default XY point tooltip formatting corresponds to the following formatting patterns: '{S}#13#10{A}: {V}' (in Delphi) and "{S}\n{A}: {V}" (in C++Builder).

Note

You can assign a formatting pattern with a newline character only at runtime.

Crosshair Labels in XY Series

The default PointToolTipFormat property value indicates that the main crosshair label displays arguments and values of target series points separated by a colon and a space character.

The default XY point description in the main crosshair label corresponds to the following formatting patterns: '{S}: {V}' (in Delphi) and "{S}: {V}" (in C++Builder).