Creates an instance of XyDataSeries
the SciChart WebAssembly Context containing native methods and access to our underlying WebGL2 WebAssembly rendering engine
the IXyDataSeriesOptions which can be passed to configure the DataSeries at construct time
The number of y values arrays in this DataSeries
An EventHandler which is raised when the data changes.
Gets the IDataDistributionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm
If set, these will be included in the serialised definition, so that it can be used with sharedData
A unique Id for the IDataSeries
Gets the EDataSeriesType type of the DataSeries
The SciChart WebAssembly Context containing native methods and access to our WebGL2 Engine
X vector with final animation values
X vector with initial animation values
Y vector with final animation values
Y vector with initial animation values
Gets or sets the capacity of data-points in the DataSeries
Gets or sets the capacity of data-points in the DataSeries
Gets the change count for this data series. Allows to indentify when data series was changed
Gets or sets whether the Y data contains NaN values. Set containsNaN = false for the performance optimization when the series has no NaNs
Gets or sets whether the Y data contains NaN values. Set containsNaN = false for the performance optimization when the series has no NaNs
Gets the DataSeries name. This is used in legend controls and tooltips to identify the series
Gets the DataSeries name. This is used in legend controls and tooltips to identify the series
Gets the maximum size of the dataSeries in FIFO (First In First Out) mode. This can only be set in the constructor options. If set, the dataSeries supports only append, appendRange, update and clear. Any data that is appended once the dataSeries has reached fifoCapacity will cause the oldest data to be discarded. This is a much more efficient than appending and removing for achieving scrolling data. Spline series and Stacked series currently do not support fifo mode. To get the scrolling effect, you need to consider the behaviour of your X Axis. You can either Use a CategoryAxis Use a NumericAxis with increasing x values, and update the visibleRange (or use zoomExtents)
Internal only - Get the starting offset when in fifo mode
If true, data in fifo mode will not be "unwrapped" before drawing, giving ecg style sweeping mode. To get the sweeping effect, you need to consider the behaviour of your X Axis. You can either Use a CategoryAxis Use a NumericAxis and make your x values an offset from the first value, eg by doing x % fifoCapcity
If true, data in fifo mode will not be "unwrapped" before drawing, giving ecg style sweeping mode. To get the sweeping effect, you need to consider the behaviour of your X Axis. You can either Use a CategoryAxis Use a NumericAxis and make your x values an offset from the first value, eg by doing x % fifoCapcity
In fifo sweeping mode, the number of earliest points to skip to create a gap between the latest and earliest data
In fifo sweeping mode, the number of earliest points to skip to create a gap between the latest and earliest data
Check if the series has an existing metadata
When true, the DataSeries has values, else it is empty
Gets or sets whether the X-values are evenly spaced or not. See remarks at IDataSeries.isEvenlySpaced for further information
Gets or sets whether the X-values are evenly spaced or not. See remarks at IDataSeries.isEvenlySpaced for further information
Gets or sets whether the X-values are sorted ascending or not. See remarks at IDataSeries.isSorted for further information
Gets or sets whether the X-values are sorted ascending or not. See remarks at IDataSeries.isSorted for further information
Gets the range in the X-direction for this DataSeries
Appends a single X, Y point to the DataSeries
The X-value
The Y-value
The point metadata
Appends a range of X, yValuesArray points to the DataSeries
The X-values defined as 64bit float numbers contained within an ArrayBuffer
An array of Y-value arrays defined as 64bit float numbers contained within an ArrayBuffer
The array of point metadata
Appends a single X, ...YArray, point to the DataSeries
The X-value
An array of the y values
The point metadata
Appends a range of X, Y points to the DataSeries
The X-values
The Y-values
The array of point metadata
Appends a range of X, yValuesArray points to the DataSeries
The X-values
An array of Y-value arrays
The array of point metadata
Clear all values from the DataSeries
Gets the count of data-points in the DataSeries
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Finds the nearest index of the xValue passed in by performing binary or linear search on the X-Values array. Returns -1 for index not found. Other negative numbers indicate an error condition
the X-value to find
The index, or -1 if not found
Gets the integer indices of the XValues array that are currently in the VisibleRange passed in, and an undefined range otherwise.
The VisibleRange to get the indices range
If True the renderable series uses CategoryAxis
Specifies the search mode used to look for the index of visibleRange.Min
Specifies the search mode used to look for the index of visibleRange.Max
numberRange The indices to the X-Data that are currently in range.
Returns true if this DataSeries has been deleted and native memory destroyed
Gets the metadata by index
The X index
Gets the metadata array length
Gets a native / WebAssembly Vector of Indexes in the DataSeries
Gets a native / WebAssembly vector of X-values in the DataSeries
Gets a native / WebAssembly vector of Y-values in the DataSeries
Gets the Y-range of the data within the specified X-Range: a 'windowed' Y-range used for zooming into series on the SciChartSurface
When true, return the positive part of the Y-range only
When true, treat the XAxis as a CategoryAxis - an axis type which measures by x-index not x-value
The data series values to use EDataSeriesValueType
Gets the range in the X-direction for this DataSeries
The data series values to use EDataSeriesValueType
Check if the series has an existing metadataGenerator
the index to insert at
the X value
the Y value
The point metadata
the index to insert at
the X value
the Y values
The point metadata
the index to insert at
the XValues
the YValues
The array of point metadata
the index to insert at
the XValues
The array of point metadata
Get if a named yValues array should be included when calculating yRange
Call to notify subscribers of dataChanged that the data has changed and SciChartSurface needs redrawing
Removes an X, and all associated y values at the specified index
the index to remove at
the start index to remove at
the number of points to remove
Puts the animation values back into the dataSeries after a reverse animation
The BaseDataSeries to be used for target values
Sets final values for the data animation
The BaseDataSeries to be used for final values
Sets initial values for the data animation
The BaseDataSeries to be used for initial values
Sets a function that will be used to generate metadata for values when they are appended/inserted, if no explicit metadata is supplied.
Set if a named yValues array should be included when calculating yRange
Usually an EValueName
Convert the object to a definition that can be serialized to JSON, or used directly with the builder api
if set true, data values will not be included in the json.
Updates a single Y-value by X-index
the index to update
The new Y value
The point metadata
Updates the BaseDataSeries values for the animation
The animation progress from 0 to 1
The animation
Updates a single set of y values by X-index
the index to update
The new Y values
The point metadata
Updates a single X, Y-value by X-index. Might also need to set isSorted = false
The index to update
The new X value
The new Y value
The point metadata
Updates a single X, and set of Y-values by X-index. Might also need to set isSorted = false
The index to update
The new X value
The new Y values
The point metadata
Validates the length of the animation vectors
Generated using TypeDoc
XyDataSeries is a DataSeries for holding X, Y data in SciChart's 2D JavaScript Charts
The XyDataSeries is primarily used with our JavaScript Line Chart, but can also be used by the JavaScript Scatter Chart or JavaScript Mountain/Area Chart and JavaScript Column Chart.
To instantiate an XyDataSeries, use the following code:
const xyDataSeries = new XyDataSeries(wasmContext); xyDataSeries.append(1, 2); // Append a single x,y point xyDataSeries.appendRange([3, 4], [3, 4]); // Append multiple x,y points (faster) xyDataSeries.insert(0, 9, 10); // Insert a point at index 0 xyDataSeries.update(0, 11, 12); // Update a point at index 0 xyDataSeries.removeAt(0); // Remove a point at index 0 xyDataSeries.clear(); // Clear the dataseries xyDataSeries.delete(); // Delete the dataseries and native (WebAssembly) memoryA DataSeries stores the data to render. This is independent from the RenderableSeries which defines how that data should be rendered.
See derived types of BaseDataSeries to find out what data-series are available. See derived types of IRenderableSeries to find out what 2D JavaScript Chart types are available.
📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/data-series-api/data-series-api-overview/