IFastRectangleRenderableSeriesOptions | API Documentation for SciChart.js

Options to pass to the FastRectangleRenderableSeries constructor

Hierarchy

IBaseRenderableSeriesOptions
- IFastRectangleRenderableSeriesOptions
  - IPolarColumnRenderableSeriesOptions

Index

Properties

Optional animation

animation: SeriesAnimation | TAnimationDefinition

An animation that runs on the start, child class to SeriesAnimation

Optional bottomCornerRadius

bottomCornerRadius: number

Sets the bottom corner radius, to give the rectangles bottom rounded corners. Default is 0

Optional clipToYRange

clipToYRange: boolean

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

Optional columnXMode

columnXMode: EColumnMode

This determines how the x values and optional x1 values are interpreted

Optional columnYMode

columnYMode: EColumnYMode

This determines how the y values and optional y1 values are interpreted

Optional customTextureOptions

customTextureOptions: ICustomTextureOptions

Options that creates a custom texture brush

Optional dataLabelProvider

dataLabelProvider: BaseDataLabelProvider | TDataLabelProviderDefinition

A DataLabelProvider used for creating and drawing per-point text.

Optional dataLabels

dataLabels: IRectangleSeriesDataLabelProviderOptions

Options to pass to the DataLabelProvider. Set a style with font and size to enable per-point text for this series.

Optional dataPointWidth

dataPointWidth: number

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.

Optional dataPointWidthMode

dataPointWidthMode: EDataPointWidthMode

Sets the mode which determines how dataPointWidth in X direction is interpreted. Available values are EDataPointWidthMode. Default Relative.

Optional dataSeries

dataSeries: IDataSeries

The DataSeries which provides a datasource for this IRenderableSeries to draw

Optional defaultY1

defaultY1: number

Sets a common y1 value for all rectangles if y1Values are not provided. Default 0

Optional drawNaNAs

drawNaNAs: ELineDrawMode

How to treat NAN (Not a number) values in the input dataSeries. See ELineDrawMode for a list of values.

Optional effect

effect: ShaderEffect | TEffectDefinition

An optional ShaderEffect for modifying the render output of this IRenderableSeries

remarks: Options include GlowEffect and ShadowEffect. Apply an effect to see how it modifies rendering!

Optional fill

fill: string

The column fill as an HTML color code

Optional fillLinearGradient

fillLinearGradient: GradientParams

Sets the fill as a gradient brush

Optional id

id: string

A unique Id for the IRenderableSeries

Optional isDigitalLine

isDigitalLine: boolean

When true, if this series draws a line, the line will be a digital (step) line

Optional isHovered

isHovered: boolean

Initial hovered state for the series. Default to false

Optional isSelected

isSelected: boolean

Initial selected state for the series. Default to false

Optional isVisible

isVisible: boolean

When true, the series is visible and drawn

Optional onHoveredChanged

onHoveredChanged: TSeriesHoverChangedCallback | string

Optional callback function when hovered changed. Also see IRenderableSeries.hovered event handler

Optional onIsVisibleChanged

onIsVisibleChanged: TSeriesVisibleChangedCallback | string

Optional callback function when isVisible changed. Also see IRenderableSeries.isVisibleChanged event handler

Optional onSelectedChanged

onSelectedChanged: TSeriesSelectionChangedCallback | string

Optional callback function when selected changed. Also see IRenderableSeries.selected event handler

Optional opacity

opacity: number

An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

Optional paletteProvider

paletteProvider: IPaletteProvider | TPaletteProviderDefinition

An optional IPaletteProvider which is used to provide per data-point coloring or paletting.

remarks: See IStrokePaletteProvider for per data-point coloring of lines or strokes, IFillPaletteProvider for per data-point coloring of fills or series bodies, and IPointMarkerPaletteProvider for per data-point coloring of point-markers

Optional pointMarker

pointMarker: IPointMarker | TPointMarkerDefinition

A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only

Optional renderLayer

renderLayer: EDefaultRenderLayer | number

The layer to draw the series on. Defaults to SeriesRenderLayer

Optional renderNextTo

renderNextTo: { offset: number; renderable: IOrderedRenderable | string }

Another series or annotation to draw relative to. The offset can be positive or negative and can (and usually should) be fractional

Type declaration

offset: number
renderable: IOrderedRenderable | string

Optional renderOrder

