Click or drag to resize

FreeformPointLineSeries Class

LightningChart .NET Help
Freeform point line series. You can define the line and points style. Add points with AddPoints method.
Inheritance Hierarchy

Namespace:  Arction.WinForms.Charting.SeriesXY
Assembly:  Arction.WinForms.Charting.LightningChart (in Arction.WinForms.Charting.LightningChart.dll) Version: 10.3.1
Syntax
[SerializableAttribute]
public class FreeformPointLineSeries : PointLineSeriesBase

The FreeformPointLineSeries type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAllowUserInteraction
Allow series reacting to user interaction device movement. Device hit testing with objects cause CPU overhead when the device is moved. If user interaction is not absolute necessary directly within chart and if you want to maximize the performance, set this false.
(Inherited from SeriesBaseXY.)
Public propertyAssignableXAxes
List of assignable X axes
(Inherited from SeriesBaseXY.)
Public propertyAssignableYAxes
List of assignable Y axes
(Inherited from SeriesBaseXY.)
Public propertyAssignXAxisIndex
Index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis.
(Inherited from SeriesBaseXY.)
Public propertyAssignYAxisIndex
Index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis.
(Inherited from SeriesBaseXY.)
Public propertyDataBreaking
Data breaking options. Defines, if gaps are enabled on series data and by which value. Default state is disabled and default gap value is Double.NaN;
(Inherited from PointLineSeriesBase.)
Public propertyDisableDragToAnotherAxis
Disable dragging from Y axis to another Y axis or from chart to another chart. Set this true if you want to zoom in the series area, and keep other user interactive device interactivity features available.
(Inherited from SeriesBaseXY.)
Public propertyErrorBars
Error bars.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code.
(Inherited from HighlightingItemBase.)
Public propertyIncludeInAutoFit
Include series values in automatic fit.
(Inherited from SeriesBaseXY.)
Public propertyIndividualPointColoring
Selects how to use the individual point colors. Sets which PointStyle color is replaced with PointColor.
Public propertyLegendBoxIndex
Legendbox index.
(Inherited from SeriesBaseXY.)
Public propertyLimitYToStackSegment
Limit Y draw range to segment area when y-axes are stacked.
(Inherited from SeriesBaseXY.)
Public propertyLineStyle
Line style
(Inherited from PointLineSeriesBase.)
Public propertyLineVisible
Is line visible or not
(Inherited from PointLineSeriesBase.)
Public propertyOldestPointIndex
Gets the index of oldest point in Points array. When PointCountLimitEnabled is true, the Points array is used as an circular point buffer. This is 0 always when PointCountLimitEnabled is false. To read Points, when OldestPointIndex is 0: Read from index 0 till PointCount-1. To read Points, when OldestPointIndex is > 0: First read from OldestPointIndex till PointCountLimit-1. Then read from index 0 till OldestPointIndex-1.
Public propertyOwnerView
Owner view.
(Inherited from SeriesBaseXY.)
Public propertyPointCount
Point count stored in the Points array
(Inherited from PointLineSeriesBase.)
Public propertyPointCountLimit
Point count limit. If you add points more than limited count, first points are automatically removed. The limiter only applies if PointCountLimitEnabled is true. If PointCountLimitEnabled is true, the array of corresponding size will be create in memory.
Public propertyPointCountLimitEnabled
Limit point count by dropping oldest points. The point count is limited to PointCountLimit.
Public propertyPoints
Series points
Public propertyPointsOptimization
Points rendering optimization
(Inherited from PointLineSeriesBase.)
Public propertyPointStyle
Point style
(Inherited from PointLineSeriesBase.)
Public propertyPointsType
Points type
Public propertyPointsVisible
Are points visible or not
(Inherited from PointLineSeriesBase.)
Public propertyPointsWithErrors
Series points with error tolerance indicators
Public propertySeriesEventMarkers
Series event markers
(Inherited from PointLineSeriesBase.)
Public propertyShowInLegendBox
Enlists the series title text in Legend box of the chart
(Inherited from SeriesBaseXY.)
Public propertyStatistics
Statistics of the series
(Inherited from PointLineSeriesBase.)
Public propertyTitle
Series title
(Inherited from PointLineSeriesBase.)
Public propertyUsePalette
Use palette for line coloring.
(Inherited from PointLineSeriesBase.)
Public propertyValueRangePalette
Color palette for Y value range.
(Inherited from PointLineSeriesBase.)
Public propertyVisible
Is the series visible
(Inherited from SeriesBaseXY.)
Top
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
Events
  NameDescription
Public eventBeforeSeriesRendering
Occurs just before the rendering of the series takes place.
(Inherited from SeriesBaseXY.)
Public eventCustomLinePointColoringAndShaping
Custom line coloring and line coordinates event. Event handler must give color for each data point received in the handler. The coordinates can be adjusted as well and new line points can be inserted.
(Inherited from PointLineSeriesBase.)
Public eventHighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase.)
Public eventMouseClick
Mouse button has been clicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDoubleClick
Mouse button has been doubleclicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDown
Mouse button has been pressed down.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOff
Mouse has been moved outside of object.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOn
Mouse has been moved over object.
(Inherited from UserInteractiveObject.)
Public eventMouseUp
Mouse button has been released.
(Inherited from UserInteractiveObject.)
Top
Fields
  NameDescription
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Top
See Also