Creates an instance of the FastRectangleRenderableSeries
The SciChart WebAssembly Context containing native methods and access to our WebGL2 WebAssembly Drawing Engine
optional parameters of type IFastRectangleRenderableSeriesOptions applied when constructing the series type
📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/fast-rectangle-renderable-series/
Gets the current IHitTestProvider, used to call methods IHitTestProvider.hitTest, IHitTestProvider.hitTestXSlice and IHitTestProvider.hitTestDataPoint and provide info about the series data-points at mouse or touch locations
A hovered EventHandler. This event fires whenever the Series is hovered or unhovered by a mouse or pointer.
A unique Id for the IRenderableSeries
A callback which tells the parent SciChartSurface that it must be redrawn, e.g. when a property changes
Returns true if the series is a collection of other series.
Returns true if the series can be used on a polar surface
Returns true if the series is a stacked series or not
An isVisible changed EventHandler. This event fires whenever the Series isVisible changes.
Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips
Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips Is being used for Y1 tooltips for FastBandRenderableSeries
A selected EventHandler. This event fires whenever the Series is selected or deselected.
Returns the type of the series. See ESeriesType for a list of values
Sets a start up animation class, a child class for SeriesAnimation
Gets or sets the bottom corner radius, to give the rectangles bottom rounded corners. Default is 0
Gets or sets the bottom corner radius, to give the rectangles bottom rounded corners. Default is 0
If true, the drawing will be clipped to the visibleRange of the associated Y Axis. This is only really relevant if you are using Stacked Y Axes and do not want the series to be drawn outside that axis range
If true, the drawing will be clipped to the visibleRange of the associated Y Axis. This is only really relevant if you are using Stacked Y Axes and do not want the series to be drawn outside that axis range
Gets or Sets how the x values and optional x1 values are interpreted
Gets or Sets how the x values and optional x1 values are interpreted
Gets or Sets how the y values and optional y1 values are interpreted
Gets or Sets how the y values and optional y1 values are interpreted
Gets or sets options to use a custom texture brush
Gets or sets options to use a custom texture brush
Gets or sets the BaseDataLabelProvider used for creating and drawing per-point text
Gets or sets the BaseDataLabelProvider used for creating and drawing per-point text
Gets or Sets a value used to calculate the width of rectangles in X direction. By default the value is treated as data range, since rectangle series do not tend to be evenly spaced. To specify if the value should be treated as relative, absolute, or based on range use dataPointWidthMode Note that Absolute mode does not work well with autoRange due to circularity between the range calculation and the axis layout.
Gets or Sets a value used to calculate the width of rectangles in X direction. By default the value is treated as data range, since rectangle series do not tend to be evenly spaced. To specify if the value should be treated as relative, absolute, or based on range use dataPointWidthMode Note that Absolute mode does not work well with autoRange due to circularity between the range calculation and the axis layout.
Gets or sets the mode which determines how dataPointWidth in X direction is interpreted. Available values are EDataPointWidthMode. Default Range.
Gets or sets the mode which determines how dataPointWidth in X direction is interpreted. Available values are EDataPointWidthMode. Default Range.
The DataSeries which provides a datasource for this IRenderableSeries to draw
The DataSeries which provides a datasource for this IRenderableSeries to draw
Gets or Sets a common y1 value for all rectangles if y1Values are not provided. Default 0
Gets or Sets a common y1 value for all rectangles if y1Values are not provided. Default 0
How to treat NAN (Not a number) values in the input dataSeries. See ELineDrawMode for a list of values.
How to treat NAN (Not a number) values in the input dataSeries. See ELineDrawMode for a list of values.
Gets a list of Series Drawing Providers, which perform specific drawing operations in the series
Gets a list of Series Drawing Providers, which perform specific drawing operations in the series
Gets an optional ShaderEffect for modifying the render output of this IRenderableSeries
Sets an optional ShaderEffect for modifying the render output of this IRenderableSeries
Readonly. When true, resampling modes are enabled for faster drawing performance.
Gets or Sets fill property
Gets or Sets fill property
Gets or sets the fill as a gradient brush
Gets or sets the fill as a gradient brush
When true, if this series draws a line, the line will be a digital (step) line
When true, if this series draws a line, the line will be a digital (step) line
Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic
Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic
gets if the animation is currently running
gets if a data animation is currently running
Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic
Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic
Returns true if the series uses spline interpolation
When true, the series is visible and drawn
When true, the series is visible and drawn
An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.
An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.
An optional IPaletteProvider which is used to provide per data-point coloring or paletting.
An optional IPaletteProvider which is used to provide per data-point coloring or paletting.
The parent SciChartSurface that this RenderableSeries is attached to
The parent SciChartSurface that this RenderableSeries is attached to
A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only
A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only
Gets or sets the EResamplingMode used when drawing this series. Default value is Auto. To disable resampling for this series set mode = None. Also see resamplingPrecision which specifies the precision applied when resampling. To globally enable/disable resampling for debug purposes set SciChartDefaults.debugDisableResampling
Gets or sets the EResamplingMode used when drawing this series. Default value is Auto. To disable resampling for this series set mode = None. Also see resamplingPrecision which specifies the precision applied when resampling. To globally enable/disable resampling for debug purposes set SciChartDefaults.debugDisableResampling
Gets or sets the resampling precision for this series.
Default value is 0.0. Value of 1.0 means double precision: the resampler outputs 2x the number of points. Value of 2.0 means quadruple precision: the resampler outputs 4x the number of points.
If experiencing visual artefacts, try setting the precision to 1.0 or 2.0. This will come at a minor performance cost of around 20% for large datasets.
Gets or sets the resampling precision for this series.
Default value is 0.0. Value of 1.0 means double precision: the resampler outputs 2x the number of points. Value of 2.0 means quadruple precision: the resampler outputs 4x the number of points.
If experiencing visual artefacts, try setting the precision to 1.0 or 2.0. This will come at a minor performance cost of around 20% for large datasets.
Gets or sets series name
Gets or sets series name
A Stroke for lines, outlines and edges of this RenderableSeries
A Stroke for lines, outlines and edges of this RenderableSeries
The Stroke Thickness for lines, outlines and edges of this RenderableSeries
The Stroke Thickness for lines, outlines and edges of this RenderableSeries
Returns true if the series supports resampling
Gets or sets the top corner radius, to give the rectangles top rounded corners. Default is 0
Gets or sets the top corner radius, to give the rectangles top rounded corners. Default is 0
Gets the bound XAxis for this IRenderableSeries.
Gets the bound YAxis for this IRenderableSeries.
Determines whether the y range for this series should consider only the visible data (the default), or include the drawn points just outside the visible range
Determines whether the y range for this series should consider only the visible data (the default), or include the drawn points just outside the visible range
Replace this to do custom adjustments to the auto color for a particular property
Runs after the animation is complete
Runs before the animation starts
Checks is the point is out of the data range. For sorted data only. Is used to hide tooltips for RolloverModifier
The X value of the point
The Y value of the point
Is being called when the data for the underlying DataSeries changes
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Called when the BaseRenderableSeries must be drawn
The {@link WebGL2RenderingContext} with methods for drawing on the WebGL Canvas via our WebAssembly Rendering Engine
The RenderPassData containing data about the current rendering pass
Add the animation into the queue
Gets the RenderPassData instance used for this render pass
Returns the associated IDataSeries.dataSeriesName
Returns IDataSeries.count for the linked dataSeries
Returns the indices range of data points in xRange of the associated IDataSeries
The X-Axis Range currently in view
If True the renderable series uses CategoryAxis
Returns the IDataSeries.getNativeXValues for the associated dataSeries
Returns the IDataSeries.getNativeYValues for the associated dataSeries
The render layer grouping within which the series will be draw. Defaults to EDefaultRenderLayer.SeriesLayer (5)
Get a SeiesInfo object for this series based on the given hitTest
Gets the X-Range of the series. Override in derived classes to provide series specific implementations
Gets the Y-Range of the series for the current X-Range. Override in derived classes to provide series specific implementations
The AxisCore.visibleRange for the current bound XAxis
Whether the current bound XAxis is a Category axis
Returns true if the BaseRenderableSeries has a dataSeries
Returns true if the BaseRenderableSeries has a dataSeries and IDataSeries.hasValues is true
Returns true if the BaseRenderableSeries has an
Returns true if the BaseRenderableSeries has an IPointMarkerPaletteProvider
Returns true if the BaseRenderableSeries has an IStrokePaletteProvider
Links the item to axes
Used internally to check if resampling is needed for the renderable series
Is called for each render
Called when the BaseRenderableSeries is attached to a parent SciChartSurface
the SciChartSurface that this series has been attached to
Called when the BaseRenderableSeries is detached from a SciChartSurface
Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor
The TDpiChangedEventArgs containing info about the Dpi Changed event
adds palette colors
Resolve colors marked AUTO_COLOR using the theme's strokePalette and fillPalette To do custom adjustments to the resolved colors, override the adjustAutoColor method
Cancel all previous animations and run the current one
Sets initial and end animation vectors
Sets the RenderPassData instance used for this render pass
The render layer grouping within which the series will be draw. Defaults to EDefaultRenderLayer.SeriesLayer (5)
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.
Returns a dataset for drawing on the viewport
The resampling parameters
Internal method that runs on each animation tick
The current animation progress, a value from 0 to 1
The animation finite state machine
Runs renderdataTransform to set transformedRenderPassData, usually for use with ranging.
Generated using TypeDoc
Defines a rectangle-series or JavaScript rectangle chart type in the SciChart's High Performance Real-time JavaScript Charts
To add a rectangle series to a SciChartSurface you need to declare both the RenderableSeries and a DataSeries.
📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/fast-rectangle-renderable-series/