renderOrder: number

The draw order. Larger numbers draw on top. Defaults to the position of the series in the renderableSeries array.

Optional resamplingMode

resamplingMode: EResamplingMode

Gets or sets the EResamplingMode used when drawing this series. Default value is AUTO. To disable resampling for this series, set mode to NONE.

Optional resamplingPrecision

resamplingPrecision: number

Gets or sets the resampling precision for this series

Optional seriesName

seriesName: string

Series name

Optional stroke

stroke: string

A Stroke for lines, outlines and edges of this RenderableSeries

remarks: Acceptable values include RGB format e.g. #FF0000, RGBA format e.g. #FF000077`` and RGBA format e.g.rgba(255,0,0,0.5)```

Optional strokeThickness

strokeThickness: number

The Stroke Thickness for lines, outlines and edges of this RenderableSeries

Optional surfaceRenderOrder

surfaceRenderOrder: number

An override to allow the series to appear to be drawn on a different surface to the one it is attached to. Only relevant when using subcharts

Optional topCornerRadius

topCornerRadius: number

Sets the top corner radius, to give the rectangles top rounded corners. Default is 0

Optional xAxisId

xAxisId: string

summary

The current XAxis Id that this BaseRenderableSeries is bound to

description

By default all series will draw on the first X,Y axis pair in SciChart. If you want this to change, you must add a second axis to your SciChartSurface and link the BaseRenderableSeries by Axis Id.

For example:

const sciChartSurface: SciChartSurface;
const primaryXAxis = new NumericAxis(wasmContext);
const primaryYAxis = new NumericAxis(wasmContext);

const secondaryXAxis = new NumericAxis(wasmContext);  // No need to set Ids as unique Ids are auto generated
const secondaryYAxis = new NumericAxis(wasmContext);

// Add all Axis to the chart
sciChartSurface.xAxes.add(primaryXAxis);
sciChartSurface.yAxes.add(primaryYAxis);
sciChartSurface.xAxes.add(secondaryXAxis);
sciChartSurface.yAxes.add(secondaryYAxis);

// Add a series on the default axis
const renderSeries = new FastLineRenderableSeries(wasmContext);
sciChartSurface.renderableSeries.add(renderSeries);

// Add a series on the specific axis
const renderSeries2 = new FastLineRenderableSeries(wasmContext, { xAxisId: SecondaryXAxis.id }); // Use the instance Id, not a string
renderSeries2.yAxisId = SecondaryYAxis.id;  // Can also update these at any time but renderSeries2.yAxis will be set undefined until the start of the next render

Optional yArrayFilter

yArrayFilter: number | string

When using XyNDataSeries, set this to determine which single set of y values to use

Optional yAxisId

yAxisId: string

summary

The current YAxis Id that this BaseRenderableSeries is bound to

description

By default all series will draw on the first X,Y axis pair in SciChart. If you want this to change, you must add a second axis to your SciChartSurface and link the BaseRenderableSeries by Axis Id.

For example:

const sciChartSurface: SciChartSurface;
const primaryXAxis = new NumericAxis(wasmContext);
const primaryYAxis = new NumericAxis(wasmContext);

const secondaryXAxis = new NumericAxis(wasmContext);  // No need to set Ids as unique Ids are auto generated
const secondaryYAxis = new NumericAxis(wasmContext);

// Add all Axis to the chart
sciChartSurface.xAxes.add(primaryXAxis);
sciChartSurface.yAxes.add(primaryYAxis);
sciChartSurface.xAxes.add(secondaryXAxis);
sciChartSurface.yAxes.add(secondaryYAxis);

// Add a series on the default axis
const renderSeries = new FastLineRenderableSeries(wasmContext);
sciChartSurface.renderableSeries.add(renderSeries);

// Add a series on the specific axis
const renderSeries2 = new FastLineRenderableSeries(wasmContext, { xAxisId: SecondaryXAxis.id }); // Use the instance Id, not a string
renderSeries2.yAxisId = SecondaryYAxis.id;  // Can also update these at any time but renderSeries2.yAxis will be set undefined until the start of the next render

Optional yRangeMode

yRangeMode: EYRangeMode

Determines whether the y range for this series should include the drawn points just outside the visible range (the default), or if it should consider only the visible data. Visible mode is often better for Digital lines or if your data has very large jumps in y values.