Click or drag to resize

FreeformPointLineSeries Methods

LightningChart .NET Help

The FreeformPointLineSeries type exposes the following members.

Methods
  NameDescription
Public methodAddPoints(SeriesErrorPoint, Boolean)
Add points with error tolerance to end of series.
Public methodAddPoints(SeriesPoint, Boolean)
Add points to end of series.
Public methodAddPoints(Double, Double, Boolean)
Add points to end of series.
Public methodClear
Clear all points
(Overrides PointLineSeriesBaseClear.)
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetClipAreas
Get clipping areas.
(Inherited from SeriesBaseXY.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLastPoint
Gets last (newest) point.
Public methodGetMinMaxFromXRange
Get min and max Y value within given X range.
(Overrides PointLineSeriesBaseGetMinMaxFromXRange(Double, Double, Double, Double, Boolean).)
Public methodGetMinMaxFromXRangeIgnoreValue
This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. Get min and max Y value within given X range, but Ignore some values (gap defining value).
(Overrides PointLineSeriesBaseGetMinMaxFromXRangeIgnoreValue(Double, Double, Double, Double, Double).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetXMinMax
Get minimum X and maximum X of series X values.
(Overrides PointLineSeriesBaseGetXMinMax(Double, Double).)
Public methodGetXValues
Get X values array.
Public methodGetYValues
Get Y values array.
Public methodInvalidateData
Invalidate data array. Statistics and draw data are recalculated.
(Overrides SeriesBaseXYInvalidateData.)
Public methodIsHighlighted
returns true if the object is highlighted.
(Inherited from HighlightingItemBase.)
Public methodIsPositionOver
Is position over series
(Inherited from PointLineSeriesBase.)
Public methodLoadFromCSV
Loads series data from a CSV file. Note that this loads points according to value. So if you need to load both, change PointsType accordingly between two calls to this method.
(Overrides SeriesBaseXYLoadFromCSV(String, SeparatorCSV).)
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodSaveToCSV
Saves series data into CSV file. Note that this save points according to value. So if you need to save both, change PointsType accordingly between two calls to this method.
(Overrides SeriesBaseXYSaveToCSV(String, SeparatorCSV).)
Public methodSetClipAreas
Set clipping areas. Give null to disable all clip areas.
(Inherited from SeriesBaseXY.)
Public methodSetHighlight
Highlights the object.

This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set.

(Inherited from HighlightingItemBase.)
Public methodSetProperCursor
Set proper drag cursor. Default is hand.
(Inherited from PointLineSeriesBase.)
Public methodSetXValue
Set X value of Points array item.
Public methodSetYValue
Set Y value of Points array item.
Public methodSolveNearestDataPointByCoord
Solve nearest data point to given X and Y screen coordinate [input in DIP].
Public methodSolveNearestDataPointByValue
Solve nearest data point to given X and Y value.
Public methodSolveYCoordsAtXCoord
Find all instances of FreeformPointLineSeries’ intersection with vertical line going through the given X-coordinate. The intersection point is described by segment of line (pair of LineSeries’ points) it is found. Each intersection point is returned as LineSeriesCoordinateSolveResult structure, and method returns the list of those structures.

Note that you might be interested in using SolveNearestDataPointByCoord(Int32, Int32, Double, Double, Int32) for some of the use cases.

X-coordinate in pixels or DIP.Use DIP instead of pixels as parameters.

Return Value

Type: 
Iterable list of solve results.
Public methodSolveYValuesAtXValue
Find all instances of FreeformPointLineSeries’ intersection with vertical line going through the given X-value. The intersection point is described by segment of line (pair of LineSeries’ points) it is found. Each intersection point is returned as LineSeriesValueSolveResult structure, and method returns the list of those structures.

Note that you might be interested in using SolveNearestDataPointByValue(Double, Double, Double, Double, Int32) for some of the use cases.

X-value.

Return Value

Type: 
Iterable list of solve results.
Public methodToString
Item to string.
(Inherited from SeriesBaseXY.)
Top
See Also