Table of Contents

Class Tooltip

Namespace
ScottPlot.Plottables
Assembly
ScottPlot.dll

A tooltip displays a text bubble pointing to a specific location in X/Y space. The position of the bubble moves according to the axis limits to best display the text in the data area.

public class Tooltip : LabelStyleProperties, IPlottable, IHasLine, IHasFill
Inheritance
Tooltip
Implements
Inherited Members
Extension Methods

Properties

Axes

This object performs coordinate/pixel translation at render time based on the latest data area. It stores the axes to use for this plottable and also the data area (in pixels) updated just before each render. If this object is null it will be constructed using the default X and Y axes at render time.

public IAxes Axes { get; set; }

Property Value

IAxes

FillColor 

public Color FillColor { get; set; }

Property Value

Color

FillHatch 

public IHatch? FillHatch { get; set; }

Property Value

IHatch

FillHatchColor 

public Color FillHatchColor { get; set; }

Property Value

Color

FillStyle 

public FillStyle FillStyle { get; set; }

Property Value

FillStyle

IsVisible

Toggles whether this plottable is shown and contributes to the automatic axis limit detection. The calling method will check this variable (it does not need to be checked inside the Render method).

public bool IsVisible { get; set; }

Property Value

bool

LabelLocation

Location in coordinate space where the text of the tooltip will be displayed

public Coordinates LabelLocation { get; set; }

Property Value

Coordinates

LabelStyle 

public override LabelStyle LabelStyle { get; set; }

Property Value

LabelStyle

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

LineColor 

public Color LineColor { get; set; }

Property Value

Color

LinePattern 

public LinePattern LinePattern { get; set; }

Property Value

LinePattern

LineStyle 

public LineStyle LineStyle { get; set; }

Property Value

LineStyle

LineWidth 

public float LineWidth { get; set; }

Property Value

float

Padding

Distance (in pixels) of empty space between all sides of the label and the edge of the tooltip body

public float Padding { get; set; }

Property Value

float

TailWidthPercentage

Fractional size of the tail where it attaches to the tooltip body

public double TailWidthPercentage { get; set; }

Property Value

double

TipLocation

Location in coordinate space of the tip of the tail

public Coordinates TipLocation { get; set; }

Property Value

Coordinates

Methods

GetAxisLimits()

Return the 2D area (in coordinate space) occupied by the data contained in this plottable

public AxisLimits GetAxisLimits()

Returns

AxisLimits

Render(RenderPack)

Draw the data from this plottable into the data area defined in the Axes. By default the surface is already clipped to the data area, but this can be cleared inside the plottable.

public virtual void Render(RenderPack rp)

Parameters

rp RenderPack
Edit this page