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 animationFSM

Protected animationQueue

animationQueue: SeriesAnimation[] = []

Protected currentRenderPassData

currentRenderPassData: RenderPassData

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

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 resamplerHelper

resamplerHelper: ExtremeResamplerHelper

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

Readonly Abstract type

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

Protected typeMap

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

Protected webAssemblyContext

webAssemblyContext: TSciChart

Accessors

animation

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

    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

drawingProviders

effect

enableDrawingOptimisations

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

    inheritdoc

    Returns boolean

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
  • gets if the animation is currently running

    inheritdoc

    Returns boolean

isRunningDataAnimation

  • get isRunningDataAnimation(): boolean
  • gets if a data animation is currently running

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

parentSurface

  • The parent SciChartSurface that this RenderableSeries is attached to

    inheritdoc

    Returns SciChartSurface

  • The parent SciChartSurface that this RenderableSeries is attached to

    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

resamplingMode

  • Gets or Sets the resamplingMode EResamplingMode

    Returns EResamplingMode

  • Gets or Sets the resamplingMode EResamplingMode

    Parameters

    Returns void

resamplingPrecision

  • get resamplingPrecision(): number
  • set resamplingPrecision(value: number): void
  • Gets or Sets the resamplingPrecision

    Returns number

  • Gets or Sets the resamplingPrecision

    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

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
  • Returns true if the series supports resampling

    inheritdoc

    Returns boolean

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

applyTheme

Protected beforeAnimationStart

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

    Returns void

checkIsOutOfDataRange

  • checkIsOutOfDataRange(xValue: number, yValue: number): 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

    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

enqueueAnimation

getCurrentRenderPassData

getDataPointWidth

  • description

    Calculates data point width in pixels

    Parameters

    Returns number

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

getIndicesRange

getNativeXValues

  • getNativeXValues(): SCRTDoubleVector

getNativeYValues

  • getNativeYValues(): SCRTDoubleVector

getSeriesInfo

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 needsResampling

  • Used internally to check if resampling is needed for the renderable series

    Parameters

    Returns 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

onAnimate

  • onAnimate(timeElapsed: number): void
  • Is called for each render

    Parameters

    • timeElapsed: number

    Returns void

onAttach

onDetach

  • onDetach(): void

onDpiChanged

  • 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

    Parameters

    Returns void

pushPalettedColors

runAnimation

  • Cancel all previous animations and run the current one

    Parameters

    Returns void

Protected setAnimationVectors

  • Sets initial and end animation vectors

    Parameters

    Returns void

Protected setPaletteProvider

  • Parameters

    Returns void

toJSON

  • Convert the object to a definition that can be serialized to JSON, or used directly with the builder api

    Parameters

    • Default value excludeData: boolean = false

      if set true, data values will not be included in the json.

    Returns TSeriesDefinition

toPointSeries

Protected updateAnimationProperties

  • Internal method that runs on each animation tick

    Parameters

    Returns void

Protected valueChanged

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

    • oldValue: any
    • newValue: any

    Returns boolean

Generated using TypeDoc