ScottPlot.Plottables.Arrow Class Reference

Inheritance diagram for ScottPlot.Plottables.Arrow:

Public Member Functions
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
virtual void	Render (RenderPack rp)
	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.

Properties
Coordinates	Base = Coordinates.Origin [get, set]
Coordinates	Tip = Coordinates.Origin [get, set]
bool	IsVisible = true [get, set]
	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).
IAxes	Axes = new Axes() [get, set]
	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.
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
string	LegendText = string.Empty [get, set]
	If populated, this text appears in the legend.
ArrowStyle	ArrowStyle = new() { LineWidth = 2, LineColor = Colors.Black } [get, set]
Color	ArrowLineColor [get, set]
float	ArrowLineWidth [get, set]
Color	ArrowFillColor [get, set]
float	ArrowMinimumLength [get, set]
float	ArrowMaximumLength [get, set]
float	ArrowOffset [get, set]
ArrowAnchor	ArrowAnchor [get, set]
float	ArrowWidth [get, set]
float	ArrowheadAxisLength [get, set]
float	ArrowheadLength [get, set]
float	ArrowheadWidth [get, set]
string	Label [get, set]
Color	ArrowColor [get, set]
Color	Color [get, set]
float	Offset [get, set]
float	MinimumLength [get, set]
float	LineWidth [get, set]
LineStyle	LineStyle [get, set]
IArrowShape	ArrowShape = new ArrowShapes.Single() [get, set]
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasArrow
Properties inherited from ScottPlot.IHasLegendText

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.Arrow.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

Render()

virtual void ScottPlot.Plottables.Arrow.Render ( RenderPack  rp )

inlinevirtual

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.

Implements ScottPlot.IPlottable.

Property Documentation

ArrowAnchor

ArrowAnchor ScottPlot.Plottables.Arrow.ArrowAnchor

getset

Implements ScottPlot.IHasArrow.

ArrowColor

Color ScottPlot.Plottables.Arrow.ArrowColor

getset

ArrowFillColor

Color ScottPlot.Plottables.Arrow.ArrowFillColor

getset

Implements ScottPlot.IHasArrow.

ArrowheadAxisLength

float ScottPlot.Plottables.Arrow.ArrowheadAxisLength

getset

Implements ScottPlot.IHasArrow.

ArrowheadLength

float ScottPlot.Plottables.Arrow.ArrowheadLength

getset

Implements ScottPlot.IHasArrow.

ArrowheadWidth

float ScottPlot.Plottables.Arrow.ArrowheadWidth

getset

Implements ScottPlot.IHasArrow.

ArrowLineColor

Color ScottPlot.Plottables.Arrow.ArrowLineColor

getset

Implements ScottPlot.IHasArrow.

ArrowLineWidth

float ScottPlot.Plottables.Arrow.ArrowLineWidth

getset

Implements ScottPlot.IHasArrow.

ArrowMaximumLength

float ScottPlot.Plottables.Arrow.ArrowMaximumLength

getset

Implements ScottPlot.IHasArrow.

ArrowMinimumLength

float ScottPlot.Plottables.Arrow.ArrowMinimumLength

getset

Implements ScottPlot.IHasArrow.

ArrowOffset

float ScottPlot.Plottables.Arrow.ArrowOffset

getset

Implements ScottPlot.IHasArrow.

ArrowShape

IArrowShape ScottPlot.Plottables.Arrow.ArrowShape = new ArrowShapes.Single()

getset

ArrowStyle

ArrowStyle ScottPlot.Plottables.Arrow.ArrowStyle = new() { LineWidth = 2, LineColor = Colors.Black }

getset

Implements ScottPlot.IHasArrow.

ArrowWidth

float ScottPlot.Plottables.Arrow.ArrowWidth

getset

Implements ScottPlot.IHasArrow.

Axes

IAxes ScottPlot.Plottables.Arrow.Axes = new Axes()

getset

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.

Implements ScottPlot.IPlottable.

Base

Coordinates ScottPlot.Plottables.Arrow.Base = Coordinates.Origin

getset

Color

Color ScottPlot.Plottables.Arrow.Color

getset

IsVisible

bool ScottPlot.Plottables.Arrow.IsVisible = true

getset

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

Implements ScottPlot.IPlottable.

Label

string ScottPlot.Plottables.Arrow.Label

getset

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.Arrow.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LegendText

string ScottPlot.Plottables.Arrow.LegendText = string.Empty

getset

If populated, this text appears in the legend.

Implements ScottPlot.IHasLegendText.

LineStyle

LineStyle ScottPlot.Plottables.Arrow.LineStyle

getset

LineWidth

float ScottPlot.Plottables.Arrow.LineWidth

getset

MinimumLength

float ScottPlot.Plottables.Arrow.MinimumLength

getset

Offset

float ScottPlot.Plottables.Arrow.Offset

getset

Tip

Coordinates ScottPlot.Plottables.Arrow.Tip = Coordinates.Origin

getset

---

The documentation for this class was generated from the following file:

• ScottPlot/src/ScottPlot5/ScottPlot5/Plottables/Arrow.cs