Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines a line-series or line chart type with Cubic Spline interpolation in the SciChart's High Performance Real-time JavaScript Charts

remarks

To add a line series to a SciChartSurface you need to declare both the RenderableSeries and a DataSeries. Simplified code sample below:

const sciChartSurface: SciChartSurface;
const wasmContext: TSciChart;
// Create and fill the dataseries
const dataSeries = new XyDataSeries(wasmContext);
dataSeries.append(1,2);
dataSeries.append(1,2);
// Create the renderableSeries
const lineSeries = new SplineLineRenderableSeries(wasmContext);
lineSeries.dataSeries = dataSeries;
// append to the SciChartSurface
sciChartSurface.renderableSeries.add(lineSeries);

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected animationFSM

Protected animationQueue

animationQueue: SeriesAnimation[] = []

Protected currentRenderPassData

currentRenderPassData: RenderPassData

Protected dataLabelProviderProperty

dataLabelProviderProperty: BaseDataLabelProvider

Protected dataSeriesProperty

dataSeriesProperty: IDataSeries

hitTestProvider

hitTestProvider: IHitTestProvider

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

hovered

hovered: EventHandler<SeriesHoveredArgs> = new EventHandler<SeriesHoveredArgs>()

A hovered EventHandler. This event fires whenever the Series is hovered or unhovered by a mouse or pointer.

remarks

See EventHandler for how to subscribe

Readonly id

id: string

A unique Id for the IRenderableSeries

invalidateParentCallback

invalidateParentCallback: () => void

A callback which tells the parent SciChartSurface that it must be redrawn, e.g. when a property changes

Type declaration

    • (): void
    • Returns void

Protected isSplineProperty

isSplineProperty: boolean = true

Readonly isStacked

isStacked: boolean

Returns true if the series is a stacked series or not

isVisibleChanged

isVisibleChanged: EventHandler<SeriesVisibleChangedArgs> = new EventHandler<SeriesVisibleChangedArgs>()

An isVisible changed EventHandler. This event fires whenever the Series isVisible changes.

remarks

See EventHandler for how to subscribe

Protected opacityProperty

opacityProperty: number = 1

Protected paletteProviderProperty

paletteProviderProperty: IPaletteProvider = DefaultPaletteProvider.createEmpty()

Protected pointSeries

Protected renderDataTransformProperty

renderDataTransformProperty: IRenderDataTransform

Protected resamplerHelper

resamplerHelper: ExtremeResamplerHelper

Protected resamplingParams

resamplingParams: ResamplingParams

Readonly rolloverModifierProps

rolloverModifierProps: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps(this)

Readonly rolloverModifierProps1

rolloverModifierProps1: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps(this, true)

Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips Is being used for Y1 tooltips for FastBandRenderableSeries

selected

selected: EventHandler<SeriesSelectedArgs> = new EventHandler<SeriesSelectedArgs>()

A selected EventHandler. This event fires whenever the Series is selected or deselected.

remarks

See EventHandler for how to subscribe

Protected transformedRenderPassData

transformedRenderPassData: RenderPassData

Readonly type

type: SplineLineSeries = ESeriesType.SplineLineSeries

Protected typeMap

typeMap: Map<string, string> = new Map<string, string>()

Protected webAssemblyContext

webAssemblyContext: TSciChart

Accessors

animation

clipToYRange

  • get clipToYRange(): boolean
  • set clipToYRange(value: boolean): void
  • 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

    Returns 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

    Parameters

    • value: boolean

    Returns void

dataLabelProvider

dataSeries

drawNaNAs

drawingProviders

effect

enableDrawingOptimisations

  • get enableDrawingOptimisations(): boolean
  • Readonly. When true, resampling modes are enabled for faster drawing performance.

    inheritdoc

    Returns boolean

interpolationPoints

  • get interpolationPoints(): number
  • set interpolationPoints(value: number): void
  • Gets or sets the interpolationPoints being used for the Spline

    Returns number

  • Gets or sets the interpolationPoints being used for the Spline

    Parameters

    • value: number

    Returns void

isDigitalLine

  • get isDigitalLine(): boolean
  • set isDigitalLine(isDigitalLine: boolean): void
  • When true, if this series draws a line, the line will be a digital (step) line

    inheritdoc

    Returns boolean

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

    inheritdoc

    Parameters

    • isDigitalLine: boolean

    Returns void

isHovered

  • get isHovered(): boolean
  • set isHovered(isHovered: boolean): void
  • Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic

    inheritdoc

    Returns boolean

  • Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic

    inheritdoc

    Parameters

    • isHovered: boolean

    Returns void

isRunningAnimation

  • get isRunningAnimation(): boolean

isRunningDataAnimation

  • get isRunningDataAnimation(): boolean

isSelected

  • get isSelected(): boolean
  • set isSelected(isSelected: boolean): void
  • Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic

    inheritdoc

    Returns boolean

  • Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic

    inheritdoc

    Parameters

    • isSelected: boolean

    Returns void

