Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBaseOhlcRenderableSeriesOptions

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Hierarchy

Index

Properties

Properties

Optional animation

animation: SeriesAnimation | TAnimationDefinition

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

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 dataLabelProvider

dataLabelProvider: BaseDataLabelProvider | TDataLabelProviderDefinition

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

Optional dataPointWidth

dataPointWidth: number

Sets a value used to calculate the width of candles. By default the value is treated as relative, valid values range from 0.0 - 1.0. To specify if the value should be treated as relative, absolute, or based on range use dataPointWidthMode

Optional dataPointWidthMode

dataPointWidthMode: EDataPointWidthMode

Gets or sets the mode which determines how dataPointWidth is interpreted. Available values are EDataPointWidthMode. Default Relative.

Optional dataSeries

dataSeries: IDataSeries

The DataSeries which provides a datasource for this IRenderableSeries to draw

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 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 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 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 strokeDown

strokeDown: string

Sets the stoke when candlestick close is less than open, as an HTML color code

Optional strokeThickness

strokeThickness: number

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

Optional strokeUp

strokeUp: string

Sets the stoke when candlestick close is greater than open, as an HTML color code

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); // Has Id = AxisCore.DEFAULT_AXIS_ID
const primaryYAxis = new NumericAxis(wasmContext); // Has Id = AxisCore.DEFAULT_AXIS_ID

const secondaryXAxis = new NumericAxis(wasmContext); // For subsequent X,Y axis set an Id
secondaryXAxis.id = "SecondaryXAxis";
const secondaryYAxis = new NumericAxis(wasmContext);
secondaryYAxis.id = "SecondaryYAxis";

// 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); // xAxisId, yAxisId Defaults to AxisCore.DEFAULT_AXIS_ID
sciChartSurface.renderableSeries.add(renderSeries);

// Add a series on the specific axis
const renderSeries2 = new FastLineRenderableSeries(wasmContext);
renderSeries2.xAxisId = "SecondaryXAxis";
renderSeries2.yAxisId = "SecondaryYAxis";
remarks

The default value is set to AxisCore.DEFAULT_AXIS_ID.

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); // Has Id = AxisCore.DEFAULT_AXIS_ID
const primaryYAxis = new NumericAxis(wasmContext); // Has Id = AxisCore.DEFAULT_AXIS_ID

const secondaryXAxis = new NumericAxis(wasmContext); // For subsequent X,Y axis set an Id
secondaryXAxis.id = "SecondaryXAxis";
const secondaryYAxis = new NumericAxis(wasmContext);
secondaryYAxis.id = "SecondaryYAxis";

// 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); // xAxisId, yAxisId Defaults to AxisCore.DEFAULT_AXIS_ID
sciChartSurface.renderableSeries.add(renderSeries);

// Add a series on the specific axis
const renderSeries2 = new FastLineRenderableSeries(wasmContext);
renderSeries2.xAxisId = "SecondaryXAxis";
renderSeries2.yAxisId = "SecondaryYAxis";
remarks

The default value is set to AxisCore.DEFAULT_AXIS_ID.

Optional yRangeMode

yRangeMode: EYRangeMode

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

Generated using TypeDoc