Class Annotation

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public class Annotation : LabelStyleProperties, IPlottable

Inheritance

object

LabelStyleProperties

Annotation

Implements

IPlottable

Inherited Members

LabelStyleProperties.LabelOffsetX

LabelStyleProperties.LabelOffsetY

LabelStyleProperties.LabelRotation

LabelStyleProperties.LabelPadding

LabelStyleProperties.LabelPixelPadding

LabelStyleProperties.LabelLastRenderPixelRect

LabelStyleProperties.LabelText

LabelStyleProperties.LabelAlignment

LabelStyleProperties.LabelFontName

LabelStyleProperties.LabelFontSize

LabelStyleProperties.LabelLineSpacing

LabelStyleProperties.LabelItalic

LabelStyleProperties.LabelBold

LabelStyleProperties.LabelFontColor

LabelStyleProperties.LabelBackgroundColor

LabelStyleProperties.LabelBorderRadius

LabelStyleProperties.LabelBorderRadiusX

LabelStyleProperties.LabelBorderRadiusY

LabelStyleProperties.LabelBorderWidth

LabelStyleProperties.LabelBorderColor

LabelStyleProperties.LabelShadowColor

LabelStyleProperties.LabelShadowOffset

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

DataSourceUtilities.BinarySearch<T, TList>(TList, int, int, T, IComparer<T>?)

DataSourceUtilities.GetClosestIndex<TValue, TList>(TList, TValue, IndexRange, IComparer<TValue>?)

Properties

Alignment

public Alignment Alignment { get; set; }

Property Value

Alignment

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

FractionRect

The annotation will be placed inside this fractional portion of the data area according to Alignment and PixelOffset

public FractionRect FractionRect { get; set; }

Property Value

FractionRect

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

Label

[Obsolete("Interact properties in this class (e.g., LabelFontColor) or properties of LabelStyle")]
public LabelStyle Label { get; set; }

Property Value

LabelStyle

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>

OffsetX

public float OffsetX { get; set; }

Property Value

float

OffsetY

public float OffsetY { get; set; }

Property Value

float

PixelOffset

public PixelOffset PixelOffset { get; set; }

Property Value

PixelOffset

Text

public string Text { get; set; }

Property Value

string

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