isSpline

  • get isSpline(): boolean

isVisible

  • get isVisible(): boolean
  • set isVisible(isVisible: boolean): void
  • When true, the series is visible and drawn

    inheritdoc

    Returns boolean

  • When true, the series is visible and drawn

    inheritdoc

    Parameters

    • isVisible: boolean

    Returns void

lineType

opacity

  • get opacity(): number
  • set opacity(value: number): void
  • An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

    inheritdoc

    Returns number

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

    inheritdoc

    Parameters

    • value: number

    Returns void

paletteProvider

parentSurface

pointMarker

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

    inheritdoc

    Returns IPointMarker | undefined

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

    inheritdoc

    Parameters

    Returns void

renderDataTransform

resamplingMode

resamplingPrecision

  • get resamplingPrecision(): number
  • set resamplingPrecision(value: number): void
  • 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.

    inheritdoc

    Returns number

  • 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.

    inheritdoc

    Parameters

    • value: number

    Returns void

stroke

  • get stroke(): string
  • set stroke(htmlColorCode: string): void
  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns string

  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Parameters

    • htmlColorCode: string

    Returns void

strokeDashArray

  • get strokeDashArray(): number[]
  • set strokeDashArray(strokeDashArray: number[]): void
  • The StrokeDashArray defines the stroke or dash pattern for the line. Accepts an array of values, e.g. [2,2] will have a line of length 2 and a gap of length 2.

    Returns number[]

  • The StrokeDashArray defines the stroke or dash pattern for the line. Accepts an array of values, e.g. [2,2] will have a line of length 2 and a gap of length 2.

    Parameters

    • strokeDashArray: number[]

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(value: number): void
  • The Stroke Thickness for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns number

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

    inheritdoc

    Parameters

    • value: number

    Returns void

supportsResampling

  • get supportsResampling(): boolean

warnOnSplineFailure

  • get warnOnSplineFailure(): boolean
  • set warnOnSplineFailure(value: boolean): void
  • Set false to disable the warning if the spline cannot be calculated

    Returns boolean

  • Set false to disable the warning if the spline cannot be calculated

    Parameters

    • value: boolean

    Returns void

xAxis

xAxisId

  • get xAxisId(): string
  • set xAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

xSplineValues

  • get xSplineValues(): SCRTDoubleVector
  • Returns SCRTDoubleVector

yAxis

yAxisId

  • get yAxisId(): string
  • set yAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

yRangeMode

  • 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

    inheritdoc

    Returns 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

    Parameters

    Returns void

ySplineValues

  • get ySplineValues(): SCRTDoubleVector
  • Returns SCRTDoubleVector

Methods

adjustAutoColor

  • adjustAutoColor(propertyName: string, color: string): string

Protected afterAnimationComplete

  • afterAnimationComplete(): void

applyTheme

Protected beforeAnimationStart

  • beforeAnimationStart(): void

checkIsOutOfDataRange

  • checkIsOutOfDataRange(xValue: number, yValue: number): boolean

Protected dataSeriesDataChanged

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

draw

enqueueAnimation

getCurrentRenderPassData

getDataPointWidth

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

getIndicesRange

getNativeXValues

  • getNativeXValues(): SCRTDoubleVector

getNativeYValues

  • getNativeYValues(): SCRTDoubleVector

Protected getResampledPointSeries

  • getResampledPointSeries(isXCategoryAxis?: boolean): IPointSeries

getResamplingParams

getSeriesInfo

getXRange

getYRange

hasDataSeries

  • hasDataSeries(): boolean

hasDataSeriesValues

  • hasDataSeriesValues(): boolean

hasFillPaletteProvider

  • hasFillPaletteProvider(): boolean

hasPointMarkerPaletteProvider

  • hasPointMarkerPaletteProvider(): boolean

hasStrokePaletteProvider

  • hasStrokePaletteProvider(): boolean

Protected needsResampling

Protected newHitTestProvider

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAnimate

  • onAnimate(timeElapsed: number): void

onAttach

onDetach

  • onDetach(): void

onDpiChanged

onSplineFailure

  • onSplineFailure(): void
  • deprecated

    This is now handled within the renderDataTransform

    Returns void

pushPalettedColors

resolveAutoColors

  • resolveAutoColors(index: number, maxSeries: number, theme: IThemeProvider): void

runAnimation

Protected setAnimationVectors

setCurrentRenderPassData

Protected setPaletteProvider

toJSON

toPointSeries

Protected updateAnimationProperties

updateSplineValues

  • updateSplineValues(): void
  • Returns void

Protected updateTransformedValues

Protected valueChanged

  • valueChanged(oldValue: any, newValue: any): boolean
  • Parameters

    • oldValue: any
    • newValue: any

    Returns boolean

Generated using TypeDoc