ScottPlot.ISignalSource Interface Reference

This interface is used by plottables to access data while rendering. This interface describes Y data sampled along an X axis at a fixed period. More...

Inheritance diagram for ScottPlot.ISignalSource:

Public Member Functions
PixelColumn	GetPixelColumn (IAxes axes, int xPixelIndex)
	Returns range information about the data at a specific pixel location.
int	GetIndex (double x, bool clamp)
	Returns the predicted index for the data point nearest a given X position. If clamped, the returned index will be clamped between 0 and Length - 1.
double	GetX (int index)
	Returns the X position for a given index.
double	GetY (int index)
	Returns the Y position for a given index.
IReadOnlyList< double >	GetYs ()
	Return an object for working with all Y values.
IEnumerable< double >	GetYs (int index1, int index2)
	Y values between a range of indexes (inclusive).
CoordinateRange	GetLimitsX ()
CoordinateRange	GetLimitsY ()
AxisLimits	GetLimits ()

Properties
double	Period [get, set]
	X distance between Y points.
double	XOffset [get, set]
	X position of the first data point.
double	YOffset [get, set]
	Shift Y position of all values by this amount.
double	YScale [get, set]
	Multiply Y values by this scale factor (before applying offset)
int	MaximumIndex [get, set]
	Do not display data above this index.
int	MinimumIndex [get, set]
	Do not display data below this index.

Detailed Description

This interface is used by plottables to access data while rendering. This interface describes Y data sampled along an X axis at a fixed period.

Member Function Documentation

GetIndex()

int ScottPlot.ISignalSource.GetIndex	(	double	x,
		bool	clamp
	)

Returns the predicted index for the data point nearest a given X position. If clamped, the returned index will be clamped between 0 and Length - 1.

GetLimits()

AxisLimits ScottPlot.ISignalSource.GetLimits

(

)

GetLimitsX()

CoordinateRange ScottPlot.ISignalSource.GetLimitsX

(

)

GetLimitsY()

CoordinateRange ScottPlot.ISignalSource.GetLimitsY

(

)

GetPixelColumn()

PixelColumn ScottPlot.ISignalSource.GetPixelColumn	(	IAxes	axes,
		int	xPixelIndex
	)

Returns range information about the data at a specific pixel location.

Implemented in ScottPlot.DataSources.FastSignalSourceDouble, ScottPlot.DataSources.SignalSourceDouble, ScottPlot.DataSources.SignalSourceGenericArray< T >, and ScottPlot.DataSources.SignalSourceGenericList< T >.

GetX()

double ScottPlot.ISignalSource.GetX

(

int

index

)

Returns the X position for a given index.

GetY()

double ScottPlot.ISignalSource.GetY

(

int

index

)

Returns the Y position for a given index.

Implemented in ScottPlot.DataSources.FastSignalSourceDouble, ScottPlot.DataSources.SignalSourceDouble, ScottPlot.DataSources.SignalSourceGenericArray< T >, and ScottPlot.DataSources.SignalSourceGenericList< T >.

GetYs() [1/2]

IReadOnlyList< double > ScottPlot.ISignalSource.GetYs

(

)

Return an object for working with all Y values.

Implemented in ScottPlot.DataSources.FastSignalSourceDouble, ScottPlot.DataSources.SignalSourceDouble, ScottPlot.DataSources.SignalSourceGenericArray< T >, and ScottPlot.DataSources.SignalSourceGenericList< T >.

GetYs() [2/2]

IEnumerable< double > ScottPlot.ISignalSource.GetYs	(	int	index1,
		int	index2
	)

Y values between a range of indexes (inclusive).

Implemented in ScottPlot.DataSources.FastSignalSourceDouble, ScottPlot.DataSources.SignalSourceDouble, ScottPlot.DataSources.SignalSourceGenericArray< T >, and ScottPlot.DataSources.SignalSourceGenericList< T >.

Property Documentation

MaximumIndex

int ScottPlot.ISignalSource.MaximumIndex

getset

Do not display data above this index.

MinimumIndex

int ScottPlot.ISignalSource.MinimumIndex

getset

Do not display data below this index.

Period

double ScottPlot.ISignalSource.Period

getset

X distance between Y points.

XOffset

double ScottPlot.ISignalSource.XOffset

getset

X position of the first data point.

YOffset

double ScottPlot.ISignalSource.YOffset

getset

Shift Y position of all values by this amount.

YScale

double ScottPlot.ISignalSource.YScale

getset

Multiply Y values by this scale factor (before applying offset)

---

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

• ScottPlot/src/ScottPlot5/ScottPlot5/Interfaces/ISignalSource.cs