Internal interface used for Utility Functions within DataSourceUtilities More...
Public Member Functions | |
| int | GetXClosestIndex (Coordinates mouseLocation) |
| Gets the closest index to a specified coordinate for the array of X's. | |
| Coordinates | GetCoordinate (int index) |
| Gets the X-Y coordinate from the data source at the specified index. | |
| Coordinates | GetCoordinateScaled (int index) |
| Gets the X-Y coordinate from the data source at the specified index with any offsets and scaling applied. | |
| double | GetX (int index) |
| Gets the X value from the data source at the specified index. | |
| double | GetXScaled (int index) |
| Gets the X value from the data source at the specified index with any offsets and scaling applied. | |
| double | GetY (int index) |
| Gets the Y value from the data source at the specified index. | |
| double | GetYScaled (int index) |
| Gets the Y value from the data source at the specified index with any offsets and scaling applied. | |
| bool | IsSorted () |
| When the collection is sorted, this will enable much quicker execution by allowing usage of BinarySearch methods ( GetNearest should call GetXClosestIndex when this is true ) | |
Properties | |
| bool | PreferCoordinates [get] |
| When set true, DataSourceUtilities should prefer paths that utilize GetCoordinates | |
| int | Length [get] |
| The length of the collection. | |
| int | MinRenderIndex [get] |
| int | MaxRenderIndex [get] |
Detailed Description
Internal interface used for Utility Functions within DataSourceUtilities
Member Function Documentation
◆ GetCoordinate()
| Coordinates ScottPlot.IDataSource.GetCoordinate | ( | int | index | ) |
Gets the X-Y coordinate from the data source at the specified index.
◆ GetCoordinateScaled()
| Coordinates ScottPlot.IDataSource.GetCoordinateScaled | ( | int | index | ) |
Gets the X-Y coordinate from the data source at the specified index with any offsets and scaling applied.
◆ GetX()
| double ScottPlot.IDataSource.GetX | ( | int | index | ) |
Gets the X value from the data source at the specified index.
◆ GetXClosestIndex()
| int ScottPlot.IDataSource.GetXClosestIndex | ( | Coordinates | mouseLocation | ) |
Gets the closest index to a specified coordinate for the array of X's.
- Parameters
-
mouseLocation typically the X coordinate should be used, unless the plot is rotated (then use Y)
Fastest execution should be using a BinarySearch, such as DataSourceUtilities.GetClosestIndex(double[], double, IndexRange)
◆ GetXScaled()
| double ScottPlot.IDataSource.GetXScaled | ( | int | index | ) |
Gets the X value from the data source at the specified index with any offsets and scaling applied.
◆ GetY()
| double ScottPlot.IDataSource.GetY | ( | int | index | ) |
Gets the Y value from the data source at the specified index.
Implemented in ScottPlot.DataSources.FastSignalSourceDouble, ScottPlot.DataSources.SignalSourceDouble, ScottPlot.DataSources.SignalSourceGenericArray< T >, and ScottPlot.DataSources.SignalSourceGenericList< T >.
◆ GetYScaled()
| double ScottPlot.IDataSource.GetYScaled | ( | int | index | ) |
Gets the Y value from the data source at the specified index with any offsets and scaling applied.
◆ IsSorted()
| bool ScottPlot.IDataSource.IsSorted | ( | ) |
When the collection is sorted, this will enable much quicker execution by allowing usage of BinarySearch methods ( GetNearest should call GetXClosestIndex when this is true )
Property Documentation
◆ Length
|
get |
The length of the collection.
Implemented in ScottPlot.DataSources.FastSignalSourceDouble, ScottPlot.DataSources.SignalSourceDouble, ScottPlot.DataSources.SignalSourceGenericArray< T >, and ScottPlot.DataSources.SignalSourceGenericList< T >.
◆ MaxRenderIndex
|
get |
◆ MinRenderIndex
|
get |
◆ PreferCoordinates
|
get |
When set true, DataSourceUtilities should prefer paths that utilize GetCoordinates
The documentation for this interface was generated from the following file:
- ScottPlot/src/ScottPlot5/ScottPlot5/Interfaces/IDataSource.cs
