Table of Contents

Class Text

Namespace
ScottPlot.Plottables
Assembly
ScottPlot.dll
public class Text : LabelStyleProperties, IPlottable
Inheritance
Text
Implements
Inherited Members
Extension Methods

Fields

Label 

[Obsolete("Interact properties in this class (e.g., LabelFontColor) or properties of LabelStyle", true)]
public readonly LabelStyle Label

Field Value

LabelStyle

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

BackColor 

[Obsolete("use LabelBackgroundColor")]
public Color BackColor { get; set; }

Property Value

Color

BackgroundColor 

[Obsolete("Use LabelBackgroundColor")]
public Color BackgroundColor { get; set; }

Property Value

Color

Bold 

[Obsolete("use LabelBold")]
public bool Bold { get; set; }

Property Value

bool

BorderColor 

[Obsolete("use LabelBorderColor")]
public Color BorderColor { get; set; }

Property Value

Color

BorderWidth 

[Obsolete("use LabelBorderWidth")]
public float BorderWidth { get; set; }

Property Value

float

Color 

[Obsolete("Use LabelFontColor")]
public Color Color { get; set; }

Property Value

Color

FontColor 

[Obsolete("Use LabelFontColor")]
public Color FontColor { get; set; }

Property Value

Color

FontName 

[Obsolete("use LabelFontName")]
public string FontName { get; set; }

Property Value

string

FontSize 

[Obsolete("use LabelFontSize")]
public float FontSize { get; set; }

Property Value

float

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

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>

LineSpacing 

[Obsolete("use LabelLineSpacing")]
public float? LineSpacing { get; set; }

Property Value

float?

Location 

public Coordinates Location { get; set; }

Property Value

Coordinates

OffsetX 

public float OffsetX { get; set; }

Property Value

float

OffsetY 

public float OffsetY { get; set; }

Property Value

float

Padding 

[Obsolete("use LabelPadding or LabelPixelPadding")]
public float Padding { set; }

Property Value

float

Rotation 

[Obsolete("use LabelRotation")]
public float Rotation { get; set; }

Property Value

float

Size 

[Obsolete("use LabelFontSize")]
public float Size { get; set; }

Property Value

float

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