Class Bracket

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public class Bracket : IPlottable

Inheritance

object

Bracket

Implements

IPlottable

Inherited Members

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>?)

Fields

EdgeLength

Size of the small lines (in pixels) placed the edges of the bracket and between the center of the bracket and the label

public float EdgeLength

Field Value

float

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

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

LabelCounterClockwise

Controls whether the tip of the bracket is counter-clockwise from the line formed by the bracket base.

public bool LabelCounterClockwise { get; set; }

Property Value

bool

LabelStyle

public LabelStyle LabelStyle { get; set; }

Property Value

LabelStyle

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

LineStyle

public LineStyle LineStyle { get; set; }

Property Value

LineStyle

Point1

public Coordinates Point1 { get; set; }

Property Value

Coordinates

Point2

public Coordinates Point2 { get; set; }

Property Value

Coordinates

Text

Text displayed near the center of the bracket

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