SampleDataBlockSeries Class

LightningChart .NET Help

Block sample data series class. Can be only used with Linear axis and DirectX11 engine.

Inheritance Hierarchy

SystemObject
  Arction.WinForms.ChartingChartNode
    Arction.WinForms.ChartingUserInteractiveObjectInt
      Arction.WinForms.ChartingUserInteractiveObject
        Arction.WinForms.ChartingHighlightingItemBase
          Arction.WinForms.Charting.SeriesXYSeriesBaseXY
            Arction.WinForms.Charting.SeriesXYBlockSeriesBase
              Arction.WinForms.Charting.SeriesXYBlockSeriesBaseSingle
                Arction.WinForms.Charting.SeriesXYSampleDataBlockSeries

Namespace: Arction.WinForms.Charting.SeriesXY
Assembly: Arction.WinForms.Charting.LightningChart (in Arction.WinForms.Charting.LightningChart.dll) Version: 10.3.1

Syntax

C++

Copy

[SerializableAttribute]
public class SampleDataBlockSeries : BlockSeriesBase<float[]>, 
	ILevelTriggable, ISingleLineSeriesSolveResultReturningSeries, IRealtimeShiftable, ITrackable

<SerializableAttribute>
Public Class SampleDataBlockSeries
	Inherits BlockSeriesBase(Of Single())
	Implements ILevelTriggable, ISingleLineSeriesSolveResultReturningSeries, IRealtimeShiftable, ITrackable

[SerializableAttribute]
public ref class SampleDataBlockSeries : public BlockSeriesBase<array<float>^>, 
	ILevelTriggable, ISingleLineSeriesSolveResultReturningSeries, IRealtimeShiftable, ITrackable

The SampleDataBlockSeries type exposes the following members.

Constructors

	Name	Description
	SampleDataBlockSeries	Constructor.
	SampleDataBlockSeries(ViewXY, AxisX, AxisY)	Constructor.

Top

Properties

	Name	Description
	AllowUserInteraction	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.)
	AssignableXAxes	List of assignable X axes (Inherited from SeriesBaseXY.)
	AssignableYAxes	List of assignable Y axes (Inherited from SeriesBaseXY.)
	AssignXAxisIndex	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.)
	AssignYAxisIndex	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.)
	Color	Gets and sets line color. (Inherited from BlockSeriesBase.)
	DisableDragToAnotherAxis	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.)
	FirstSampleTimeStamp	First sample time stamp, usually 1/SamplingFrequency.
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. (Inherited from HighlightingItemBase.)
	IncludeInAutoFit	Include series values in automatic fit. (Inherited from SeriesBaseXY.)
	Item	Get point at index.
	LegendBoxIndex	Legendbox index. (Inherited from SeriesBaseXY.)
	LimitYToStackSegment	Line rendering limit on y-axis.
	OffsetY	Offset y value. This is added to each data value when rendering. (Inherited from BlockSeriesBase.)
	OwnerView	Owner view. (Inherited from SeriesBaseXY.)
	PointCount	Added sample count.
	Samples	Series samples.
	SamplingFrequency	Sampling frequency, in Hz. (sample interval is 1/SamplingFrequency).
	ScrollModePointsKeepLevel	Tells how often the source data is cleared when using X axis scroll mode. Valid range is 1...100. 1 frees the source data after every 1/10 scroll page. Use this when there's not much memory available. 100 frees the source data after every 100/10 = 10 pages. One need to set to true to enable this functionality. (Inherited from BlockSeriesBase.)
	SeriesEventMarkers	Series event markers. (Inherited from BlockSeriesBase.)
	ShowInLegendBox	Enlists the series title text in Legend box of the chart (Inherited from SeriesBaseXY.)
	Title	Series title (Inherited from BlockSeriesBase.)
	Width	Gets and sets width of line. (Inherited from BlockSeriesBase.)
	Visible	Is the series visible (Inherited from SeriesBaseXY.)

Top

Methods

	Name	Description
	ActualPointCount	Actual point count in series. (Inherited from BlockSeriesBaseBLOCKDATATYPE.)
	AddSamples	Add samples to end of series, float format.
	Clear	Clear all data. (Inherited from BlockSeriesBase.)
	DeleteSamplesBeforeX	Delete samples having smaller X value than given value.
	Dispose	Release all resources used by this instance. (Inherited from ChartNode.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetClipAreas	Get clipping areas. (Inherited from SeriesBaseXY.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMinMaxFromXRange	Get minimum and maximum Y value withing given X range. (Overrides BlockSeriesBaseGetMinMaxFromXRange(Double, Double, Double, Double, Boolean).)
	GetMinMaxFromXRangeIgnoreValue	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).
	GetSampleAtIndex	Get sample at index.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetXMinMax	Get minimum X and maximum X of series X values. (Overrides BlockSeriesBaseGetXMinMax(Double, Double).)
	InvalidateData	Series data has been modified directly by it's array. Use this method to notify chart that this series needs a refresh. (Inherited from BlockSeriesBase.)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase.)
	IsPositionOver	Is position over series. (Inherited from BlockSeriesBase.)
	LoadFromCSV	Loads series data from a CSV file. (Overrides SeriesBaseXYLoadFromCSV(String, SeparatorCSV).)
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase.)
	SaveToCSV	Saves sample data into CSV file. (Overrides SeriesBaseXYSaveToCSV(String, SeparatorCSV).)
	SeekTriggerPos	Detect triggering position from series data.
	SetClipAreas	Set clipping areas. Give null to disable all clip areas. (Inherited from SeriesBaseXY.)
	SetHighlight	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.)
	SetProperCursor	Set proper drag cursor. Default is hand. (Inherited from UserInteractiveObject.)
	SolveNearestSampleByCoord	Solve nearest sample to given X and Y screen coordinate. (Inherited from BlockSeriesBase.)
	SolveNearestSampleByValue	Solve nearest sample to given X and Y value. (Overrides BlockSeriesBaseSolveNearestSampleByValue(Double, Double, Double, Double, Int32).)
	SolveYCoordAtXCoord	Find nearest series point of given X-coordinate and get corresponding Y-coordinate.
	SolveYValueAtXValue	Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values. (Overrides BlockSeriesBaseSolveYValueAtXValue(Double).)
	ToString	Item to string. (Inherited from SeriesBaseXY.)

Top

Events

	Name	Description
	BeforeSeriesRendering	Occurs just before the rendering of the series takes place. (Inherited from SeriesBaseXY.)
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase.)
	MouseClick	Mouse button has been clicked. (Inherited from UserInteractiveObject.)
	MouseDoubleClick	Mouse button has been doubleclicked. (Inherited from UserInteractiveObject.)
	MouseDown	Mouse button has been pressed down. (Inherited from UserInteractiveObject.)
	MouseOverOff	Mouse has been moved outside of object. (Inherited from UserInteractiveObject.)
	MouseOverOn	Mouse has been moved over object. (Inherited from UserInteractiveObject.)
	MouseUp	Mouse button has been released. (Inherited from UserInteractiveObject.)
	OldDataDropped	Occurs when old data samples have been dropped.

Top

Fields

	Name	Description
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt.)

Top

Reference

Arction.WinForms.Charting.SeriesXY Namespace