Class BarPlot

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

Holds a collection of individually styled bars

public class BarPlot : IPlottable, IHasLegendText

Inheritance

object

BarPlot

Implements

IPlottable

IHasLegendText

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

Constructors

BarPlot(List<Bar>)

public BarPlot(List<Bar> bars)

Parameters

bars List<Bar>

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

Bars

public List<Bar> Bars { get; }

Property Value

List<Bar>

Color

Apply a fill color to all bars

public Color Color { set; }

Property Value

Color

Horizontal

Define orientation for all bars

public bool Horizontal { set; }

Property Value

bool

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("use LegendText")]
public string Label { get; set; }

Property Value

string

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

LegendText

If populated, this text appears in the legend

public string LegendText { get; set; }

Property Value

string

ValueLabel

Text displayed above each bar, typically containing string representation of the value. This label is displayed below the bar for negative bars.

public string ValueLabel { get; set; }

Property Value

string

ValueLabelStyle

public LabelStyle ValueLabelStyle { get; set; }

Property Value

LabelStyle

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