TdxChartDiagramToolTipOptions.SeriesToolTipFormat Property

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

Declaration

property SeriesToolTipFormat: TdxChartTextFormat read; write;

Property Value

Type	Description
TdxChartTextFormat	The formatting pattern for series tooltips.

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 common formatting patterns for simple tooltips displayed for all series in a diagram.

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 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 displays only the Caption property value.

The default series tooltip formatting corresponds to the following formatting pattern: '{S}'.