Click or drag to resize

SampleDataSeries Class

LightningChart .NET Help
Sample data series class.
Inheritance Hierarchy

Namespace: LightningChartLib.UWP.ChartingMVVM.SeriesXY
Assembly: LightningChart.UWP.ChartingMVVM (in LightningChart.UWP.ChartingMVVM.dll) Version: 11.0.1
XMLNS for XAML: Not mapped to an xmlns.
Syntax
Copy
[SerializableAttribute]
public class SampleDataSeries : ProgressiveSingleLineSeriesBase, 
	ITrackable, ILevelTriggable, IRealtimeShiftable

The SampleDataSeries type exposes the following members.

Constructors
 NameDescription
Public methodSampleDataSeries Constructor for Form designer list editor.
Public methodSampleDataSeries(ViewXY, AxisX, AxisY) Constructor
Top
Properties
 NameDescription
Public propertyAllowUserInteraction Gets or sets if user interaction is allowed. This is a dependency property.
(Inherited from SeriesBaseXY)
Public propertyAssignXAxisIndex Gets or sets index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis. This is a dependency property.
(Inherited from SeriesBaseXY)
Public propertyAssignYAxisIndex Gets or sets index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis. This is a dependency property.
(Inherited from SeriesBaseXY)
Public propertyCursorTrackEnabled Cursor tracking enabled.
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 Gets or sets if disable dragging from Y axis to another Y axis or from chart to another chart. This is a dependency property. 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 propertyFirstSampleTimeStamp Gets or sets first sample time stamp, usually 1/SamplingFrequency. This is a dependency property.
Public propertyHighlight Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property.
(Inherited from HighlightingItemBase)
Public propertyIncludeInAutoFit Gets or sets if includes series values in automatic fit. This is a dependency property.
(Inherited from SeriesBaseXY)
Public propertyLegendBoxIndex Gets or sets legendbox index. This is a dependency property.
(Inherited from SeriesBaseXY)
Public propertyLimitYToStackSegment Gets or sets if limit Y draw range to segment area when y-axes are stacked. This is a dependency property.
(Inherited from SeriesBaseXY)
Public propertyLineStyle Gets or sets line style. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyLineVisible Gets or sets if line is visible or not. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyPointCount Gets point count stored in the Points array. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyPointsOptimization Gets or sets points rendering optimization. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyPointStyle Gets or sets point style. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyPointsVisible Gets or sets are points visible or not. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertySampleFormat Gets or sets sample format. This is a dependency property.
Public propertySamplesDouble Gets or sets series samples, Double format. This is a dependency property.
Public propertySamplesSingle Gets or sets series samples, Single format. This is a dependency property.
Public propertySamplingFrequency Gets or sets sampling frequency, in Hz. (sample interval is 1/SamplingFrequency). This is a dependency property.
Public propertyScrollingStabilizing Gets or sets if stabilize scrolling mode by rounding shifting to nearest integer pixel position. This is a dependency property. Reduces wobbling of the scrolling waveform, but may show as slight X-dimensional distortion.
Remarks
Only applies when XAxis ScrollMode = Scrolling
Public propertyScrollModePointsKeepLevel Tells how often the draw data is cleared when using X axis scroll mode. Valid range is 1...100 1 frees the draw data and the reconstructs the draw data after every 1/10 scroll page. Use this when there's not much memory available. 100 frees the draw data and the reconstructs the draw data after every 100/10 = 10 pages. Use this when smooth scroll with high FPS is important. Reserves some extra memory.
Public propertySeriesEventMarkers Gets or sets series event markers. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyShowInLegendBox Gets or sets if enlists the series title text in Legend box of the chart. This is a dependency property.
(Inherited from SeriesBaseXY)
Public propertyStatistics Gets statistics of the series. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyTitle Gets or sets series title. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyUsePalette Gets or sets if use palette for line coloring. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyValueRangePalette Gets or sets color palette for Y value range. This is a dependency property.
(Inherited from PointLineSeriesBase)
Public propertyVisible Gets or sets series visible state. This is a dependency property.
(Inherited from SeriesBaseXY)
Top
Methods
 NameDescription
