TdxChartSeriesToolTipOptions.SeriesToolTipFormat Property

Specifies a formatting pattern for the series tooltip.

Declaration

property SeriesToolTipFormat: TdxChartTextFormat read; write;

Property Value

Type	Description
TdxChartTextFormat	The formatting pattern for the series tooltip.

Remarks

A series tooltip displays a series caption. This tooltip appears when the mouse pointer hovers over a series and the Chart control’s ToolTips.SimpleToolTipOptions.ShowForSeries property is set to True.

Use SeriesToolTipFormat and PointToolTipFormat properties to define formatting patterns for a series caption displayed in simple tooltips at the level of individual series. The PointToolTipFormat property also defines a formatting pattern 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.

Diagram ToolTip Format Settings

The following properties define formatting patterns for series caption and series point text in simple tooltips and crosshair labels at the diagram level.

TdxChartDiagramToolTipOptions.PointToolTipFormat

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

TdxChartDiagramToolTipOptions.SeriesToolTipFormat

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

These settings affect a series only if SeriesToolTipFormat and PointToolTipFormat properties have default values.

Tooltip Format Example

The following expression displays a tooltip with the string 'Series: ' followed by a series caption: 'Series: {S}'.

Supported Placeholder Field Variable

Series tooltips support only the {S} placeholder field variable that displays the Caption property value.

Placeholder Field Errors

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

Default Value

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

The default SeriesToolTipFormat property value indicates that the series tooltip uses the tooltip formatting pattern defined at the diagram level.