Class SignalXY

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public class SignalXY : IPlottable, IHasLine, IHasMarker, IHasLegendText, IGetNearest

Inheritance

object

SignalXY

Implements

IPlottable

IHasLine

IHasMarker

IHasLegendText

IGetNearest

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

SignalXY(ISignalXYSource)

public SignalXY(ISignalXYSource dataSource)

Parameters

dataSource ISignalXYSource

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

Color

public Color Color { get; set; }

Property Value

Color

ConnectStyle

The style of lines to use when connecting points.

public ConnectStyle ConnectStyle { get; set; }

Property Value

ConnectStyle

Data

public ISignalXYSource Data { get; set; }

Property Value

ISignalXYSource

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

LineColor

public Color LineColor { get; set; }

Property Value

Color

LinePattern

public LinePattern LinePattern { get; set; }

Property Value

LinePattern

LineStyle

public LineStyle LineStyle { get; set; }

Property Value

LineStyle

LineWidth

public float LineWidth { get; set; }

Property Value

float

MarkerColor

public Color MarkerColor { get; set; }

Property Value

Color

MarkerFillColor

public Color MarkerFillColor { get; set; }

Property Value

Color

MarkerLineColor

public Color MarkerLineColor { get; set; }

Property Value

Color

MarkerLineWidth

public float MarkerLineWidth { get; set; }

Property Value

float

MarkerShape

public MarkerShape MarkerShape { get; set; }

Property Value

MarkerShape

MarkerSize

public float MarkerSize { get; set; }

Property Value

float

MarkerStyle

public MarkerStyle MarkerStyle { get; set; }

Property Value

MarkerStyle

MaxRenderIndex

public int MaxRenderIndex { get; set; }

Property Value

int

MinRenderIndex

public int MinRenderIndex { get; set; }

Property Value

int

XAxisIndex

public int XAxisIndex { get; set; }

Property Value

int

YAxisIndex

public int YAxisIndex { get; set; }

Property Value

int

Methods

GetAxisLimits()

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

public AxisLimits GetAxisLimits()

Returns

AxisLimits

GetNearest(Coordinates, RenderDetails, float)

Return the point nearest a specific location given the X/Y pixel scaling information from a previous render. Will return None if the nearest point is greater than maxDistance pixels away.

public DataPoint GetNearest(Coordinates location, RenderDetails renderInfo, float maxDistance = 15)

Parameters

location Coordinates

renderInfo RenderDetails

maxDistance float

Returns

DataPoint

GetNearestX(Coordinates, RenderDetails, float)

Return the point nearest a specific X location given the X/Y pixel scaling information from a previous render. Will return None if the nearest point is greater than maxDistance pixels away.

public DataPoint GetNearestX(Coordinates location, RenderDetails renderInfo, float maxDistance = 15)

Parameters

location Coordinates

renderInfo RenderDetails

maxDistance float

Returns

DataPoint

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