Public methodAddOffsetToSamples Adds offset to all samples (Increments all samples by given value).
Public methodAddSamples(Double, Boolean) Add samples to end of series, double format.
Public methodAddSamples(Single, Boolean) Add samples to end of series, float format.
Public methodClear Clear all samples.
(Overrides PointLineSeriesBaseClear)
Public methodDeleteSamplesBeforeX Delete samples having smaller X value than given value.
Public methodDispose Release all resources used by this instance.
(Inherited from ChartNode)
Public methodGetClipAreas Get clipping areas.
(Inherited from SeriesBaseXY)
Public methodGetMinMaxFromXRange Get minimum and maximum Y value withing given X range.
(Overrides PointLineSeriesBaseGetMinMaxFromXRange(Double, Double, Double, Double, Boolean))
Public methodGetMinMaxFromXRangeIgnoreValue This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. Get minimum and maximum Y value within given X range, but Ignore some values (gap defining value).
(Overrides PointLineSeriesBaseGetMinMaxFromXRangeIgnoreValue(Double, Double, Double, Double, Double))
Public methodGetXMinMax Get minimum X and maximum X of series X values.
(Overrides PointLineSeriesBaseGetXMinMax(Double, Double))
Public methodInvalidateData Series data has been modified directly by it's array. Use this method to notify chart that this series needs a refresh
(Inherited from SeriesBaseXY)
Public methodIsHighlighted returns true if the object is highlighted.
(Inherited from HighlightingItemBase)
Public methodIsPositionOver Is position over series
(Inherited from PointLineSeriesBase)
Public methodLoadFromCSVAsync Loads series data from a CSV file.
(Overrides SeriesBaseXYLoadFromCSVAsync(StorageFile, SeparatorCSV))
Public methodMultiplySamples Multiplies the samples in the samples array with given factor.
Public methodRemoveHighlight Removes forced highlighting.
(Inherited from HighlightingItemBase)
Public methodSaveToCSVAsync Saves sample data into CSV file.
(Overrides SeriesBaseXYSaveToCSVAsync(StorageFile, SeparatorCSV))
Public methodSeekTriggerPos Detect triggering position from series data.
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 methodSolveNearestSampleByCoord Solve nearest sample to given X and Y screen coordinate [in DIPs].
Public methodSolveNearestSampleByValue Solve nearest sample to given X and Y value.
Public methodSolveYCoordAtXCoord Find nearest series point of given X-coordinate and get corresponding Y-coordinate.
(Inherited from ProgressiveSingleLineSeriesBase)
Public methodSolveYValueAtXValue Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values.
(Overrides ProgressiveSingleLineSeriesBaseSolveYValueAtXValue(Double))
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 eventDoubleTapped Item has been doubletapped.
(Inherited from UserInteractiveObject)
Public eventHighlightedStateChanged Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase)
Public eventOldDataDropped Occurs when old data samples have been dropped.
Public eventPointerEntered Pointer has been moved over object.
(Inherited from UserInteractiveObject)
Public eventPointerExited Pointer has been moved outside of object.
(Inherited from UserInteractiveObject)
Public eventPointerPressed Pointer has been pressed down.
(Inherited from UserInteractiveObject)
Public eventPointerReleased Pointer has been released.
(Inherited from UserInteractiveObject)
Public eventTapped Item has been tapped.
(Inherited from UserInteractiveObject)
Public eventValueChangedInternallyEvent Value has changed internally by chart or by user manipulation of chart object.
(Inherited from ChartNode)
Top
Fields
 NameDescription
Public fieldStatic memberFirstSampleTimeStampProperty Identifies the FirstSampleTimeStamp dependency property.
Public fieldStatic memberSampleFormatProperty Identifies the SampleFormat dependency property.
Public fieldStatic memberSamplesDoubleProperty Identifies the SamplesDouble dependency property.
Public fieldStatic memberSamplesSingleProperty Identifies the SamplesSingle dependency property.
Public fieldStatic memberSamplingFrequencyProperty Identifies the SamplingFrequency dependency property.
Public fieldStatic memberScrollingStabilizingProperty Identifies the ScrollingStabilizing dependency property.
Public fieldTag Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt)
Top
See Also