Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

Defines the base class to a Render Series (or Chart Type) in SciChart's High Performance Real-time JavaScript Charts

remarks

A RenderableSeries defines how data should be rendered. e.g. as a Line Chart, Mountain Chart, Candlestick Chart etc... This is independent from the DataSeries which stores the data to render

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.

Hierarchy

Implements

Index

Constructors

Protected constructor

Properties

Protected animationToken

animationToken: AnimationToken

Protected dataSeriesProperty

dataSeriesProperty: IDataSeries

drawingProviders

drawingProviders: ISeriesDrawingProvider[] = []

Gets a list of Series Drawing Providers, which perform specific drawing operations in the series

hitTestProvider

hitTestProvider: IHitTestProvider

Gets the current IHitTestProvider, used to call methods IHitTestProvider.hitTest, IHitTestProvider.getNearestPoint2D and IHitTestProvider.getNearestHorizontalPoint and provide info about the series data-points at mouse or touch locations

Readonly id

id: string = generateGuid()

A unique, auto-generated 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

Readonly isStacked

isStacked: false = false

Returns true if the series is a stacked series or not

parentSurface

parentSurface: SciChartSurface

The parent SciChartSurface that this RenderableSeries is attached to

Readonly rolloverModifierProps

rolloverModifierProps: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps()

Readonly rolloverModifierProps1

rolloverModifierProps1: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps()

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

Readonly Abstract type

Returns the type of the series. See ESeriesType for a list of values

Protected webAssemblyContext

webAssemblyContext: TSciChart

yAnimationValues

yAnimationValues: DoubleVector

Y vector with animation values

Accessors

animation

  • Gets a start up animation class, a child class for BaseAnimation

    Returns BaseAnimation

  • Sets a start up animation class, a child class for BaseAnimation

    Parameters

    Returns void

dataSeries

  • The DataSeries which provides a datasource for this IRenderableSeries to draw

    inheritdoc

    Returns IDataSeries

  • The DataSeries which provides a datasource for this IRenderableSeries to draw

    inheritdoc

    Parameters

    Returns void

drawNaNAs

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

    inheritdoc

    Returns ELineDrawMode

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

    inheritdoc

    Parameters

    Returns void

effect

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

isRunningAnimation

  • get isRunningAnimation(): boolean
  • gets if the animation is currently running

    Returns boolean

isSpline

  • get isSpline(): boolean
  • Returns true if the series uses spline interpolation

    inheritdoc

    Returns 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

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

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

    inheritdoc

    Returns IPaletteProvider

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

    inheritdoc

    Parameters

    Returns void

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

  • 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

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

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

xAxis

xAxisId

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

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

yAxis

yAxisId

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

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

Methods

Protected afterAnimationComplete

  • afterAnimationComplete(): void
  • Runs after the animation is complete

    Returns void

Protected animate

  • animate(): void
  • Starts an animation for IRenderableSeries

    Returns void

applyTheme

Protected beforeAnimationStart

  • beforeAnimationStart(): void
  • Runs before the animation starts

    Returns void

checkIsOutOfDataRange

  • checkIsOutOfDataRange(xValue: number, yValue: number, isSorted?: boolean): boolean
  • Checks is the point is out of the data range. For sorted data only. Is used to hide tooltips for RolloverModifier

    Parameters

    • xValue: number

      The X value of the point

    • yValue: number

      The Y value of the point

    • Optional isSorted: boolean

    Returns boolean

Protected dataSeriesDataChanged

  • dataSeriesDataChanged(): void
  • Is being called when the data for the underlying DataSeries changes

    Returns void

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

getBaseXValues

  • getBaseXValues(): number[]

getDataPointWidth

  • description

    Calculates data point width in pixels

    Parameters

    Returns number

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

getNativeXValues

  • getNativeXValues(): DoubleVector

getNativeYValues

  • getNativeYValues(): DoubleVector

getXRange

  • Gets the X-Range of the series. Override in derived classes to provide series specific implementations

    Returns NumberRange

getYRange

  • Gets the Y-Range of the series for the current X-Range. Override in derived classes to provide series specific implementations

    Parameters

    Returns NumberRange

hasDataSeries

  • hasDataSeries(): boolean

hasDataSeriesValues

  • hasDataSeriesValues(): boolean

hasFillPaletteProvider

  • hasFillPaletteProvider(): boolean

hasPointMarkerPaletteProvider

  • hasPointMarkerPaletteProvider(): boolean

hasStrokePaletteProvider

  • hasStrokePaletteProvider(): boolean

Protected Abstract newHitTestProvider

  • Factory function to create a Hit Test Provider; a class which performs hit-test and checks mouse-over and nearest point.

    Returns IHitTestProvider

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void
  • inheritdoc

    Parameters

    • propertyName: string

    Returns void

Protected onAnimate

  • onAnimate(progress: number): void
  • Internal method that runs on each animation tick

    Parameters

    • progress: number

      The current animation progress, a value from 0 to 1

    Returns void

onAttach

onDetach

  • onDetach(): void

pushPalettedColors

Generated using TypeDoc