Class VectorField

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public class VectorField : IPlottable, IHasArrow, IHasLegendText

Inheritance

object

VectorField

Implements

IPlottable

IHasArrow

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

VectorField(IVectorFieldSource)

public VectorField(IVectorFieldSource source)

Parameters

source IVectorFieldSource

Properties

ArrowAnchor

public ArrowAnchor ArrowAnchor { get; set; }

Property Value

ArrowAnchor

ArrowFillColor

public Color ArrowFillColor { get; set; }

Property Value

Color

ArrowLineColor

public Color ArrowLineColor { get; set; }

Property Value

Color

ArrowLineWidth

public float ArrowLineWidth { get; set; }

Property Value

float

ArrowMaximumLength

public float ArrowMaximumLength { get; set; }

Property Value

float

ArrowMinimumLength

public float ArrowMinimumLength { get; set; }

Property Value

float

ArrowOffset

public float ArrowOffset { get; set; }

Property Value

float

ArrowStyle

public ArrowStyle ArrowStyle { get; set; }

Property Value

ArrowStyle

ArrowWidth

public float ArrowWidth { get; set; }

Property Value

float

ArrowheadAxisLength

public float ArrowheadAxisLength { get; set; }

Property Value

float

ArrowheadLength

public float ArrowheadLength { get; set; }

Property Value

float

ArrowheadWidth

public float ArrowheadWidth { get; set; }

Property Value

float

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

Colormap

public IColormap? Colormap { get; set; }

Property Value

IColormap

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

MaximumArrowLength

Length (in pixels) of the longest arrow

public float MaximumArrowLength { 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