ScottPlot
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY > Class Template Reference
Inheritance diagram for ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >:
ScottPlot.ISignalXYSource ScottPlot.IDataSource ScottPlot.IGetNearest

Public Member Functions

 SignalXYSourceGenericArray (TX[] xs, TY[] ys)
 
AxisLimits GetAxisLimits ()
 Return the axis limits covered by these data.
 
Pixel[] GetPixelsToDraw (RenderPack rp, IAxes axes, ConnectStyle connectStyle)
 Return pixels to render to display this signal. May return one extra point on each side of the plot outside the data area.
 
Pixel[] GetPixelsToDrawHorizontally (RenderPack rp, IAxes axes, ConnectStyle connectStyle)
 
Pixel[] GetPixelsToDrawVertically (RenderPack rp, IAxes axes, ConnectStyle connectStyle)
 
CoordinateRange GetRangeY (int index1, int index2)
 Return the vertical range covered by data between the given indices (inclusive)
 
int GetIndex (double x)
 Get the index associated with the given X position.
 
int GetIndex (double x, IndexRange indexRange)
 Get the index associated with the given X position limited to the given range.
 
IEnumerable< PixelGetColumnPixelsX (int pixelColumnIndex, IndexRange rng, RenderPack rp, IAxes axes)
 Given a pixel column, return the pixels to render its line. If the column contains no data, no pixels are returned. If the column contains one point, return that one pixel. If the column contains multiple points, return 4 pixels: enter, min, max, and exit.
 
IEnumerable< PixelGetColumnPixelsY (int pixelColumnIndex, IndexRange rng, RenderPack rp, IAxes axes)
 Given a pixel column, return the pixels to render its line. If the column contains no data, no pixels are returned. If the column contains one point, return that one pixel. If the column contains multiple points, return 4 pixels: enter, min, max, and exit.
 
DataPoint GetNearest (Coordinates mouseLocation, RenderDetails renderInfo, float maxDistance=15)
 Return the point nearest a specific location given the X/Y pixel scaling information from a previous render. Will return DataPoint.None if the nearest point is greater than maxDistance pixels away.
 
DataPoint GetNearestX (Coordinates mouseLocation, RenderDetails renderInfo, float maxDistance=15)
 Return the point nearest a specific X location given the X/Y pixel scaling information from a previous render. Will return DataPoint.None if the nearest point is greater than maxDistance pixels away.
 

Properties

TX[] Xs [get, set]
 
TY[] Ys [get, set]
 
int Count [get]
 Number of values in the data source.
 
bool Rotated = false [get, set]
 If enabled, Xs will be vertical and Ys will be horizontal.
 
double XOffset = 0 [get, set]
 X position of the first data point.
 
double YOffset = 0 [get, set]
 Shift Y position of all values by this amount.
 
double YScale = 1 [get, set]
 Multiply Y values by this scale factor (before applying offset)
 
double XScale = 1 [get, set]
 Multiply X values by this scale factor (before applying offset)
 
int MinimumIndex = 0 [get, set]
 Do not display data below this index.
 
int MaximumIndex [get, set]
 Do not display data above this index.
 
bool UsePixelOverlap = false [get]
 
- Properties inherited from ScottPlot.ISignalXYSource
- Properties inherited from ScottPlot.IDataSource

Constructor & Destructor Documentation

◆ SignalXYSourceGenericArray()

Member Function Documentation

◆ GetAxisLimits()

Return the axis limits covered by these data.

Implements ScottPlot.ISignalXYSource.

◆ GetColumnPixelsX()

IEnumerable< Pixel > ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetColumnPixelsX ( int  pixelColumnIndex,
IndexRange  rng,
RenderPack  rp,
IAxes  axes 
)
inline

Given a pixel column, return the pixels to render its line. If the column contains no data, no pixels are returned. If the column contains one point, return that one pixel. If the column contains multiple points, return 4 pixels: enter, min, max, and exit.

◆ GetColumnPixelsY()

IEnumerable< Pixel > ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetColumnPixelsY ( int  pixelColumnIndex,
IndexRange  rng,
RenderPack  rp,
IAxes  axes 
)
inline

Given a pixel column, return the pixels to render its line. If the column contains no data, no pixels are returned. If the column contains one point, return that one pixel. If the column contains multiple points, return 4 pixels: enter, min, max, and exit.

◆ GetIndex() [1/2]

int ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetIndex ( double  x)
inline

Get the index associated with the given X position.

◆ GetIndex() [2/2]

int ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetIndex ( double  x,
IndexRange  indexRange 
)
inline

Get the index associated with the given X position limited to the given range.

◆ GetNearest()

DataPoint ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetNearest ( Coordinates  location,
RenderDetails  renderInfo,
float  maxDistance = 15 
)

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

Implements ScottPlot.ISignalXYSource.

◆ GetNearestX()

DataPoint ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetNearestX ( Coordinates  location,
RenderDetails  renderInfo,
float  maxDistance = 15 
)

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

Implements ScottPlot.ISignalXYSource.

◆ GetPixelsToDraw()

Pixel[] ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetPixelsToDraw ( RenderPack  rp,
IAxes  axes,
ConnectStyle  connectStyle 
)
inline

Return pixels to render to display this signal. May return one extra point on each side of the plot outside the data area.

Implements ScottPlot.ISignalXYSource.

◆ GetPixelsToDrawHorizontally()

Pixel[] ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetPixelsToDrawHorizontally ( RenderPack  rp,
IAxes  axes,
ConnectStyle  connectStyle 
)
inline

◆ GetPixelsToDrawVertically()

Pixel[] ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetPixelsToDrawVertically ( RenderPack  rp,
IAxes  axes,
ConnectStyle  connectStyle 
)
inline

◆ GetRangeY()

CoordinateRange ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.GetRangeY ( int  index1,
int  index2 
)
inline

Return the vertical range covered by data between the given indices (inclusive)

Property Documentation

◆ Count

Number of values in the data source.

Implements ScottPlot.ISignalXYSource.

◆ MaximumIndex

int ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.MaximumIndex
getset

Do not display data above this index.

Implements ScottPlot.ISignalXYSource.

◆ MinimumIndex

int ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.MinimumIndex = 0
getset

Do not display data below this index.

Implements ScottPlot.ISignalXYSource.

◆ Rotated

bool ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.Rotated = false
getset

If enabled, Xs will be vertical and Ys will be horizontal.

Implements ScottPlot.ISignalXYSource.

◆ UsePixelOverlap

bool ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.UsePixelOverlap = false
get

◆ XOffset

double ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.XOffset = 0
getset

X position of the first data point.

Implements ScottPlot.ISignalXYSource.

◆ Xs

◆ XScale

double ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.XScale = 1
getset

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

Implements ScottPlot.ISignalXYSource.

◆ YOffset

double ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.YOffset = 0
getset

Shift Y position of all values by this amount.

Implements ScottPlot.ISignalXYSource.

◆ Ys

◆ YScale

double ScottPlot.DataSources.SignalXYSourceGenericArray< TX, TY >.YScale = 1
getset

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

Implements ScottPlot.ISignalXYSource.


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