ToolTipOptions.ToolTipPosition Property

Represents how the tooltip position is defined, for example, relative to a mouse pointer or chart element.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

[XtraSerializableProperty(XtraSerializationVisibility.Content, true)]
public ToolTipPosition ToolTipPosition { get; set; }

VB.NET

<XtraSerializableProperty(XtraSerializationVisibility.Content, True)>
Public Property ToolTipPosition As ToolTipPosition

Property Value

Type	Description
ToolTipPosition	A ToolTipPosition class descendant that specifies the tooltip position type.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to ToolTipPosition
WinForms Controls	ChartControl	.ToolTipOptions.ToolTipPosition
ASP.NET Controls and MVC Extensions	ChartControlSettings	.ToolTipOptions.ToolTipPosition
	MVCxChartControl	.ToolTipOptions.ToolTipPosition
	WebChartControl	.ToolTipOptions.ToolTipPosition

Remarks

Use the ToolTipPosition property to choose a tooltip type - ToolTipFreePosition, ToolTipMousePosition, ToolTipPositionWithOffset or ToolTipRelativePosition.

For more information on how to use a tooltip, refer to the Tooltip topic.

Example

This example demonstrates how to enable and customize chart tooltips at runtime.

To enable tooltips, set the ChartControl.ToolTipEnabled property to true.

To learn more on chart tooltips, see the Tooltips topic.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-show-and-customize-chart-tooltips-t198819

Form1.cs

using DevExpress.XtraCharts;
using System;
using System.Windows.Forms;
using DevExpress.Utils;

namespace TooltipCustomization {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            // Create an empty chart.
            ChartControl chartControl = new ChartControl();

            // Add the chart to the form.
            chartControl.Dock = DockStyle.Fill;
            this.Controls.Add(chartControl);

            // Create a series and add points to it.
            Series series1 = new Series("Series 1", ViewType.Bar);
            series1.Points.Add(new SeriesPoint("A", new double[] { 4 }));
            series1.Points.Add(new SeriesPoint("B", new double[] { 2 }));
            series1.Points.Add(new SeriesPoint("C", new double[] { 17 }));
            series1.Points.Add(new SeriesPoint("D", new double[] { 4 }));
            series1.Points.Add(new SeriesPoint("E", new double[] { 17 }));
            series1.Points.Add(new SeriesPoint("F", new double[] { 12 }));
            series1.Points.Add(new SeriesPoint("G", new double[] { 15 }));

            // Add the series to the chart.
            chartControl.Series.Add(series1);

            // Disable a crosshair cursor.
            chartControl.CrosshairEnabled = DefaultBoolean.False;

            // Enable chart tooltips. 
            chartControl.ToolTipEnabled = DefaultBoolean.True;

            // Show a tooltip's beak
            ToolTipController controller = new ToolTipController();
            chartControl.ToolTipController = controller;
            controller.ShowBeak = true;

            // Change the default tooltip mouse position to relative position.
            ToolTipRelativePosition relativePosition = new ToolTipRelativePosition();
            chartControl.ToolTipOptions.ToolTipPosition = relativePosition;

            // Specify the tooltip relative position offsets.  
            relativePosition.OffsetX = 2;
            relativePosition.OffsetY = 2;

            // Specify the tooltip point pattern.
            series1.ToolTipPointPattern = "Bar Series: {A}:{V}";
        }
    }
}

Form1.vb

Imports DevExpress.XtraCharts
Imports System
Imports System.Windows.Forms
Imports DevExpress.Utils

Namespace TooltipCustomization
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            ' Create an empty chart.
            Dim chartControl As New ChartControl()

            ' Add the chart to the form.
            chartControl.Dock = DockStyle.Fill
            Me.Controls.Add(chartControl)

            ' Create a series and add points to it.
            Dim series1 As New Series("Series 1", ViewType.Bar)
            series1.Points.Add(New SeriesPoint("A", New Double() { 4 }))
            series1.Points.Add(New SeriesPoint("B", New Double() { 2 }))
            series1.Points.Add(New SeriesPoint("C", New Double() { 17 }))
            series1.Points.Add(New SeriesPoint("D", New Double() { 4 }))
            series1.Points.Add(New SeriesPoint("E", New Double() { 17 }))
            series1.Points.Add(New SeriesPoint("F", New Double() { 12 }))
            series1.Points.Add(New SeriesPoint("G", New Double() { 15 }))

            ' Add the series to the chart.
            chartControl.Series.Add(series1)

            ' Disable a crosshair cursor.
            chartControl.CrosshairEnabled = DefaultBoolean.False

            ' Enable chart tooltips. 
            chartControl.ToolTipEnabled = DefaultBoolean.True

            ' Show a tooltip's beak
            Dim controller As New ToolTipController()
            chartControl.ToolTipController = controller
            controller.ShowBeak = True

            ' Change the default tooltip mouse position to relative position.
            Dim relativePosition As New ToolTipRelativePosition()
            chartControl.ToolTipOptions.ToolTipPosition = relativePosition

            ' Specify the tooltip relative position offsets.  
            relativePosition.OffsetX = 2
            relativePosition.OffsetY = 2

            ' Specify the tooltip point pattern.
            series1.ToolTipPointPattern = "Bar Series: {A}:{V}"
        End Sub
    End Class
End Namespace