Creates an instance of OhlcDataSeries
the SciChart WebAssembly Context containing native methods and access to our underlying WebGL2 rendering engine
the IOhlcDataSeriesOptions which can be passed to configure the DataSeries at construct time
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
High vector with final animation values
High vector with initial animation values
A unique Id for the IDataSeries
Low vector with final animation values
Low vector with initial animation values
Open vector with final animation values
Open vector with initial animation values
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 (Date), Open, High, Low, Close point to the DataSeries
X-value is a Date, encoded as a Unix Timestamp.
The Open value for this OHLC bar
The High value for this OHLC bar
The Low value for this OHLC bar
The Close value for this OHLC bar
The point metadata
Appends arrays of X (Date), Open, High, Low, Close point to the DataSeries
X-values are Dates, encoded as a Unix Timestamp.
The Open values for this OHLC bar
The High values for this OHLC bar
The Low values for this OHLC bar
The Close value sfor this OHLC bar
The array of point metadata
Clears the entire 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 Close-values in the DataSeries
Gets a native / WebAssembly vector of High-values in the DataSeries
Gets a native / WebAssembly Vector of Indexes in the DataSeries
Gets a native / WebAssembly vector of Low-values in the DataSeries
Gets a native / WebAssembly vector of Open-values in the DataSeries
Get the value from a native vector , potentially accounting for fifo sweeping.
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
Inserts a single Date, Open, High, Low, Close value at the X-index
the index to insert at
the X-value (date) encoded as a Unix Timestamp
The Open value
The High value
The Low value
The Close value
The point metadata
Inserts a range of Date, Open, High, Low, Close value at the X-index
the index to insert at
the X-values (dates) encoded as a Unix Timestamp
The Open values
The High values
The Low values
The Close values
The array of point metadata
Call to notify subscribers of dataChanged that the data has changed and SciChartSurface needs redrawing
Removes a Date,Open,High,Low,Close value at the specified index
the index to remove at
Removes a range of Date,Open,High,Low,Close values at the specified index
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 a function that will be used to generate metadata for values when they are appended/inserted, if no explicit metadata is supplied.
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 Open, High, Low, Close value by X-index
the index to update
The new Open value
The new High value
The new Low value
The new Close value
The point metadata
Updates a single X, Open, High, Low, Close value by X-index. Might also need to set isSorted = false
the index to update
The new X value
The new Open value
The new High value
The new Low value
The new Close value
The point metadata
Generated using TypeDoc
OhlcDataSeries is a DataSeries for holding Open, High, Low, Close data in SciChart's JavaScript Stock Charts
The OhlcDataSeries is primarily used with the JavaScript Candlestick Chart but can also be used with our JavaScript Ohlc Chart, used for drawing JavaScript Stock Charts and Candlestick or OHLC charts.
A 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.