Options
All
  • Public
  • Public/Protected
  • All
Menu

API Documentation for SciChart.js - v2.0.2196

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

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

NumberArray

NumberArray: number[] | Float64Array

RequiredOwnProps

RequiredOwnProps<Type, BaseType>: Required<Omit<Type, keyof BaseType>>

Copies own properties of an interface or copies all of its props if base type is not provided. Makes all of the props required.

Type parameters

  • Type: BaseType

  • BaseType

SuspendedInstance

SuspendedInstance: { id: string; suspendCount: number; suspendable: ISuspendable }

Internal type used to track suspendable instances and number of nested suspend calls

Type declaration

SvgStringTemplate

SvgStringTemplate: (x1: number, y1: number, x2: number, y2: number) => string

Function signature for the SVG builder function

Type declaration

    • (x1: number, y1: number, x2: number, y2: number): string
    • Parameters

      • x1: number
      • y1: number
      • x2: number
      • y2: number

      Returns string

TAnimationDefinition

TAnimationDefinition: { options?: IFadeAnimationOptions; type: Fade } | { options?: IScaleAnimationOptions; type: Scale } | { options?: ISweepAnimationOptions; type: Sweep } | { options?: IWaveAnimationOptions; type: Wave } | { customType?: string; options?: IBaseAnimationOptions; type: Custom }

Definition of an animation, comprising a EAnimationType and the relevant options

TAnnotationDefinition

Definition of an annotation, comprising a EAnnotationType and the relevant options

TArgb

TArgb: { blue: number; green: number; opacity: number; red: number }

Type declaration

  • blue: number
  • green: number
  • opacity: number
  • red: number

TAxisCubeState

TAxisCubeState: { xVisibleMax: number; xVisibleMin: number; xWorldDimension: number; yVisibleMax: number; yVisibleMin: number; yWorldDimension: number; zVisibleMax: number; zVisibleMin: number; zWorldDimension: number }

A type class to contain information about the current state of 3D Axis Cube, such is Visible Range or World Dimensions.

Type declaration

  • xVisibleMax: number
  • xVisibleMin: number
  • xWorldDimension: number
  • yVisibleMax: number
  • yVisibleMin: number
  • yWorldDimension: number
  • zVisibleMax: number
  • zVisibleMin: number
  • zWorldDimension: number

TAxisDefinition

TAxisDefinition: { options?: INumericAxisOptions; type: NumericAxis } | { options?: ILogarithmicAxisOptions; type: LogarithmicAxis } | { options?: ICategoryAxisOptions; type: CategoryAxis }

Definition of an AxisBase2D, comprising a EAxisType and the relevant options

TAxisViewRects

TAxisViewRects: { axisRendererViewRect: Rect; axisTitleRendererViewRect: Rect }

Type declaration

  • axisRendererViewRect: Rect
  • axisTitleRendererViewRect: Rect

TBorder

TBorder: { border?: number; borderBottom?: number; borderLeft?: number; borderRight?: number; borderTop?: number; color?: string }

A Border applied to the series viewport, axes or the entire chart surface

Type declaration

  • Optional border?: number
  • Optional borderBottom?: number
  • Optional borderLeft?: number
  • Optional borderRight?: number
  • Optional borderTop?: number
  • Optional color?: string

TCachedLabelStyle

TCachedLabelStyle: TTextStyle & { extras?: string; providerId: string; rotation?: number }

TCameraState

TCameraState: { height?: number; pitch?: number; radius?: number; width?: number; yaw?: number }

Type declaration

  • Optional height?: number
  • Optional pitch?: number
  • Optional radius?: number
  • Optional width?: number
  • Optional yaw?: number

TCategoryCoordCalc

TContourLineStyle

TContourLineStyle: { color?: string; strokeThickness?: number }

A type class to contain information about contour line styles

remarks

A contour line is drawn using the UniformContoursRenderableSeries with a 2D array of data

  • Set the color as an HTML Color code to define the color
  • Set the strokeThickness to change the thickness of the contour line

Type declaration

  • Optional color?: string
  • Optional strokeThickness?: number

TCursorTooltipDataTemplate

TCursorTooltipDataTemplate: (seriesInfos: SeriesInfo[], tooltipTitle: string) => string[]

Type declaration

    • (seriesInfos: SeriesInfo[], tooltipTitle: string): string[]
    • Parameters

      Returns string[]

TCursorTooltipSvgTemplate

TCursorTooltipSvgTemplate: (seriesInfos: SeriesInfo[], svgAnnotation: CursorTooltipSvgAnnotation) => string

Type declaration

TDpiChangedEventArgs

TDpiChangedEventArgs: { newValue: number; oldValue: number }

Type arguments to DpiHelper.dpiChanged event

Type declaration

  • newValue: number

    The new Dpi scaling factor

  • oldValue: number

    The previous Dpi scaling factor

TDrawFunction

TDrawFunction: () => void

Type declaration

    • (): void
    • Returns void

TEasingFn

TEasingFn: (time: number) => number

An easing function used in animations through SciChart. See easing for a list of values

Type declaration

    • (time: number): number
    • Parameters

      • time: number

      Returns number

TEffectDefinition

TEffectDefinition: { options?: IGlowEffectOptions; type: Glow } | { options?: IShadowEffectOptions; type: Shadow }

Definition of a shader effect, comprising a EShaderEffectType and the relevant options

TElement

TElement: { arg: NumberArray | any[]; name: string }

Type declaration

TFilterDefinition

TFilterDefinition: { options?: IXyFilterOptions; type: XyLinearTrend } | { options?: IXyMovingAverageFilterOptions; type: XyMovingAverage } | { options: IXyRatioFilterOptions; type: XyRatio } | { options?: IXyScaleOffsetFilterOptions; type: XyScaleOffset } | { options?: IXyyScaleOffsetFilterOptions; type: XyyScaleOffset } | { options?: IXyzScaleOffsetFilterOptions; type: XyzScaleOffset } | { options?: IOhlcScaleOffsetFilterOptions; type: OhlcScaleOffset }

Definition of a data filter

TFormatLabelFn

TFormatLabelFn: (dataValue: number) => string

Formats a data-value into a string for display

param

The data-value (e.g. a numeric value)

Type declaration

    • (dataValue: number): string
    • Parameters

      • dataValue: number

      Returns string

TGradientStop

TGradientStop: { color: string; offset: number }

A Gradient stop applied to gradients on lines, fills thoughout SciChart

Type declaration

  • color: string

    The gradient stop color as an HTML color code

  • offset: number

    The gradient offset. Allowable values are in the range 0 to 1

TGridLineStyle

TGridLineStyle: { color?: string; strokeDashArray?: number[]; strokeThickness?: number }

A type class to contain information about gridline styles

remarks

A grid line is the X Y axis grid inside the chart

  • Set the color as an HTML Color code to define the color
  • Set the strokeThickness to change the thickness of the grid line
  • Set the strokeDashArray to define dash pattern, e.g. [2,2] will have a 2-pixel long dash every 2 pixels

Type declaration

  • Optional color?: string
  • Optional strokeDashArray?: number[]
  • Optional strokeThickness?: number

THoveredChangedCallback

THoveredChangedCallback: (args: HoveredChangedArgs) => void

The type of the callback function

Type declaration

TImageResponse

TImageResponse: { imageData: ImageData; textureHeight: number; textureWidth: number }

Type declaration

  • imageData: ImageData
  • textureHeight: number
  • textureWidth: number

TInnerLayoutStrategyDefinition

TInnerLayoutStrategyDefinition: { customType?: string; options?: IInnerAxisLayoutStrategyOptions; type: ELayoutStrategyType }

Type declaration

TLabelProviderDefinition

TLabelProviderDefinition: { options?: ILabelOptions; type: Numeric } | { options?: ILabelOptions; type: Date } | { options?: ILabelOptions; type: Logarithmic } | { options?: {}; type: SmartDate } | { options?: ITextLabelOptions; type: Text }

Definition of a LabelProviderBase2D, comprising a ELabelProviderType and the relevant options

TLayoutAxisPartsWithStrategyFunc

TLayoutAxisPartsWithStrategyFunc: (axisRendererWidth: number, axisRendererHeight: number, axisTitleRendererWidth: number, axisTitleRendererHeight: number, axisRect: Rect, border: TBorder) => TAxisViewRects

Type declaration

    • (axisRendererWidth: number, axisRendererHeight: number, axisTitleRendererWidth: number, axisTitleRendererHeight: number, axisRect: Rect, border: TBorder): TAxisViewRects
    • Parameters

      • axisRendererWidth: number
      • axisRendererHeight: number
      • axisTitleRendererWidth: number
      • axisTitleRendererHeight: number
      • axisRect: Rect
      • border: TBorder

      Returns TAxisViewRects

TLayoutManagerDefinition

TLayoutManagerDefinition: { options?: ILayoutManagerOptions; type: Default } | { options?: ICentralAxesLayoutManagerOptions; type: CentralAxes } | { options?: ILayoutManagerOptions; type: Synchronised }

TLegendItem

TLegendItem: { checked: boolean; color: string; gradient?: GradientParams; id: string; name: string }

Type declaration

  • checked: boolean
  • color: string
  • Optional gradient?: GradientParams
  • id: string
  • name: string

TLinearColorMap

TLinearColorMap: { GradientStops: TGradientStop[]; Maximum: number; Minimum: number; Mode: EColorMapMode }

Type declaration

TModifierDefinition

TModifierDefinition: { options?: ICursorModifierOptions; type: Cursor } | { options?: IDataPointSelectionModifierOptions; type: DataPointSelection } | { options?: ILegendModifierOptions; type: Legend } | { options?: IMouseWheelZoomModifierOptions; type: MouseWheelZoom } | { options?: IPinchZoomModifierOptions; type: PinchZoom } | { options?: IRolloverModifierOptions; type: Rollover } | { options?: IRubberBandXyZoomModifierOptions; type: RubberBandXYZoom } | { options?: ISeriesSelectionModifierOptions; type: SeriesSelection } | { options?: IXAxisDragModifierOptions; type: XAxisDrag } | { options?: IYAxisDragModifierOptions; type: YAxisDrag } | { options?: IZoomExtentsModifierOptions; type: ZoomExtents } | { options?: IChartModifierBaseOptions; type: ZoomPan } | { options?: IRangeSelectionModifierOptions; type: OverviewRangeSelection } | { customType?: string; options?: IChartModifierBaseOptions; type: Custom }

Definition of a 2d chart modifier, comprising a EChart2DModifierType and the relevant options

TModifierKeys

TModifierKeys: { altKey: boolean; ctrlKey: boolean; shiftKey: boolean }

Type to store whether modifier keys (Control, Shift, Alt) are pressed or not

Type declaration

  • altKey: boolean
  • ctrlKey: boolean
  • shiftKey: boolean

TModifierMouseArgsParams

TModifierMouseArgsParams: { altKey?: boolean; button?: number; ctrlKey?: boolean; isMaster?: boolean; modifierGroup?: string; mousePoint?: Point; mouseWheelDelta?: number; pointerId?: number; pointerType?: string; shiftKey?: boolean; target?: Element }

Type declaration

  • Optional altKey?: boolean
  • Optional button?: number
  • Optional ctrlKey?: boolean
  • Optional isMaster?: boolean
  • Optional modifierGroup?: string
  • Optional mousePoint?: Point
  • Optional mouseWheelDelta?: number
  • Optional pointerId?: number
  • Optional pointerType?: string
  • Optional shiftKey?: boolean
  • Optional target?: Element

TOhlcSeriesData

TOhlcSeriesData: { closeDataId?: number | string; highDataId?: number | string; lowDataId?: number | string; openDataId?: number | string; xDataId?: number | string } & IOhlcDataSeriesOptions & { filter?: TFilterDefinition }

Definition of Open, High, Low, Close data

TOuterLayoutStrategyDefinition

TOuterLayoutStrategyDefinition: { customType?: string; options?: any; type: ELayoutStrategyType }

Type declaration

TPaletteProviderDefinition

TPaletteProviderDefinition: { options: GradientParams; type: Gradient } | { options: ISelectedPointOptions; type: DataPointSelection } | { customType: string; options?: any; type: Custom }

Definition of a palette provider, comprising a EPaletteProviderType and the relevant options

TPalettingState

TPalettingState: { gradientPaletting: boolean; originalBrushColor?: number; originalPenColor?: number; originalPenGradient?: boolean; paletteTextureCache?: PaletteCache; palettedColors: UIntVector; palettedColorsHashCode: number }

Type declaration

  • gradientPaletting: boolean
  • Optional originalBrushColor?: number
  • Optional originalPenColor?: number
  • Optional originalPenGradient?: boolean
  • Optional paletteTextureCache?: PaletteCache
  • palettedColors: UIntVector
  • palettedColorsHashCode: number

TPointMarkerArgb

TPointMarkerArgb: { fill: number; stroke: number }

Type declaration

  • fill: number
  • stroke: number

TPointMarkerDefinition

TPointMarkerDefinition: { options?: IPointMarkerOptions; type: Cross } | { options?: IPointMarkerOptions; type: Ellipse } | { options?: ISpritePointMarkerOptions; type: Sprite } | { options?: IPointMarkerOptions; type: Square } | { options?: IPointMarkerOptions; type: Triangle } | { options?: IPointMarkerOptions; type: X } | { customType?: string; options?: IPointMarkerOptions; type: Custom }

Definition of a pointmarker, comprising a EPointMarkerType and the relevant options

TPriceBar

TPriceBar: {}

Type declaration

TRenderLayers

TRenderLayers: { first: TDrawFunction[]; fourth: TDrawFunction[]; second: TDrawFunction[]; third: TDrawFunction[] }

Defines Render Layers 1,2,3,4 which are used to compose rendering

Type declaration

TRolloverLegendSvgTemplate

TRolloverLegendSvgTemplate: (seriesInfos: SeriesInfo[], svgAnnotation: RolloverLegendSvgAnnotation) => string

Type declaration

TRolloverTooltipDataTemplate

TRolloverTooltipDataTemplate: (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string) => string[]

Type declaration

    • (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string): string[]
    • Parameters

      • seriesInfo: SeriesInfo
      • tooltipTitle: string
      • tooltipLabelX: string
      • tooltipLabelY: string

      Returns string[]

TRolloverTooltipSvgTemplate

TRolloverTooltipSvgTemplate: (id: string, seriesInfo: SeriesInfo, rolloverTooltip: RolloverTooltipSvgAnnotation) => string

Type declaration

TSciChartConfig

TSciChartConfig: { dataUrl?: string; testWasm?: TSciChart | TSciChart3D; wasmUrl?: string }

Type declaration

  • Optional dataUrl?: string
  • Optional testWasm?: TSciChart | TSciChart3D

    Internal testing use only

  • Optional wasmUrl?: string

TSciChartDestination

TSciChartDestination: { canvasElementId: string; height: number; sciChartSurface: SciChartSurfaceBase; width: number }

Type declaration

TSciChartSurfaceCanvases

TSciChartSurfaceCanvases: { aspect?: number; domCanvas2D?: HTMLCanvasElement; domCanvasWebGL?: HTMLCanvasElement; domChartRoot?: HTMLDivElement; domDivContainer?: HTMLDivElement; domSvgAdornerLayer?: SVGSVGElement; domSvgContainer?: SVGSVGElement }

Type declaration

  • Optional aspect?: number
  • Optional domCanvas2D?: HTMLCanvasElement
  • Optional domCanvasWebGL?: HTMLCanvasElement
  • Optional domChartRoot?: HTMLDivElement
  • Optional domDivContainer?: HTMLDivElement
  • Optional domSvgAdornerLayer?: SVGSVGElement
  • Optional domSvgContainer?: SVGSVGElement

TSelectionChangedCallback

TSelectionChangedCallback: (args: SelectionChangedArgs) => void

The type of the callback function

Type declaration

TSeriesDataDefinition

Definition of series data, which can take various shapes

TSeriesDefinition

TSeriesDefinition: { options?: IBandRenderableSeriesOptions; type: BandSeries; xyyData?: TXyySeriesData } | { options?: IBubbleRenderableSeriesOptions; type: BubbleSeries; xyzData?: TXyzSeriesData } | { options?: IColumnRenderableSeriesOptions; type: ColumnSeries; xyData?: TXySeriesData } | { ohlcData?: TOhlcSeriesData; options?: ICandlestickRenderableSeriesOptions; type: CandlestickSeries } | { options?: IFastLineRenderableSeriesOptions; type: LineSeries; xyData?: TXySeriesData } | { options?: IMountainRenderableSeriesOptions; type: MountainSeries; xyData?: TXySeriesData } | { ohlcData?: TOhlcSeriesData; options?: IOhlcRenderableSeriesOptions; type: OhlcSeries } | { options?: IXyScatterRenderableSeriesOptions; type: ScatterSeries; xyData?: TXySeriesData } | { options?: ISplineBandRenderableSeriesOptions; type: SplineBandSeries; xyyData?: TXyySeriesData } | { options?: ISplineLineRenderableSeriesOptions; type: SplineLineSeries; xyData?: TXySeriesData } | { options?: ISplineMountainRenderableSeriesOptions; type: SplineMountainSeries; xyData?: TXySeriesData } | { heatmapData?: IUniformHeatmapSeriesOptions; options?: IHeatmapRenderableSeriesOptions; type: UniformHeatmapSeries } | { heatmapData?: IUniformHeatmapSeriesOptions; options?: IContoursRenderableSeriesOptions; type: UniformContoursSeries } | { options?: IStackedColumnRenderableSeriesOptions; type: StackedColumnSeries; xyData?: TXySeriesData } | { options?: IStackedMountainRenderableSeriesOptions; type: StackedMountainSeries; xyData?: TXySeriesData } | { options?: IStackedColumnCollectionOptions; series?: TSeriesDefinition[]; type: StackedColumnCollection } | { options?: IBaseStackedCollectionOptions; series?: TSeriesDefinition[]; type: StackedMountainCollection }

Definition of a renderable series, comprising a ESeriesType, the relevant options, and an optional data object whose type depends on the series type

TSeriesHoverChangedCallback

TSeriesHoverChangedCallback: (sourceSeries: IRenderableSeries, isHovered: boolean) => void

The type of the callback

Type declaration

TSeriesSelectionChangedCallback

TSeriesSelectionChangedCallback: (sourceSeries: IRenderableSeries, isSelected: boolean) => void

The type of the callback

Type declaration

TSharedDataDefinition

TSharedDataDefinition: Record<number | string, number[]>

Shared data that can be used in ISciChart2DDefinition or directly in chartBuilder.buildSeries or chartBuilder.buildDataSeries

TSurfaceDefinition

TSurfaceDefinition: ISciChart2DDefinition | { options?: ISciChart2DDefinition; type?: Default2D } | { options?: ISciChartPieDefinition; type?: Pie2D }

TTextStyle

TTextStyle: { alignment?: ELabelAlignment; color?: string; fontFamily?: string; fontSize?: number; fontStyle?: string; fontWeight?: string; padding?: Thickness }

A type class to contain information about Axis Label text styles

remarks
  • Set the fontFamily as a string to set the font
  • Set the fontSize as you would in HTML/CSS
  • Set the fontWeight and fontStyle as you would in HTML/CSS
  • Set the color as an HTML Color code to define the color

Type declaration

  • Optional alignment?: ELabelAlignment
  • Optional color?: string
  • Optional fontFamily?: string
  • Optional fontSize?: number
  • Optional fontStyle?: string
  • Optional fontWeight?: string
  • Optional padding?: Thickness

    Padding is left 4, right 4, top 4, bottom 0 by default. This is because there is natural space below the text baseline. If you are using text labels rather than just numbers, you may want to increase the bottom padding.

TTickLineStyle

TTickLineStyle: { color?: string; strokeThickness?: number; tickSize?: number }

A type class to contain information about Tick line styles

remarks

A tick line is the small 3 pixel line outside the axis.

  • Set the tickSize to define the size of this tick in pixels.
  • Set the color as an HTML Color code to define the color
  • Set the strokeThickness to change the thickness of the tick line

Type declaration

  • Optional color?: string
  • Optional strokeThickness?: number
  • Optional tickSize?: number

TTickObject

TTickObject: { majorTickCoords: number[]; majorTickLabels: string[]; majorTicks: number[]; minorTickCoords: number[]; minorTicks: number[] }

A type which contains info about major, minor tick coordinates, labels and values. Used when drawing the axis gridlines

Type declaration

  • majorTickCoords: number[]

    The major tick coordinates

  • majorTickLabels: string[]

    The major tick label strings

  • majorTicks: number[]

    The major tick numeric values

  • minorTickCoords: number[]

    The minor tick coordinates

  • minorTicks: number[]

    The minor tick numeric values

TWebAssemblyChart

TWebAssemblyChart: { sciChartSurface: SciChartSurface; wasmContext: TSciChart }

Type declaration

TWebAssemblyChart3D

TWebAssemblyChart3D: { sciChart3DSurface: SciChart3DSurface; wasmContext: TSciChart3D }

Type declaration

TXySeriesData

TXySeriesData: { xDataId?: number | string; yDataId?: number | string } & IXyDataSeriesOptions & { filter?: TFilterDefinition }

Definition of XY data

TXyySeriesData

TXyySeriesData: { xDataId?: number | string; y1DataId?: number | string; yDataId?: number | string } & IXyyDataSeriesOptions & { filter?: TFilterDefinition }

Definition of XYY data

TXyzSeriesData

TXyzSeriesData: { xDataId?: number | string; yDataId?: number | string; zDataId?: number | string } & IXyzDataSeriesOptions & { filter?: TFilterDefinition }

Definition of XYZ data

TZoomExtentsCallback

TZoomExtentsCallback: (sciChartSurface: SciChartSurface) => boolean

A function to execute when zoomExtents is activated. If this exists and returns false, the builtin behaviour is ignored;

Type declaration

TfilterFunction

TfilterFunction: (index: number, y: number) => number

Type declaration

    • (index: number, y: number): number
    • Parameters

      • index: number
      • y: number

      Returns number

Variables

Const DebugForDpi

DebugForDpi: boolean = false

Const FIFTY_DAYS

FIFTY_DAYS: number = 60 * 60 * 24 * 50

Const FIVE_DAYS

FIVE_DAYS: number = 60 * 60 * 24 * 5

Const MIN_SERIES_AREA_SIZE

MIN_SERIES_AREA_SIZE: 10 = 10

Const buildStamp

buildStamp: "2021-11-18T00:00:00" = "2021-11-18T00:00:00"

Const canvas

canvas: any = new OffscreenCanvas(DEFAULT_WIDTH, DEFAULT_HEIGHT)

Const constructorMap

constructorMap: Map<string, { func: Function; wasm?: boolean }> = new Map<string,{ wasm?: boolean; func: Function }>()

Const ctx

ctx: OffscreenCanvasRenderingContext2D = canvas.getContext("2d")

Const defaultSelectionAnnotationSvgString

defaultSelectionAnnotationSvgString: "<svg width="50" height="50" preserveAspectRatio="none" xmlns="http://www.w3.org/2000/svg"><rect width="100%" height="100%" style="fill:transparent"></rect></svg>" = `<svg width="50" height="50" preserveAspectRatio="none" xmlns="http://www.w3.org/2000/svg"><rect width="100%" height="100%" style="fill:transparent"></rect></svg>`

Const defaultUnSelectedAnnotationSvgString

defaultUnSelectedAnnotationSvgString: "<svg width="50" height="50" preserveAspectRatio="none" xmlns="http://www.w3.org/2000/svg"><rect width="100%" height="100%" style="fill:black"></rect></svg>" = `<svg width="50" height="50" preserveAspectRatio="none" xmlns="http://www.w3.org/2000/svg"><rect width="100%" height="100%" style="fill:black"></rect></svg>`

Let globalMsgId

globalMsgId: number = 0

Const labelCacheByTextAndStyle

labelCacheByTextAndStyle: Map<string, LabelInfo> = new Map<string, LabelInfo>()

Let lastStyleId

lastStyleId: number = 0

Let lastUsed

lastUsed: number = 0

Const libraryVersion

libraryVersion: "2.0.2191" = "2.0.2191"

Const loaderCss

loaderCss: ".scichart_loader {display: inline-block;position: relative;width: 80px;height: 80px;top: 50%;transform: translateY(-50%);}.scichart_loader div {animation: scichart_loader 1.2s cubic-bezier(0.5, 0, 0.5, 1) infinite;transform-origin: 40px 40px;}.scichart_loader div span {display: block;position: absolute;width: 7px;height: 7px;border-radius: 50%;margin: -4px 0 0 -4px;}.scichart_loader div:nth-child(1) {animation-delay: -0.036s;}.scichart_loader div:nth-child(1) span {top: 63px;left: 63px;}.scichart_loader div:nth-child(2) {animation-delay: -0.072s;}.scichart_loader div:nth-child(2) span {top: 68px;left: 56px;}.scichart_loader div:nth-child(3) {animation-delay: -0.108s;}.scichart_loader div:nth-child(3) span {top: 71px;left: 48px;}.scichart_loader div:nth-child(4) {animation-delay: -0.144s;}.scichart_loader div:nth-child(4) span {top: 72px;left: 40px;}.scichart_loader div:nth-child(5) {animation-delay: -0.18s;}.scichart_loader div:nth-child(5) span {top: 71px;left: 32px;}.scichart_loader div:nth-child(6) {animation-delay: -0.216s;}.scichart_loader div:nth-child(6) span {top: 68px;left: 24px;}.scichart_loader div:nth-child(7) {animation-delay: -0.252s;}.scichart_loader div:nth-child(7) span {top: 63px;left: 17px;}.scichart_loader div:nth-child(8) {animation-delay: -0.288s;}.scichart_loader div:nth-child(8) span {top: 56px;left: 12px;}@keyframes scichart_loader {0% {transform: rotate(0deg);}100% {transform: rotate(360deg);}}" = `.scichart_loader {display: inline-block;position: relative;width: 80px;height: 80px;top: 50%;transform: translateY(-50%);}.scichart_loader div {animation: scichart_loader 1.2s cubic-bezier(0.5, 0, 0.5, 1) infinite;transform-origin: 40px 40px;}.scichart_loader div span {display: block;position: absolute;width: 7px;height: 7px;border-radius: 50%;margin: -4px 0 0 -4px;}.scichart_loader div:nth-child(1) {animation-delay: -0.036s;}.scichart_loader div:nth-child(1) span {top: 63px;left: 63px;}.scichart_loader div:nth-child(2) {animation-delay: -0.072s;}.scichart_loader div:nth-child(2) span {top: 68px;left: 56px;}.scichart_loader div:nth-child(3) {animation-delay: -0.108s;}.scichart_loader div:nth-child(3) span {top: 71px;left: 48px;}.scichart_loader div:nth-child(4) {animation-delay: -0.144s;}.scichart_loader div:nth-child(4) span {top: 72px;left: 40px;}.scichart_loader div:nth-child(5) {animation-delay: -0.18s;}.scichart_loader div:nth-child(5) span {top: 71px;left: 32px;}.scichart_loader div:nth-child(6) {animation-delay: -0.216s;}.scichart_loader div:nth-child(6) span {top: 68px;left: 24px;}.scichart_loader div:nth-child(7) {animation-delay: -0.252s;}.scichart_loader div:nth-child(7) span {top: 63px;left: 17px;}.scichart_loader div:nth-child(8) {animation-delay: -0.288s;}.scichart_loader div:nth-child(8) span {top: 56px;left: 12px;}@keyframes scichart_loader {0% {transform: rotate(0deg);}100% {transform: rotate(360deg);}}`

Let maxSize

maxSize: number = 100

Let minAge

minAge: number = 1000 * 60

Const rejects

rejects: Record<number, (reason: any) => void>

Const resolves

resolves: Record<number, (value: unknown) => void>

Let result

result: boolean

Const sciChartConfig

sciChartConfig: TSciChartConfig

Const sciChartConfig3D

sciChartConfig3D: TSciChartConfig

Const sciChartSingleDestinations

sciChartSingleDestinations: TSciChartDestination[] = []

Const styleCache

styleCache: Record<string, { style: TCachedLabelStyle; uses: number }>

Const superScript_map

superScript_map: string[] = ['\u2070','\u00B9','\u00B2','\u00B3','\u2074','\u2075','\u2076','\u2077','\u2078','\u2079']

Const t

t: TextureWorkerWrapper = textureWorker

Const textureWorker

textureWorker: TextureWorkerWrapper = new TextureWorkerWrapper()

Functions

animateAny

  • animateAny<T>(durationMs: number, from: T, to: T, onAnimate: (intermediateValue: T) => void, interpolate: (start: T, end: T, interpolationFactor: number) => T, onCompleted: () => void, easingFn: TEasingFn): AnimationToken
  • deprecated

    Instead create an GenericAnimation and pass it to sciChartSurface.addAnimation

    Type parameters

    • T

    Parameters

    • durationMs: number
    • from: T
    • to: T
    • onAnimate: (intermediateValue: T) => void
        • (intermediateValue: T): void
        • Parameters

          • intermediateValue: T

          Returns void

    • interpolate: (start: T, end: T, interpolationFactor: number) => T
        • (start: T, end: T, interpolationFactor: number): T
        • Parameters

          • start: T
          • end: T
          • interpolationFactor: number

          Returns T

    • onCompleted: () => void
        • (): void
        • Returns void

    • easingFn: TEasingFn

    Returns AnimationToken

Const animationUpdate

Const areArraysEqual

  • areArraysEqual(leftArray: number[], rightArray: number[]): boolean
  • Parameters

    • leftArray: number[]
    • rightArray: number[]

    Returns boolean

arrayRemove

  • arrayRemove<T>(array: T[], item: T): T[]
  • Type parameters

    • T

    Parameters

    • array: T[]
    • item: T

    Returns T[]

Const build2DChart

  • build2DChart(divElementId: string, definition: ISciChart2DDefinition | string): Promise<{ sciChartSurface: SciChartSurface; wasmContext: { CategoryCoordinateCalculatorDouble: {}; DoubleRange: {} & {}; DoubleVector: {}; FlippedCategoryCoordinateCalculatorDouble: {}; FlippedLinearCoordinateCalculatorDouble: {}; FlippedLinearCoordinateCalculatorSingle: {}; FlippedLogarithmicCoordinateCalculator: {}; FloatVector: {}; IntVector: {}; LinearCoordinateCalculatorDouble: {}; LinearCoordinateCalculatorSingle: {}; LogarithmicCoordinateCalculator: {}; NiceDoubleScale: { CalculateTickSpacing: (min: number, max: number, minorsPerMajor: number, maxTicks: number) => DoubleRange; NiceNum: (range: number, round: boolean) => number }; NiceLogScale: { CalculateTickSpacing: (min: number, max: number, logBase: number, minorsPerMajor: number, maxTicks: number) => DoubleRange }; NumberUtil: { Constrain: (value: number, lowerBound: number, upperBound: number) => number; FindIndex: (inputValues: DoubleVector, value: number, searchMode: SCRTFindIndexSearchMode, dataIsSortedAscending: boolean) => number; IsDivisibleBy: (value: number, divisor: number) => boolean; IsPowerOf: (value: number, power: number, logBase: number) => boolean; LinearInterpolateI: (from: number, to: number, ratio: number) => number; Log: (value: number, logBase: number) => number; MinMax: (inputValues: DoubleVector) => DoubleRange; MinMaxWithIndex: (inputValues: DoubleVector, startIndex: number, count: number) => DoubleRange; RoundDown: (value: number, nearest: number) => number; RoundDownPower: (value: number, power: number, logBase: number) => number; RoundToDigits: (value: number, decimals: number) => number; RoundUp: (value: number, nearest: number) => number; RoundUpPower: (value: number, power: number, logBase: number) => number }; SCRTAnimationHelperFade: (yValues: DoubleVector, progress: number, ysValues: DoubleVector) => number; SCRTAnimationHelperScale: (yValues: DoubleVector, zeroLine: number, progress: number, ysValues: DoubleVector) => number; SCRTAnimationHelperSweep: (yValues: DoubleVector, progress: number, ysValues: DoubleVector) => number; SCRTAnimationHelperWave: (yValues: DoubleVector, durationFraction: number, zeroLine: number, progress: number, ysValues: DoubleVector) => number; SCRTBandDrawingParams: {}; SCRTBandSeriesDrawingProvider: {}; SCRTBrush: {}; SCRTBubbleSeriesDrawingProvider: {}; SCRTCandleType: { CandleStick: SCRTCandleType; OHLC: SCRTCandleType }; SCRTCandlestickSeriesDrawingProvider: {}; SCRTColorVertex: {} & {}; SCRTColumnDrawingParams: {}; SCRTColumnSeriesDrawingProvider: {}; SCRTColumnVertex: {}; SCRTContourParams: {}; SCRTCopyToDestinationInterface: { implement: (wrapper: SCRTCopyToDestinationInterfaceWrapper) => SCRTCopyToDestinationInterface }; SCRTCreateBitmapTexture: (width: number, height: number, textureFormat: eTSRTextureFormat) => TSRTexture; SCRTCreateDahedPen: (color: number, thickness: number, antialiased: boolean, dashPattern: FloatVector) => SCRTPen; SCRTCreatePalette: (colors: IntVector) => SCRTPalette; SCRTCredentials: { ApplyLicenseResponse: (response: string) => number; Dump: () => string; GetAllowDebugging: () => boolean; GetBuildStamp: () => string; GetEncrypted: (stringToEncrypt: string) => string; GetExpiryDate: () => string; GetLicenseChallenge: () => string; GetLicenseDaysRemaining: () => number; GetLicenseErrors: () => string; GetLicenseType: () => SCRTLicenseType; GetOrderId: () => string; HasFeature: (feature: string) => SCRTLicenseType; Hash256Encode64: (stringToHash: string) => string; MergeRuntimeLicenseKeyW: (licenseKey: string) => boolean; RequiresValidation: () => boolean; ResetRuntimeLicense: () => void; SetRuntimeLicenseKeyW: (licenseKey: string) => boolean }; SCRTDoLeakCheck: () => void; SCRTDoubleArrayOperations: {}; SCRTFillTextureAbgr: (texture: TSRTexture, width: number, height: number, pixels: IntVector) => void; SCRTFillTextureFloat32: (texture: TSRTexture, width: number, height: number, pixels: FloatVector) => TSRVector4; SCRTFindIndexSearchMode: { Exact: SCRTFindIndexSearchMode; Nearest: SCRTFindIndexSearchMode; RoundDown: SCRTFindIndexSearchMode; RoundUp: SCRTFindIndexSearchMode }; SCRTGetGlobalSampleChartInterface: () => SCRTSampleChartInterface; SCRTGetMainRenderContext2D: () => SCRTRenderContext; SCRTGetScreenHeight: () => number; SCRTGetScreenWidth: () => number; SCRTGlowEffect: {}; SCRTInitEngine2D: () => void; SCRTLicenseType: { LICENSE_TYPE_FULL: SCRTLicenseType; LICENSE_TYPE_FULL_EXPIRED: SCRTLicenseType; LICENSE_TYPE_INVALID_DEVELOPER_LICENSE: SCRTLicenseType; LICENSE_TYPE_INVALID_LICENSE: SCRTLicenseType; LICENSE_TYPE_NO_LICENSE: SCRTLicenseType; LICENSE_TYPE_REQUIRES_VALIDATION: SCRTLicenseType; LICENSE_TYPE_SUBSCRIPTION_EXPIRED: SCRTLicenseType; LICENSE_TYPE_TRIAL: SCRTLicenseType; LICENSE_TYPE_TRIAL_EXPIRED: SCRTLicenseType }; SCRTLineDrawingParams: {}; SCRTLineGapMode: { CloseGaps: SCRTLineGapMode; Default: SCRTLineGapMode; DrawGaps: SCRTLineGapMode }; SCRTLineSeriesDrawingProvider: {}; SCRTLineType: { Digital: SCRTLineType; List: SCRTLineType; Nan: SCRTLineType; Strip: SCRTLineType }; SCRTMountainDrawingParams: {}; SCRTMountainSeriesDrawingProvider: {}; SCRTOhlcDrawingParams: {}; SCRTPalette: {} & { GetNoOverrideColorCode: () => number }; SCRTPen: {}; SCRTPointDrawingParams: {}; SCRTRectVertex: {} & {}; SCRTSampleChartInterface: { implement: (wrapper: SCRTSampleChartInterfaceWrapper) => SCRTSampleChartInterface }; SCRTScatterSeriesDrawingProvider: {}; SCRTSeriesEffectType: { Glow: SCRTSeriesEffectType }; SCRTSetActiveDoubleVector: (SCRTSetActiveDoubleVector: DoubleVector, doubleVector: number) => void; SCRTSetActiveTexture: (texture: TSRTexture) => void; SCRTSetClearAlphaParams: (enabled: boolean, alpha: number) => void; SCRTSetGlobalCopyToDestinationInterface: (param0: SCRTCopyToDestinationInterface) => void; SCRTSetGlobalSampleChartInterface: (param0: SCRTSampleChartInterface) => void; SCRTSetTextureLinearSamplerEnabled: (texture: TSRTexture, enabled: boolean) => void; SCRTSetWaterMarkProperties: (properties: SCRTWaterMarkProperties) => void; SCRTShadowEffect: {}; SCRTShutdownEngine2D: () => void; SCRTSolidBrush: {}; SCRTSplineHelperCubicSpline: (xValues: DoubleVector, yValues: DoubleVector, xsValues: DoubleVector, ysValues: DoubleVector, initialSize: number, interpolationPoints: number, containsNAN: boolean) => void; SCRTSpriteType: { FixedSize: SCRTSpriteType; Normal: SCRTSpriteType }; SCRTStackedColumnDrawingParams: {}; SCRTStackedColumnSeriesDrawingProvider: {}; SCRTSurfaceDestination: { implement: (wrapper: SCRTSurfaceDestinationWrapper) => SCRTSurfaceDestination }; SCRTTextureBrush: {}; SCRTWaterMarkProperties: {}; StringVector: {}; TSRCamera: {}; TSRRequestCanvasDraw: (canvasID: string) => void; TSRRequestDraw: () => void; TSRRequestExit: () => void; TSRSetDrawRequestsEnabled: (enabled: boolean) => void; TSRSetMainWindowSize: (width: number, height: number) => void; TSRVector2: {} & {}; TSRVector3: {} & {}; TSRVector4: {} & {}; UIntVector: {}; VectorColorVertex: {}; VectorColumnVertex: {}; VectorRectVertex: {}; WStringVector: {}; canvas: HTMLCanvasElement; canvas2D: HTMLCanvasElement; eSCRTBlendMode: { BlendAdditiveAlpha: eSCRTBlendMode; BlendAdditiveColor: eSCRTBlendMode; BlendAdditiveOneAlpha: eSCRTBlendMode; BlendDefault: eSCRTBlendMode; BlendDisabled: eSCRTBlendMode }; eSCRTBrushMappingMode: { PerPrimitive: eSCRTBrushMappingMode; PerScreen: eSCRTBrushMappingMode }; eTSRCameraProjectionMode: { CAMERA_PROJECTIONMODE_ORTHOGONAL: eTSRCameraProjectionMode; CAMERA_PROJECTIONMODE_PERSPECTIVE: eTSRCameraProjectionMode }; eTSRMetaDataType: { BitFlags: eTSRMetaDataType; Core: eTSRMetaDataType; Defined: eTSRMetaDataType; DynamicDefined: eTSRMetaDataType; Enum: eTSRMetaDataType; Unknown: eTSRMetaDataType }; eTSRPlatform: { Android: eTSRPlatform; Linux: eTSRPlatform; Mac: eTSRPlatform; Web: eTSRPlatform; Windows: eTSRPlatform; iOS: eTSRPlatform }; eTSRRendererType: { TSR_RENDERER_TYPE_D3D11: eTSRRendererType; TSR_RENDERER_TYPE_D3D11_LEVEL10: eTSRRendererType; TSR_RENDERER_TYPE_D3D12: eTSRRendererType; TSR_RENDERER_TYPE_D3D9: eTSRRendererType; TSR_RENDERER_TYPE_GL: eTSRRendererType; TSR_RENDERER_TYPE_GLES2: eTSRRendererType; TSR_RENDERER_TYPE_GLES3: eTSRRendererType; TSR_RENDERER_TYPE_METAL: eTSRRendererType; TSR_RENDERER_TYPE_UNDEFINED: eTSRRendererType; TSR_RENDERER_TYPE_VULKAN: eTSRRendererType }; eTSRTextureFormat: { TSR_TEXTUREFORMAT_A8B8G8R8: eTSRTextureFormat; TSR_TEXTUREFORMAT_R32F: eTSRTextureFormat }; eVariableUsage: { Array: eVariableUsage; Blob: eVariableUsage; DynamicArray: eVariableUsage; Normal: eVariableUsage; Pointer: eVariableUsage; Vector: eVariableUsage; VectorOfPointers: eVariableUsage } } }>
  • Construct a chart with SciChartSurface using a ISciChart2DDefinition which can be pure data.

    remarks

    This method is async and must be awaited

    Parameters

    Returns Promise<{ sciChartSurface: SciChartSurface; wasmContext: { CategoryCoordinateCalculatorDouble: {}; DoubleRange: {} & {}; DoubleVector: {}; FlippedCategoryCoordinateCalculatorDouble: {}; FlippedLinearCoordinateCalculatorDouble: {}; FlippedLinearCoordinateCalculatorSingle: {}; FlippedLogarithmicCoordinateCalculator: {}; FloatVector: {}; IntVector: {}; LinearCoordinateCalculatorDouble: {}; LinearCoordinateCalculatorSingle: {}; LogarithmicCoordinateCalculator: {}; NiceDoubleScale: { CalculateTickSpacing: (min: number, max: number, minorsPerMajor: number, maxTicks: number) => DoubleRange; NiceNum: (range: number, round: boolean) => number }; NiceLogScale: { CalculateTickSpacing: (min: number, max: number, logBase: number, minorsPerMajor: number, maxTicks: number) => DoubleRange }; NumberUtil: { Constrain: (value: number, lowerBound: number, upperBound: number) => number; FindIndex: (inputValues: DoubleVector, value: number, searchMode: SCRTFindIndexSearchMode, dataIsSortedAscending: boolean) => number; IsDivisibleBy: (value: number, divisor: number) => boolean; IsPowerOf: (value: number, power: number, logBase: number) => boolean; LinearInterpolateI: (from: number, to: number, ratio: number) => number; Log: (value: number, logBase: number) => number; MinMax: (inputValues: DoubleVector) => DoubleRange; MinMaxWithIndex: (inputValues: DoubleVector, startIndex: number, count: number) => DoubleRange; RoundDown: (value: number, nearest: number) => number; RoundDownPower: (value: number, power: number, logBase: number) => number; RoundToDigits: (value: number, decimals: number) => number; RoundUp: (value: number, nearest: number) => number; RoundUpPower: (value: number, power: number, logBase: number) => number }; SCRTAnimationHelperFade: (yValues: DoubleVector, progress: number, ysValues: DoubleVector) => number; SCRTAnimationHelperScale: (yValues: DoubleVector, zeroLine: number, progress: number, ysValues: DoubleVector) => number; SCRTAnimationHelperSweep: (yValues: DoubleVector, progress: number, ysValues: DoubleVector) => number; SCRTAnimationHelperWave: (yValues: DoubleVector, durationFraction: number, zeroLine: number, progress: number, ysValues: DoubleVector) => number; SCRTBandDrawingParams: {}; SCRTBandSeriesDrawingProvider: {}; SCRTBrush: {}; SCRTBubbleSeriesDrawingProvider: {}; SCRTCandleType: { CandleStick: SCRTCandleType; OHLC: SCRTCandleType }; SCRTCandlestickSeriesDrawingProvider: {}; SCRTColorVertex: {} & {}; SCRTColumnDrawingParams: {}; SCRTColumnSeriesDrawingProvider: {}; SCRTColumnVertex: {}; SCRTContourParams: {}; SCRTCopyToDestinationInterface: { implement: (wrapper: SCRTCopyToDestinationInterfaceWrapper) => SCRTCopyToDestinationInterface }; SCRTCreateBitmapTexture: (width: number, height: number, textureFormat: eTSRTextureFormat) => TSRTexture; SCRTCreateDahedPen: (color: number, thickness: number, antialiased: boolean, dashPattern: FloatVector) => SCRTPen; SCRTCreatePalette: (colors: IntVector) => SCRTPalette; SCRTCredentials: { ApplyLicenseResponse: (response: string) => number; Dump: () => string; GetAllowDebugging: () => boolean; GetBuildStamp: () => string; GetEncrypted: (stringToEncrypt: string) => string; GetExpiryDate: () => string; GetLicenseChallenge: () => string; GetLicenseDaysRemaining: () => number; GetLicenseErrors: () => string; GetLicenseType: () => SCRTLicenseType; GetOrderId: () => string; HasFeature: (feature: string) => SCRTLicenseType; Hash256Encode64: (stringToHash: string) => string; MergeRuntimeLicenseKeyW: (licenseKey: string) => boolean; RequiresValidation: () => boolean; ResetRuntimeLicense: () => void; SetRuntimeLicenseKeyW: (licenseKey: string) => boolean }; SCRTDoLeakCheck: () => void; SCRTDoubleArrayOperations: {}; SCRTFillTextureAbgr: (texture: TSRTexture, width: number, height: number, pixels: IntVector) => void; SCRTFillTextureFloat32: (texture: TSRTexture, width: number, height: number, pixels: FloatVector) => TSRVector4; SCRTFindIndexSearchMode: { Exact: SCRTFindIndexSearchMode; Nearest: SCRTFindIndexSearchMode; RoundDown: SCRTFindIndexSearchMode; RoundUp: SCRTFindIndexSearchMode }; SCRTGetGlobalSampleChartInterface: () => SCRTSampleChartInterface; SCRTGetMainRenderContext2D: () => SCRTRenderContext; SCRTGetScreenHeight: () => number; SCRTGetScreenWidth: () => number; SCRTGlowEffect: {}; SCRTInitEngine2D: () => void; SCRTLicenseType: { LICENSE_TYPE_FULL: SCRTLicenseType; LICENSE_TYPE_FULL_EXPIRED: SCRTLicenseType; LICENSE_TYPE_INVALID_DEVELOPER_LICENSE: SCRTLicenseType; LICENSE_TYPE_INVALID_LICENSE: SCRTLicenseType; LICENSE_TYPE_NO_LICENSE: SCRTLicenseType; LICENSE_TYPE_REQUIRES_VALIDATION: SCRTLicenseType; LICENSE_TYPE_SUBSCRIPTION_EXPIRED: SCRTLicenseType; LICENSE_TYPE_TRIAL: SCRTLicenseType; LICENSE_TYPE_TRIAL_EXPIRED: SCRTLicenseType }; SCRTLineDrawingParams: {}; SCRTLineGapMode: { CloseGaps: SCRTLineGapMode; Default: SCRTLineGapMode; DrawGaps: SCRTLineGapMode }; SCRTLineSeriesDrawingProvider: {}; SCRTLineType: { Digital: SCRTLineType; List: SCRTLineType; Nan: SCRTLineType; Strip: SCRTLineType }; SCRTMountainDrawingParams: {}; SCRTMountainSeriesDrawingProvider: {}; SCRTOhlcDrawingParams: {}; SCRTPalette: {} & { GetNoOverrideColorCode: () => number }; SCRTPen: {}; SCRTPointDrawingParams: {}; SCRTRectVertex: {} & {}; SCRTSampleChartInterface: { implement: (wrapper: SCRTSampleChartInterfaceWrapper) => SCRTSampleChartInterface }; SCRTScatterSeriesDrawingProvider: {}; SCRTSeriesEffectType: { Glow: SCRTSeriesEffectType }; SCRTSetActiveDoubleVector: (SCRTSetActiveDoubleVector: DoubleVector, doubleVector: number) => void; SCRTSetActiveTexture: (texture: TSRTexture) => void; SCRTSetClearAlphaParams: (enabled: boolean, alpha: number) => void; SCRTSetGlobalCopyToDestinationInterface: (param0: SCRTCopyToDestinationInterface) => void; SCRTSetGlobalSampleChartInterface: (param0: SCRTSampleChartInterface) => void; SCRTSetTextureLinearSamplerEnabled: (texture: TSRTexture, enabled: boolean) => void; SCRTSetWaterMarkProperties: (properties: SCRTWaterMarkProperties) => void; SCRTShadowEffect: {}; SCRTShutdownEngine2D: () => void; SCRTSolidBrush: {}; SCRTSplineHelperCubicSpline: (xValues: DoubleVector, yValues: DoubleVector, xsValues: DoubleVector, ysValues: DoubleVector, initialSize: number, interpolationPoints: number, containsNAN: boolean) => void; SCRTSpriteType: { FixedSize: SCRTSpriteType; Normal: SCRTSpriteType }; SCRTStackedColumnDrawingParams: {}; SCRTStackedColumnSeriesDrawingProvider: {}; SCRTSurfaceDestination: { implement: (wrapper: SCRTSurfaceDestinationWrapper) => SCRTSurfaceDestination }; SCRTTextureBrush: {}; SCRTWaterMarkProperties: {}; StringVector: {}; TSRCamera: {}; TSRRequestCanvasDraw: (canvasID: string) => void; TSRRequestDraw: () => void; TSRRequestExit: () => void; TSRSetDrawRequestsEnabled: (enabled: boolean) => void; TSRSetMainWindowSize: (width: number, height: number) => void; TSRVector2: {} & {}; TSRVector3: {} & {}; TSRVector4: {} & {}; UIntVector: {}; VectorColorVertex: {}; VectorColumnVertex: {}; VectorRectVertex: {}; WStringVector: {}; canvas: HTMLCanvasElement; canvas2D: HTMLCanvasElement; eSCRTBlendMode: { BlendAdditiveAlpha: eSCRTBlendMode; BlendAdditiveColor: eSCRTBlendMode; BlendAdditiveOneAlpha: eSCRTBlendMode; BlendDefault: eSCRTBlendMode; BlendDisabled: eSCRTBlendMode }; eSCRTBrushMappingMode: { PerPrimitive: eSCRTBrushMappingMode; PerScreen: eSCRTBrushMappingMode }; eTSRCameraProjectionMode: { CAMERA_PROJECTIONMODE_ORTHOGONAL: eTSRCameraProjectionMode; CAMERA_PROJECTIONMODE_PERSPECTIVE: eTSRCameraProjectionMode }; eTSRMetaDataType: { BitFlags: eTSRMetaDataType; Core: eTSRMetaDataType; Defined: eTSRMetaDataType; DynamicDefined: eTSRMetaDataType; Enum: eTSRMetaDataType; Unknown: eTSRMetaDataType }; eTSRPlatform: { Android: eTSRPlatform; Linux: eTSRPlatform; Mac: eTSRPlatform; Web: eTSRPlatform; Windows: eTSRPlatform; iOS: eTSRPlatform }; eTSRRendererType: { TSR_RENDERER_TYPE_D3D11: eTSRRendererType; TSR_RENDERER_TYPE_D3D11_LEVEL10: eTSRRendererType; TSR_RENDERER_TYPE_D3D12: eTSRRendererType; TSR_RENDERER_TYPE_D3D9: eTSRRendererType; TSR_RENDERER_TYPE_GL: eTSRRendererType; TSR_RENDERER_TYPE_GLES2: eTSRRendererType; TSR_RENDERER_TYPE_GLES3: eTSRRendererType; TSR_RENDERER_TYPE_METAL: eTSRRendererType; TSR_RENDERER_TYPE_UNDEFINED: eTSRRendererType; TSR_RENDERER_TYPE_VULKAN: eTSRRendererType }; eTSRTextureFormat: { TSR_TEXTUREFORMAT_A8B8G8R8: eTSRTextureFormat; TSR_TEXTUREFORMAT_R32F: eTSRTextureFormat }; eVariableUsage: { Array: eVariableUsage; Blob: eVariableUsage; DynamicArray: eVariableUsage; Normal: eVariableUsage; Pointer: eVariableUsage; Vector: eVariableUsage; VectorOfPointers: eVariableUsage } } }>

Const buildAnnotations

Const buildAxes

  • Build one or more axes from a definition that can be pure data.

    Parameters

    Returns AxisBase2D[]

    An array of AxisBase2D.

Const buildAxis

Const buildChart

Const buildDataSeries

  • Build a data series from a definition that can be pure data.

    Parameters

    • wasmContext: TSciChart

      A {@link TSciChart | SciChart 2D WebAssembly Context} or {@link TSciChart | SciChart 3D WebAssembly Context}

    • seriesDefinition: TSeriesDefinition
    • Optional sharedData: TSharedDataDefinition

      Optional TSharedDataDefinition to define shared data which can be referenced by the data series

    Returns IDataSeries

    An IDataSeries

Const buildFilter

Const buildModifier

Const buildModifiers

Const buildPieChart

Const buildSeries

Const calcAnnotationBordersForAxisMarker

  • calcAnnotationBordersForAxisMarker(isVerticalChart: boolean, x1: number, y1: number, horizontalAxis: AxisBase2D, verticalAxis: AxisBase2D, textureWidth: number, viewRect: Rect, xPosition: number, yPosition: number, textureHeight: number, annotationMarginXDirection: number, annotationMarginYDirection: number, isHorizontalAxisAlignmentReversed: boolean, isVerticalAxisAlignmentReversed: boolean): { x1: number; x2: number; y1: number; y2: number }
  • Calculates annotation borders for AxisMarkerAnnotation

    Parameters

    • isVerticalChart: boolean

      the vertical chart flag

    • x1: number

      the X1 data value of the annotation

    • y1: number

      the Y1 data value of the annotation

    • horizontalAxis: AxisBase2D

      the horizontal axis

    • verticalAxis: AxisBase2D

      the vertical axis

    • textureWidth: number

      the texture width

    • viewRect: Rect

      the seriesViewRect

    • xPosition: number

      the X position of the texture on the SciChartSurface, the left-top corner position on the canvas

    • yPosition: number

      the Y position of the texture on the SciChartSurface, the left-top corner position on the canvas

    • textureHeight: number

      the texture width

    • annotationMarginXDirection: number

      the texture margin in X direction

    • annotationMarginYDirection: number

      the texture margin in Y direction

    • isHorizontalAxisAlignmentReversed: boolean

      if true EAxisAlignment.Top, otherwise EAxisAlignment.Bottom

    • isVerticalAxisAlignmentReversed: boolean

      if true EAxisAlignment.Left, otherwise EAxisAlignment.Right

    Returns { x1: number; x2: number; y1: number; y2: number }

    • x1: number
    • x2: number
    • y1: number
    • y2: number

Const calcAverageForArray

  • calcAverageForArray(ar: number[], averageNum: number, index?: number): number
  • Parameters

    • ar: number[]
    • averageNum: number
    • Optional index: number

    Returns number

Const calcAverageForDoubleVector

  • calcAverageForDoubleVector(doubleVector: DoubleVector, averageNum: number, index?: number): number
  • description

    Calculates average for DoubleVector

    Parameters

    • doubleVector: DoubleVector
    • averageNum: number

      number of values to respect for the average

    • Optional index: number

      index of the latest value to include, by default equals to length-1 of DoubleVector

    Returns number

Const calcCrossProduct

  • calcCrossProduct(xA: number, yA: number, xB: number, yB: number, xC: number, yC: number): number
  • Parameters

    • xA: number
    • yA: number
    • xB: number
    • yB: number
    • xC: number
    • yC: number

    Returns number

Const calcDistance

  • calcDistance(x1: number, y1: number, x2: number, y2: number): number
  • Parameters

    • x1: number
    • y1: number
    • x2: number
    • y2: number

    Returns number

Const calcDistanceFromLine

  • calcDistanceFromLine(x: number, y: number, startX: number, startY: number, endX: number, endY: number): number
  • Parameters

    • x: number
    • y: number
    • startX: number
    • startY: number
    • endX: number
    • endY: number

    Returns number

Const calcDistanceFromLineSegment

  • calcDistanceFromLineSegment(x: number, y: number, startX: number, startY: number, endX: number, endY: number): number
  • Parameters

    • x: number
    • y: number
    • startX: number
    • startY: number
    • endX: number
    • endY: number

    Returns number

Const calcDotProduct

  • calcDotProduct(v1x: number, v1y: number, v2x: number, v2y: number, v3x: number, v3y: number): number
  • Parameters

    • v1x: number
    • v1y: number
    • v2x: number
    • v2y: number
    • v3x: number
    • v3y: number

    Returns number

Const calcNewApex

  • calcNewApex(x1: number, y1: number, x2: number, y2: number): { point1: { x: number; y: number }; point2: { x: number; y: number }; point3: { x: number; y: number }; point4: { x: number; y: number } }
  • Parameters

    • x1: number
    • y1: number
    • x2: number
    • y2: number

    Returns { point1: { x: number; y: number }; point2: { x: number; y: number }; point3: { x: number; y: number }; point4: { x: number; y: number } }

    • point1: { x: number; y: number }
      • x: number
      • y: number
    • point2: { x: number; y: number }
      • x: number
      • y: number
    • point3: { x: number; y: number }
      • x: number
      • y: number
    • point4: { x: number; y: number }
      • x: number
      • y: number

Const calculateMaxGroupSize

  • calculateMaxGroupSize(outerLayoutSizes: Record<string, number>): number
  • Parameters

    • outerLayoutSizes: Record<string, number>

    Returns number

chartReviver

  • chartReviver(key: string, value: any): any
  • The reviver function needed when parsing definitions to JSON

    Parameters

    • key: string
    • value: any

    Returns any

Const checkBuildStamp

  • checkBuildStamp(wasmContext: TSciChart | TSciChart3D): boolean
  • Parameters

    • wasmContext: TSciChart | TSciChart3D

    Returns boolean

Const checkCanDraw

  • Checks if can draw, is used not to draw when {@link BaseAnimation} has delay

    Parameters

    Returns boolean

Const checkIsAnimationRunning

  • Checks if the animation is running

    Parameters

    Returns boolean

Const checkStyle

  • Parameters

    Returns boolean

Const checkTextStyleEqual

Const clearCacheByStyle

  • clearCacheByStyle(styleId: string): void
  • Parameters

    • styleId: string

    Returns void

Const convertColor

  • convertColor(htmlColor: string, opacity?: number): string
  • Parameters

    • htmlColor: string
    • Default value opacity: number = 1

    Returns string

    rgbColor, for example "0xff00ff00" - green

Const convertRgbToHexColor

  • convertRgbToHexColor(r: number, g: number, b: number): string
  • Converts individual R,G, and B components to HEX Color

    Parameters

    • r: number
    • g: number
    • b: number

    Returns string

    argbColor, for example "0xff00ff00" - green

Const convertToPixel

  • convertToPixel(red: number, green: number, blue: number, opacity: number): number
  • Parameters

    • red: number

      number value from 0 to 255

    • green: number

      number value from 0 to 255

    • blue: number

      number value from 0 to 255

    • opacity: number

      number value from 0 to 255

    Returns number

    pixel in hex format: opacity, red, green, blue. For example: "0xff0000ff" - blue pixel with no opacity

Const copyToCanvas

  • copyToCanvas(sourceCanvas: HTMLCanvasElement): (Anonymous function)
  • Parameters

    • sourceCanvas: HTMLCanvasElement

    Returns (Anonymous function)

Const copyVector

  • copyVector(sourceVector: DoubleVector, targetVector: DoubleVector): void
  • Parameters

    • sourceVector: DoubleVector
    • targetVector: DoubleVector

    Returns void

countUnique

  • countUnique(iterable: string[]): number
  • Parameters

    • iterable: string[]

    Returns number

Const createBrushInCache

  • createBrushInCache(cache: BrushCache, fill: string, opacity: number, fillGradientLinear?: GradientParams): SCRTBrush
  • Creates a native {@link SCRTBrush} brush from html color code string passed in and caches it

    Parameters

    • cache: BrushCache

      The object that will store a brush

    • fill: string

      The HTML Color code

    • opacity: number

      The opacity factor.

    • Optional fillGradientLinear: GradientParams

      The gradient params.

    Returns SCRTBrush

    new or existing instance of {@link SCRTBrush}}

Const createChartDestination

  • createChartDestination(canvasId: string): { canvas: HTMLCanvasElement; GetHeight: any; GetID: any; GetWidth: any }
  • Parameters

    • canvasId: string

    Returns { canvas: HTMLCanvasElement; GetHeight: any; GetID: any; GetWidth: any }

    • canvas: HTMLCanvasElement
    • GetHeight: function
      • GetHeight(): any
      • Returns any

    • GetID: function
      • GetID(): any
      • Returns any

    • GetWidth: function
      • GetWidth(): any
      • Returns any

Const createHitTestInfo

  • Parameters

    • renderableSeries: IRenderableSeries
    • xCoordinateCalculator: CoordinateCalculatorBase
    • yCoordinateCalculator: CoordinateCalculatorBase
    • isVerticalChart: boolean
    • dataSeries: BaseDataSeries
    • xNativeValues: DoubleVector
    • yNativeValues: DoubleVector
    • xHitCoord: number

      the X coordinate on the screen relative to seriesViewRect, X and Y swapped for vertical charts

    • yHitCoord: number

      the Y coordinate on the screen relative to seriesViewRect, X and Y swapped for vertical charts

    • nearestPointIndex: number
    • hitTestRadius: number

    Returns HitTestInfo

createImageAsync

  • createImageAsync(src: string): Promise<HTMLImageElement>
  • Helper function to create an HTML Image {@link HTMLImageElement} asychronously by passing in the string image source

    remarks

    Returns a promise, await this to get the image element

    Parameters

    • src: string

    Returns Promise<HTMLImageElement>

createImagesArrayAsync

  • createImagesArrayAsync(images: string[]): Promise<HTMLImageElement[]>
  • Helper function to create an HTML Images {@link HTMLImageElement} asychronously by passing in the string array

    Parameters

    • images: string[]

    Returns Promise<HTMLImageElement[]>

Const createNativeRect

  • createNativeRect(webAssemblyContext: TSciChart, xTopLeft: number, yTopLeft: number, xBottomRight: number, yBottomRight: number): SCRTRectVertex
  • Helper function to create a {@link SCRTRectVertex} native rectangle vertex

    Parameters

    • webAssemblyContext: TSciChart

      The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

    • xTopLeft: number
    • yTopLeft: number
    • xBottomRight: number
    • yBottomRight: number

    Returns SCRTRectVertex

Const createPenInCache

  • createPenInCache(penCache: Pen2DCache, stroke: string, strokeThickness: number, opacity: number, strokeDashArray?: number[]): SCRTPen
  • Creates a native {@link SCRTPen} Pen from html color code string passed in and caches it

    Parameters

    • penCache: Pen2DCache

      The object that will store a pen

    • stroke: string

      The HTML Color code

    • strokeThickness: number

      The strokethickness in pixels

    • opacity: number

      The opacity factor

    • Optional strokeDashArray: number[]

      the StrokeDashArray which defines any dash e.g. [2,2] means dash for 2pts, gap for 2pts (or undefined = solid line).

    Returns SCRTPen

    the new or existing instance of {@link SCRTPen}}

Const createPointMarker

Const createSCRTPen

  • createSCRTPen(wasmContext: TSciChart, htmlColorCode: string, strokeThickness: number, opacity: number, strokeDashArray?: number[], antiAliased?: boolean): SCRTPen
  • Helper function to create a {@link SCRTPen} native pen access to our WebGL2 Engine and WebAssembly numerical methods

    Parameters

    • wasmContext: TSciChart

      The {@link TSciChart | SciChart WebAssembly Context} containing native methods and access to our WebGL2 WebAssembly Drawing Engine

    • htmlColorCode: string

      Html color code in the format "#fff", "#ff0000", "rgba(255,255,0,1)", "#11333333"

    • strokeThickness: number

      the stroke thickness of the pen in pixels

    • opacity: number

      The opacity factor

    • Optional strokeDashArray: number[]

      the StrokeDashArray which defines any dash e.g. [2,2] means dash for 2pts, gap for 2pts (or undefined = solid line).

    • Default value antiAliased: boolean = true

    Returns SCRTPen

Const createSingle3dInternal

Const createSolidBrush

  • createSolidBrush(wasmContext: TSciChart, htmlColorCode: string, opacity: number): SCRTBrush
  • Helper function to create a {@link SCRTBrush} native solid color brushes

    Parameters

    • wasmContext: TSciChart
    • htmlColorCode: string

      Html color code in the format "#fff", "#ff0000", "rgba(255,255,0,1)", "#11333333"

    • opacity: number

    Returns SCRTBrush

Const createSvg

  • createSvg(svgString: string, svgRoot: SVGSVGElement): SVGElement
  • createSvg(svgRoot: SVGSVGElement, text: string, color: string, fontSize: number, fontFamily: string, fontWeight: string): SVGElement
  • Parameters

    • svgString: string
    • svgRoot: SVGSVGElement

    Returns SVGElement

  • Parameters

    • svgRoot: SVGSVGElement
    • text: string
    • color: string
    • fontSize: number
    • fontFamily: string
    • fontWeight: string

    Returns SVGElement

Const createTextTexture

  • createTextTexture(text: string[], textStyle: TTextStyle, rotation?: number, lineSpacing?: number, backgroundColor?: string, opacity?: number): { imageData: ImageData; textureHeight: number; textureWidth: number }
  • Create a text texture supporting multiline and arbitrary rotation

    Parameters

    • text: string[]
    • textStyle: TTextStyle
    • Optional rotation: number
    • Optional lineSpacing: number

      Expressed as a fraction of the font size. Default 1.1

    • Optional backgroundColor: string
    • Optional opacity: number

    Returns { imageData: ImageData; textureHeight: number; textureWidth: number }

    • imageData: ImageData
    • textureHeight: number
    • textureWidth: number

Const createType

  • createType(baseType: EBaseType, type: string, wasmContext: TSciChart | TSciChart3D, options: any): any
  • Parameters

    • baseType: EBaseType
    • type: string
    • wasmContext: TSciChart | TSciChart3D
    • options: any

    Returns any

deleteSafe

  • deleteSafe<T>(object: T): T

Const drawAxisMarkerAnnotation

  • drawAxisMarkerAnnotation(currentAxis: AxisBase2D, renderContext: WebGlRenderContext2D, displayValue: string, markerCoordinate: number, x1Coord: number, y1Coord: number, textStyle: TTextStyle, fill: string, opacity: number, image: HTMLImageElement, imageWidth: number, imageHeight: number): { textureHeight: number; textureWidth: number; xPosition: number; yPosition: number }
  • Parameters

    • currentAxis: AxisBase2D
    • renderContext: WebGlRenderContext2D
    • displayValue: string
    • markerCoordinate: number
    • x1Coord: number
    • y1Coord: number
    • textStyle: TTextStyle
    • fill: string
    • opacity: number
    • image: HTMLImageElement
    • imageWidth: number
    • imageHeight: number

    Returns { textureHeight: number; textureWidth: number; xPosition: number; yPosition: number }

    • textureHeight: number
    • textureWidth: number
    • xPosition: number
    • yPosition: number

Const drawBorder

  • drawBorder(renderContext: WebGlRenderContext2D, webAssemblyContext2D: TSciChart, solidBrushCacheBorder: SolidBrushCache, borderRect: Rect, leftBorder: number, topBorder: number, rightBorder: number, bottomBorder: number, color: string): void
  • Parameters

    • renderContext: WebGlRenderContext2D
    • webAssemblyContext2D: TSciChart
    • solidBrushCacheBorder: SolidBrushCache
    • borderRect: Rect
    • leftBorder: number
    • topBorder: number
    • rightBorder: number
    • bottomBorder: number
    • color: string

    Returns void

Const drawLineAnnotation

  • Function to draw Vertical or Horizontal Line annotations with labels

    Parameters

    Returns Rect

Const drawModifiersAxisLabel

  • Parameters

    Returns Rect

Const ensureRegistrations

  • ensureRegistrations(): void
  • This is just something to call to ensure that all the registrations are run before a surface is created

    Returns void

Const fillMetadata

  • Parameters

    Returns IPointMetadata[][]

Const fillNoisySinewave

  • fillNoisySinewave(pointCount: number, xMax: number, frequency: number, amplitude: number, noiseAmplitude: number, dataSeries: XyDataSeries): void
  • Parameters

    • pointCount: number
    • xMax: number
    • frequency: number
    • amplitude: number
    • noiseAmplitude: number
    • dataSeries: XyDataSeries

    Returns void

Const formatNumber

  • formatNumber(dataValue: number, numericFormat: ENumericFormat, precision: number): string
  • Parameters

    Returns string

Const formatNumber2Digits

  • formatNumber2Digits(value: number): string
  • description

    Formats value always to have 2 decimal digits, e.g. 12.45, 14.20, 17.00

    Parameters

    • value: number

    Returns string

Const formatUnixDateToHumanString

  • formatUnixDateToHumanString(unixTimestamp: number, locale?: string): string
  • Result 11/23/2018

    Parameters

    • unixTimestamp: number
    • Default value locale: string = "en-US"

    Returns string

Const formatUnixDateToHumanStringDD

  • formatUnixDateToHumanStringDD(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const formatUnixDateToHumanStringDDMM

  • formatUnixDateToHumanStringDDMM(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const formatUnixDateToHumanStringDDMMHHMM

  • formatUnixDateToHumanStringDDMMHHMM(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const formatUnixDateToHumanStringDDMMYY

  • formatUnixDateToHumanStringDDMMYY(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const formatUnixDateToHumanStringHHMM

  • formatUnixDateToHumanStringHHMM(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const formatUnixDateToHumanStringMMM

  • formatUnixDateToHumanStringMMM(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const formatUnixDateToHumanStringMMMDD

  • formatUnixDateToHumanStringMMMDD(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const formatUnixDateToHumanStringYYYY

  • formatUnixDateToHumanStringYYYY(unixTimestamp: number): string
  • Parameters

    • unixTimestamp: number

    Returns string

Const freeStyle

  • freeStyle(styleId: string): void
  • Parameters

    • styleId: string

    Returns void

Const fromTsrVector4

  • fromTsrVector4(tsrColor: TSRVector4): TArgb
  • Parameters

    • tsrColor: TSRVector4

    Returns TArgb

Const generateGuid

  • generateGuid(): string
  • description

    Generates GUID/UUID RFC4122 version 4 compliant

    Returns string

Const getActiveAxes

  • Parameters

    Returns AxisBase2D[]

getArraysEqual

  • getArraysEqual<T>(a: T[], b: T[]): boolean
  • Type parameters

    • T

    Parameters

    • a: T[]
    • b: T[]

    Returns boolean

Const getAttributeFromString

  • getAttributeFromString(str: string, attributeName: string): number
  • Parameters

    • str: string
    • attributeName: string

    Returns number

getAxis3dById

getAxisById

getAxisGeneric

  • Type parameters

    Parameters

    Returns T

Const getCoordinateWithCoordinateMode

Const getDataPointWidth

  • getDataPointWidth(xValues: DoubleVector, xCoordCalc: CoordinateCalculatorBase, seriesViewRectWidth: number, widthFraction: number, isCategoryAxis: boolean): number
  • Parameters

    • xValues: DoubleVector
    • xCoordCalc: CoordinateCalculatorBase
    • seriesViewRectWidth: number
    • widthFraction: number
    • isCategoryAxis: boolean

    Returns number

getDescriptorsEqual

  • Returns true if descriptors are deeply equal, else false

    Parameters

    Returns boolean

Const getFontString

  • getFontString(fontStyle: string, fontWeight: string, fontSize: number, fontFamily: string): string
  • getFontString(fontStyle: string, fontWeight: string, fontSize: number, fontFamily: string): string
  • Creates the font string, which is used to set font on CanvasRenderingContext2D

    Parameters

    • fontStyle: string

      The font style

    • fontWeight: string

      The font weight

    • fontSize: number

      The font size in pixels

    • fontFamily: string

      The font family

    Returns string

  • Creates the font string, which is used to set font on CanvasRenderingContext2D

    Parameters

    • fontStyle: string
    • fontWeight: string
    • fontSize: number
    • fontFamily: string

    Returns string

Const getFunction

  • getFunction(baseType: EBaseType, type: string): Function
  • Parameters

    Returns Function

getHorizontalAxisRequiredSize

  • Parameters

    Returns number

Const getIncludedAxis

  • Parameters

    • allAxes: AxisBase2D[]
    • axisMap: Map<string, boolean>

    Returns AxisBase2D[]

Const getIsHorizontal

  • Parameters

    Returns boolean

Const getIsVertical

  • Parameters

    Returns boolean

Const getKey

  • Parameters

    Returns string

Const getLabel

  • getLabel(text: string, styleId: string): LabelInfo
  • Parameters

    • text: string
    • styleId: string

    Returns LabelInfo

Const getLabelCoordinates

  • getLabelCoordinates(currentAxis: AxisBase2D, labelPlacement: ELabelPlacement, x1Coord: number, x2Coord: number, y1Coord: number, y2Coord: number, textureHeight: number, textureWidth: number): { xPosition: number; yPosition: number }
  • Calculates coordinates of the annotation label. The coordinates are defined as an absolute position on the whole SciChartSurface.

    Parameters

    • currentAxis: AxisBase2D
    • labelPlacement: ELabelPlacement
    • x1Coord: number
    • x2Coord: number
    • y1Coord: number
    • y2Coord: number
    • textureHeight: number
    • textureWidth: number

    Returns { xPosition: number; yPosition: number }

    • xPosition: number
    • yPosition: number

Const getLabelValue

  • getLabelValue(currentAxis: AxisBase2D, labelCoord: number): string
  • Parameters

    Returns string

Const getLegendContainerHtml

  • getLegendContainerHtml(placement: ELegendPlacement, textColor: string, backgroundColor: string, margin: Thickness, body: string): string
  • Parameters

    Returns string

Const getLegendItemHtml

  • Parameters

    Returns string

Const getLineCoordinates

  • getLineCoordinates(x1Coord: number, y1Coord: number, x2Coord: number, y2Coord: number, labelHeight: number, labelWidth: number, labelPlacement: ELabelPlacement, currentAxis: AxisBase2D): { x1LineCoord: number; x2LineCoord: number; y1LineCoord: number; y2LineCoord: number }
  • Calculates annotation line coordinates accordingly to axis alignment and label placement. Returns coordinates relative to seriesViewRect.

    Parameters

    • x1Coord: number
    • y1Coord: number
    • x2Coord: number
    • y2Coord: number
    • labelHeight: number
    • labelWidth: number
    • labelPlacement: ELabelPlacement
    • currentAxis: AxisBase2D

    Returns { x1LineCoord: number; x2LineCoord: number; y1LineCoord: number; y2LineCoord: number }

    • x1LineCoord: number
    • x2LineCoord: number
    • y1LineCoord: number
    • y2LineCoord: number

getLineStylesEqual

  • Parameters

    Returns boolean

Const getMasterCanvas

  • getMasterCanvas(): HTMLCanvasElement
  • Returns HTMLCanvasElement

Const getMaxSize

  • getMaxSize(): number
  • Returns number

Const getMinAge

  • getMinAge(): number
  • Returns number

Const getMonthString

  • getMonthString(month: number): string
  • Parameters

    • month: number

    Returns string

Const getNearestHeatmapPoint

  • Parameters

    Returns { xIndex: number; yIndex: number; zValue: number }

    • xIndex: number
    • yIndex: number
    • zValue: number

Const getNearestXPoint

  • Parameters

    Returns number

Const getNearestXyPoint

Const getNearestXyyPoint

Const getNextRandomPriceBarFactory

  • getNextRandomPriceBarFactory(startDateTimestamp: number, candleIntervalMinutes: number, simulateDateGap: boolean, startPrice: number): (Anonymous function)
  • Parameters

    • startDateTimestamp: number
    • candleIntervalMinutes: number
    • simulateDateGap: boolean
    • startPrice: number

    Returns (Anonymous function)

Const getNoisySinewave

  • getNoisySinewave(pointCount: number, xMax: number, frequency: number, amplitude: number, noiseAmplitude: number): number[][]
  • Parameters

    • pointCount: number
    • xMax: number
    • frequency: number
    • amplitude: number
    • noiseAmplitude: number

    Returns number[][]

Const getRandomInRange

  • getRandomInRange(min: number, max: number, decimalPlaces: number): number
  • Return random number in range [min, max]

    Parameters

    • min: number
    • max: number
    • decimalPlaces: number

    Returns number

getRubberBandRect

  • Given the starting and end mouse-point, computes a rectangle to perform zoom over. Takes into account the xyDirection

    Parameters

    • pointFrom: Point

      the starting point of the mouse

    • pointTo: Point

      the end point of the mouse

    • xyDirection: EXyDirection

      the XyDirection

    • viewportRect: Rect

    Returns Rect

Const getScrtBrushFromCache

  • getScrtBrushFromCache(cache: BrushCache): SCRTBrush
  • Retrieves a native {@link SCRTBrush} Brush from the provided {@link BrushCache} cache object. The retrieved entity is a wrapper around {@link SCRTPen}

    Parameters

    • cache: BrushCache

      The object that stores a brush

    Returns SCRTBrush

    new or existing instance of {@link SCRTBrush}}

Const getScrtPenFromCache

  • getScrtPenFromCache(penCache: Pen2DCache): SCRTPen
  • Retrieves a native {@link SCRTPen} Pen from the provided {@link Pen2DCache} cache object

    Parameters

    • penCache: Pen2DCache

      The object that stores a pen

    Returns SCRTPen

    the new or existing instance of {@link SCRTPen}}

Const getStocksDataFactory

  • getStocksDataFactory(STEP: number, RANDOM_MIN: number, RANDOM_MAX: number): (Anonymous function)
  • Creates function to generate stock data

    Parameters

    • STEP: number
    • RANDOM_MIN: number
    • RANDOM_MAX: number

    Returns (Anonymous function)

Const getStyleId

  • Parameters

    Returns string

Const getSubTypes

  • Parameters

    Returns string[]

getTArgbEqual

  • Parameters

    Returns boolean

getTextStylesEqual

  • Parameters

    Returns boolean

getUniqueValues

  • getUniqueValues(array: string[]): string[]
  • Parameters

    • array: string[]

    Returns string[]

Const getValueWithCoordinateMode

getVerticalAxisRequiredSize

  • Parameters

    Returns number

Const getWebGlBrushFromCache

  • getWebGlBrushFromCache(cache: BrushCache): WebGlBrush
  • Retrieves a native WebGlBrush Brush from the provided {@link BrushCache} cache object

    Parameters

    • cache: BrushCache

    Returns WebGlBrush

    new or existing instance of WebGlPen}

Const getWebGlPenFromCache

  • getWebGlPenFromCache(penCache: Pen2DCache): WebGlPen
  • Retrieves a native WebGlPen Pen from the provided {@link Pen2DCache} cache object. The retrieved entity is a wrapper around {@link SCRTPen}

    Parameters

    • penCache: Pen2DCache

      The object that stores a pen

    Returns WebGlPen

    the new or existing instance of WebGlPen}

Const getWindowedYRange

  • getWindowedYRange(webAssemblyContext: TSciChart, xValues: DoubleVector, yValues: DoubleVector, xRange: NumberRange, getPositiveRange: boolean, isXCategoryAxis: boolean, isSorted: boolean): NumberRange
  • Parameters

    • webAssemblyContext: TSciChart
    • xValues: DoubleVector
    • yValues: DoubleVector
    • xRange: NumberRange
    • getPositiveRange: boolean
    • isXCategoryAxis: boolean
    • isSorted: boolean

    Returns NumberRange

Const getXRange

  • Parameters

    • range: NumberRange
    • count: number
    • widthFraction: number

    Returns NumberRange

Const guardSameLengthZValuesAndMetadata

  • guardSameLengthZValuesAndMetadata(zValues: number[][], metadata: IPointMetadata[][]): void
  • Parameters

    Returns void

handleMsg

  • handleMsg(msg: any): void
  • Parameters

    • msg: any

    Returns void

Const hasAllProperties

  • hasAllProperties(obj: any, props: string[]): boolean
  • Parameters

    • obj: any
    • props: string[]

    Returns boolean

hasOwnProperty

  • hasOwnProperty<X, Y>(obj: X, prop: Y): obj is X & Record<Y, unknown>
  • Type parameters

    • X: {}

    • Y: PropertyKey

    Parameters

    • obj: X
    • prop: Y

    Returns obj is X & Record<Y, unknown>

htmlToElement

  • htmlToElement(html: string): ChildNode
  • Parameters

    • html: string

    Returns ChildNode

Const interpolateColor

  • interpolateColor(from: number, to: number, progress: number): number
  • Interpolates colors

    Parameters

    • from: number
    • to: number
    • progress: number

    Returns number

Const interpolateLinear

  • interpolateLinear(x: number, x1: number, y1: number, x2: number, y2: number): number
  • Parameters

    • x: number
    • x1: number
    • y1: number
    • x2: number
    • y2: number

    Returns number

Const interpolateNumber

  • interpolateNumber(from: number, to: number, progress: number): number
  • Interpolates numbers

    Parameters

    • from: number
    • to: number
    • progress: number

    Returns number

isRealNumber

  • isRealNumber(number: number): boolean
  • returns true if the number is a real number (not NAN, not Infinite)

    Parameters

    • number: number

    Returns boolean

isTypedArray

  • isTypedArray(a: any): boolean
  • Parameters

    • a: any

    Returns boolean

layoutAxisParts

layoutAxisPartsBottomStrategy

  • layoutAxisPartsBottomStrategy(axisRendererWidth: number, axisRendererHeight: number, axisTitleRendererWidth: number, axisTitleRendererHeight: number, containerBounds: Rect): TAxisViewRects
  • Parameters

    • axisRendererWidth: number
    • axisRendererHeight: number
    • axisTitleRendererWidth: number
    • axisTitleRendererHeight: number
    • containerBounds: Rect

    Returns TAxisViewRects

layoutAxisPartsLeftStrategy

  • layoutAxisPartsLeftStrategy(axisRendererWidth: number, axisRendererHeight: number, axisTitleRendererWidth: number, axisTitleRendererHeight: number, containerBounds: Rect): TAxisViewRects
  • Parameters

    • axisRendererWidth: number
    • axisRendererHeight: number
    • axisTitleRendererWidth: number
    • axisTitleRendererHeight: number
    • containerBounds: Rect

    Returns TAxisViewRects

layoutAxisPartsRightStrategy

  • layoutAxisPartsRightStrategy(axisRendererWidth: number, axisRendererHeight: number, axisTitleRendererWidth: number, axisTitleRendererHeight: number, containerBounds: Rect): TAxisViewRects
  • Parameters

    • axisRendererWidth: number
    • axisRendererHeight: number
    • axisTitleRendererWidth: number
    • axisTitleRendererHeight: number
    • containerBounds: Rect

    Returns TAxisViewRects

layoutAxisPartsTopStrategy

  • layoutAxisPartsTopStrategy(axisRendererWidth: number, axisRendererHeight: number, axisTitleRendererWidth: number, axisTitleRendererHeight: number, containerBounds: Rect): TAxisViewRects
  • Parameters

    • axisRendererWidth: number
    • axisRendererHeight: number
    • axisTitleRendererWidth: number
    • axisTitleRendererHeight: number
    • containerBounds: Rect

    Returns TAxisViewRects

linearColorMapLerp

  • Linearly interpolates a data-value in a TLinearColorMap, which specifies Gradient Stops, Data Minimum and Maximum and color stepping mode

    Parameters

    Returns number

Const logToBase

  • logToBase(n: number, base: number): number
  • Parameters

    • n: number
    • base: number

    Returns number

Const makeCacheKey

  • makeCacheKey(text: string, styleId: string): string
  • Parameters

    • text: string
    • styleId: string

    Returns string

Const measureTextHeight

  • measureTextHeight(fontSizePx: number): number
  • measureTextHeight(fontSizePx: number): number
  • Parameters

    • fontSizePx: number

    Returns number

  • Parameters

    • fontSizePx: number

    Returns number

Const measureTextWidth

  • measureTextWidth(ctx: CanvasRenderingContext2D, text: string): number
  • measureTextWidth(text: string): number
  • Parameters

    • ctx: CanvasRenderingContext2D
    • text: string

    Returns number

  • Parameters

    • text: string

    Returns number

Const numericHashCode

  • numericHashCode(hash: number, value: number): number
  • Parameters

    • hash: number
    • value: number

    Returns number

Const parseArgbToHtmlColor

  • parseArgbToHtmlColor(argbColor: number): string
  • Converts color from ARGB number format into HTML string format #FFFFFFFF

    Parameters

    • argbColor: number

      color in ARGB format

    Returns string

Const parseCacheKey

  • parseCacheKey(key: string): { styleId: string; text: string }
  • Parameters

    • key: string

    Returns { styleId: string; text: string }

    • styleId: string
    • text: string

parseColorToHexStringAbgr

  • parseColorToHexStringAbgr(input: string, opacityOverride?: number): string
  • Parse colors and convert them to hex string in ABGR format to use in c++ Examples: "#fff", "#ff0000", "rgba(255,255,0,1)", "#11333333"

    Parameters

    • input: string
    • Optional opacityOverride: number

    Returns string

parseColorToHexStringArgb

  • parseColorToHexStringArgb(input: string, opacityOverride?: number): string
  • Parse colors and convert them to hex string to use in c++ Examples: "#fff", "#ff0000", "rgba(255,255,0,1)", "#11333333"

    Parameters

    • input: string
    • Optional opacityOverride: number

    Returns string

parseColorToTArgb

  • parseColorToTArgb(input: string): TArgb
  • Converts an HTML color code to TArgb

    Parameters

    • input: string

    Returns TArgb

parseColorToUIntArgb

  • parseColorToUIntArgb(input: string, opacity?: number): number
  • Parameters

    • input: string
    • Optional opacity: number

    Returns number

Const parseTArgbToHtmlColor

  • parseTArgbToHtmlColor(targb: TArgb): string
  • Useful for debugging purposes. Converts TArgb to HTML Color code e.g. '#FF112233'=RGBA

    Parameters

    Returns string

Const pruneCache

  • pruneCache(): void
  • Returns void

Const registerFunction

  • registerFunction<T>(baseType: EBaseType, type: string, constructor: T, overWrite?: boolean): void
  • Register a pure function

    Type parameters

    • T: Function

    Parameters

    • baseType: EBaseType

      The base type for, which indicates where the function will be used, Either OptionFunction or OnCreated

    • type: string

      The name of the function

    • constructor: T

      the function to register

    • Default value overWrite: boolean = false

      Whether to override an existing registration for the type name. Default false.

    Returns void

Const registerType

  • registerType<T>(baseType: EBaseType, type: string, constructor: (options?: any) => T, overWrite?: boolean): void
  • Register a function that returns an object of the specified type.

    Type parameters

    • T: object

    Parameters

    • baseType: EBaseType

      The EBaseType of the object that is being registered.

    • type: string

      The name of the type, which should be a subtype of the baseType. For custom types, use the actual type name, not the "Custom" value on the subType enum.

    • constructor: (options?: any) => T

      A function that takes an optional options argument and returns an instance of the desired type.

        • (options?: any): T
        • Parameters

          • Optional options: any

          Returns T

    • Default value overWrite: boolean = false

      Whether to override an existing registration for the type. Default false.

    Returns void

Const registerWasmType

  • registerWasmType<T>(baseType: EBaseType, type: string, constructor: (wasmContext: TSciChart | TSciChart3D, options?: any) => T, overWrite?: boolean): void
  • Register a function that requires a webAssemblyContext to return an object of the specified type.

    Type parameters

    • T: object

    Parameters

    • baseType: EBaseType

      The EBaseType of the object that is being registered.

    • type: string

      The name of the type, which should be a subtype of the baseType. For custom types, use the actual type name, not the "Custom" value on the subType enum.

    • constructor: (wasmContext: TSciChart | TSciChart3D, options?: any) => T

      A function that takes a {@link TSciChart | SciChart 2D WebAssembly Context} or {@link TSciChart | SciChart 3D WebAssembly Context} and an optional options argument and returns an instance of the desired type.

        • (wasmContext: TSciChart | TSciChart3D, options?: any): T
        • Parameters

          • wasmContext: TSciChart | TSciChart3D
          • Optional options: any

          Returns T

    • Default value overWrite: boolean = false

      Whether to override an existing registration for the type. Default false.

    Returns void

Const resetCache

  • resetCache(): void
  • Returns void

Const runIfValue

  • runIfValue(value: any, fn: (value: any) => any): any
  • Parameters

    • value: any
    • fn: (value: any) => any
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns any

Const scaleAxes

  • scaleAxes(axes: AxisBase2D[], initialVisibleRanges: NumberRange[], delta: number, isMoreThanHalf: boolean): void
  • Parameters

    Returns void

sendMsg

  • sendMsg(payload: any, worker: Worker, method?: string): Promise<unknown>
  • Parameters

    • payload: any
    • worker: Worker
    • Optional method: string

    Returns Promise<unknown>

Const setLabel

  • setLabel(text: string, styleId: string, label: LabelInfo): void
  • Parameters

    • text: string
    • styleId: string
    • label: LabelInfo

    Returns void

Const setMaxSize

  • setMaxSize(size: number): void
  • Parameters

    • size: number

    Returns void

Const setMinAge

  • setMinAge(ageInMs: number): void
  • Parameters

    • ageInMs: number

    Returns void

Const setSplineAnimationVectors

  • setSplineAnimationVectors(wasmContext: TSciChart, animation: SeriesAnimation, ds: BaseDataSeries, animationDS: BaseDataSeries, xSplineValues: DoubleVector, ySplineValues: DoubleVector, isCategoryAxis: boolean, interpolationPoints: number): void
  • Parameters

    Returns void

Const setSplineBandAnimationVectors

  • setSplineBandAnimationVectors(wasmContext: TSciChart, animation: SeriesAnimation, ds: XyyDataSeries, animationDS: XyyDataSeries, xSplineValues: DoubleVector, ySplineValues: DoubleVector, y1SplineValues: DoubleVector, isCategoryAxis: boolean, interpolationPoints: number): void
  • Parameters

    • wasmContext: TSciChart
    • animation: SeriesAnimation
    • ds: XyyDataSeries
    • animationDS: XyyDataSeries
    • xSplineValues: DoubleVector
    • ySplineValues: DoubleVector
    • y1SplineValues: DoubleVector
    • isCategoryAxis: boolean
    • interpolationPoints: number

    Returns void

stringOccurrences

  • stringOccurrences(str: string, subStr: string, allowOverlapping?: boolean): number
  • Parameters

    • str: string
    • subStr: string
    • Default value allowOverlapping: boolean = false

    Returns number

Const switchData

  • switchData(field: EDataSeriesField, closey: any, openy1z?: any, high?: any, low?: any): any
  • Parameters

    • field: EDataSeriesField
    • closey: any
    • Optional openy1z: any
    • Optional high: any
    • Optional low: any

    Returns any

Const testHasExcluded

  • testHasExcluded(axisMap: Map<string, boolean>): boolean
  • Parameters

    • axisMap: Map<string, boolean>

    Returns boolean

Const testIsHitForBand

  • testIsHitForBand(isDigitalLine: boolean, xCoordinateCalculator: CoordinateCalculatorBase, yCoordinateCalculator: CoordinateCalculatorBase, xValues: DoubleVector, getYValue: (index: number) => number, getY1Value: (index: number) => number, pointIndex: number, xHitCoord: number, yHitCoord: number): { isHit: boolean; secondPointIndex: number }
  • Parameters

    • isDigitalLine: boolean
    • xCoordinateCalculator: CoordinateCalculatorBase
    • yCoordinateCalculator: CoordinateCalculatorBase
    • xValues: DoubleVector
    • getYValue: (index: number) => number
        • (index: number): number
        • Parameters

          • index: number

          Returns number

    • getY1Value: (index: number) => number
        • (index: number): number
        • Parameters

          • index: number

          Returns number

    • pointIndex: number
    • xHitCoord: number
    • yHitCoord: number

    Returns { isHit: boolean; secondPointIndex: number }

    • isHit: boolean
    • secondPointIndex: number

Const testIsHitForColumn

Const testIsHitForLine

  • testIsHitForLine(xCoordinateCalculator: CoordinateCalculatorBase, yCoordinateCalculator: CoordinateCalculatorBase, xValues: DoubleVector, yValues: DoubleVector, pointIndex: number, xHitCoord: number, yHitCoord: number, hitTestRadius: number): { isHit: boolean; secondPointIndex: number }
  • Parameters

    • xCoordinateCalculator: CoordinateCalculatorBase
    • yCoordinateCalculator: CoordinateCalculatorBase
    • xValues: DoubleVector
    • yValues: DoubleVector
    • pointIndex: number
    • xHitCoord: number

      The X coordinate, isVertical property is already taken into account

    • yHitCoord: number

      The Y coordinate, isVertical property is already taken into account

    • hitTestRadius: number

    Returns { isHit: boolean; secondPointIndex: number }

    • isHit: boolean
    • secondPointIndex: number

Const testIsHitForMountain

  • Parameters

    Returns { isHit: boolean; secondPointIndex: number }

    • isHit: boolean
    • secondPointIndex: number

Const testIsHitForOHLC

Const testIsHitForPoint

  • testIsHitForPoint(xCoordinateCalculator: CoordinateCalculatorBase, yCoordinateCalculator: CoordinateCalculatorBase, xValues: DoubleVector, yValues: DoubleVector, pointIndex: number, xHitCoord: number, yHitCoord: number, hitTestRadius: number): boolean
  • Parameters

    Returns boolean

Const testIsInBounds

  • testIsInBounds(x: number, y: number, left: number, top: number, right: number, bottom: number): boolean
  • Parameters

    • x: number
    • y: number
    • left: number
    • top: number
    • right: number
    • bottom: number

    Returns boolean

Const testIsInInterval

  • testIsInInterval(x: number, intervalStart: number, intervalEnd: number, radius?: number): boolean
  • Tests if X is within radius from the [intervalStart, intervalEnd] interval, intervalStart, intervalEnd values might not be sorted

    Parameters

    • x: number
    • intervalStart: number
    • intervalEnd: number
    • Default value radius: number = 0

    Returns boolean

Const testIsInXBounds

  • testIsInXBounds(xHitTestPoint: number, xDataPointCoord: number, maxDistance: number): boolean
  • Parameters

    • xHitTestPoint: number
    • xDataPointCoord: number
    • maxDistance: number

    Returns boolean

Const testIsOverAxes

  • Parameters

    Returns boolean

Const toHex

  • toHex(value: number): string
  • toHex(value: number): string
  • Converts a UINT color number to a 8-digit hex code e.g. #FFAABBCC

    Parameters

    • value: number

    Returns string

  • Parameters

    • value: number

    Returns string

Const toScientific

  • toScientific(value: number, precision: number, logarithmicBase: number): string
  • Parameters

    • value: number
    • precision: number
    • logarithmicBase: number

    Returns string

Const toSuperScript

  • toSuperScript(value: number): string
  • Parameters

    • value: number

    Returns string

Const translateFromCanvasToSeriesViewRect

  • translateFromCanvasToSeriesViewRect(point: Point, seriesViewRect: Rect, allowValuesOutOfBounds?: boolean): Point
  • Translates from canvas to seriesViewRect screen coordinates

    Parameters

    • point: Point
    • seriesViewRect: Rect
    • Default value allowValuesOutOfBounds: boolean = false

      will translate even if the point is outside of the seriesViewRect

    Returns Point

Const translateFromCanvasToSeriesViewRectX

  • translateFromCanvasToSeriesViewRectX(x: number, seriesViewRect: Rect): number
  • Parameters

    • x: number
    • seriesViewRect: Rect

    Returns number

Const translateFromCanvasToSeriesViewRectY

  • translateFromCanvasToSeriesViewRectY(y: number, seriesViewRect: Rect): number
  • Parameters

    • y: number
    • seriesViewRect: Rect

    Returns number

Const translateFromSeriesViewRectToCanvas

  • translateFromSeriesViewRectToCanvas(point: Point, seriesViewRect: Rect, allowValuesOutOfBounds?: boolean): Point
  • Translates from seriesViewRect to canvas screen coordinates

    Parameters

    • point: Point
    • seriesViewRect: Rect
    • Default value allowValuesOutOfBounds: boolean = false

      will translate even if the point is outside of the seriesViewRect

    Returns Point

Const translateToNotScaled

  • translateToNotScaled(value: number): number
  • Parameters

    • value: number

    Returns number

uintArgbColorIsTransparent

  • uintArgbColorIsTransparent(argbColor: number): boolean
  • Parameters

    • argbColor: number

    Returns boolean

uintArgbColorLerp

  • uintArgbColorLerp(from: number, to: number, ratio: number): number
  • Linearly interpolates between two colors based on the ratio passed in. E.g. Ratio = 0.0f returns From color, ratio = 1.0f returns To Color. Ratio = 0.5f returns a mix of the two Works for 32 bit colors

    Parameters

    • from: number

      the start color, for example 0x0000ffff (format ARGB)

    • to: number

      the end color, for example 0xffffffff

    • ratio: number

      the value between 0 and 1

    Returns number

uintArgbColorLerp24bit

  • uintArgbColorLerp24bit(from: number, to: number, ratio: number): number
  • Linearly interpolates between two colors based on the ratio passed in. E.g. Ratio = 0.0f returns From color, ratio = 1.0f returns To Color. Ratio = 0.5f returns a mix of the two. Works only for numbers not more than 24 bit

    Parameters

    • from: number

      the start color, for example 0xff0000

    • to: number

      the end color, for example 0x00ff00

    • ratio: number

      the value between 0 and 1

    Returns number

uintArgbColorMultiplyOpacity

  • uintArgbColorMultiplyOpacity(argbColor: number, opacity: number): number
  • Parameters

    • argbColor: number
    • opacity: number

    Returns number

uintArgbColorOverrideOpacity

  • uintArgbColorOverrideOpacity(argbColor: number, opacity: number): number
  • Parameters

    • argbColor: number
    • opacity: number

    Returns number

uintArgbColorToAbgr

  • uintArgbColorToAbgr(argbColor: number): number
  • Parameters

    • argbColor: number

    Returns number

updateAxisLayoutState

  • Parameters

    Returns void

updateLeftAndRightChartLayoutState

  • updateLeftAndRightChartLayoutState(chartLayoutState: ChartLayoutState, additionalLeftSize?: number, additionalRightSize?: number): void
  • Parameters

    • chartLayoutState: ChartLayoutState
    • Default value additionalLeftSize: number = 0
    • Default value additionalRightSize: number = 0

    Returns void

Const updateSplineAnimationProperties

  • updateSplineAnimationProperties(wasmContext: TSciChart, animation: SeriesAnimation, progress: number, dataSeries: BaseDataSeries, xSplineValues: DoubleVector, ySplineValues: DoubleVector): void
  • Parameters

    • wasmContext: TSciChart
    • animation: SeriesAnimation
    • progress: number
    • dataSeries: BaseDataSeries
    • xSplineValues: DoubleVector
    • ySplineValues: DoubleVector

    Returns void

Const updateSplineBandAnimationProperties

  • updateSplineBandAnimationProperties(wasmContext: TSciChart, animation: SeriesAnimation, progress: number, dataSeries: XyyDataSeries, xSplineValues: DoubleVector, ySplineValues: DoubleVector, y1SplineValues: DoubleVector): void
  • Parameters

    • wasmContext: TSciChart
    • animation: SeriesAnimation
    • progress: number
    • dataSeries: XyyDataSeries
    • xSplineValues: DoubleVector
    • ySplineValues: DoubleVector
    • y1SplineValues: DoubleVector

    Returns void

updateTopAndBottomChartLayoutState

  • updateTopAndBottomChartLayoutState(chartLayoutState: ChartLayoutState, additionalTopSize?: number, additionalBottomSize?: number): void
  • Parameters

    • chartLayoutState: ChartLayoutState
    • Default value additionalTopSize: number = 0
    • Default value additionalBottomSize: number = 0

    Returns void

Const updateTsrVector4

  • updateTsrVector4(color: TArgb, tsrColor: TSRVector4): void
  • Converts a color in TArgb format to TSRVector4 (RGBA -> x,y,z,w) for use in 3D Engine

    Parameters

    • color: TArgb
    • tsrColor: TSRVector4

    Returns void

Const wrapText

  • wrapText(text: string, maxLength: number): string[]
  • Convert a string into an array of lines by splitting on spaces and wrapping to a maximum number of characters

    Parameters

    • text: string
    • maxLength: number

    Returns string[]

Const zeroArray2D

  • zeroArray2D(dimensions: number[]): number[][]
  • Parameters

    • dimensions: number[]

    Returns number[][]

Object literals

Const animationHelpers

animationHelpers: object

animationUpdate

animationUpdate: animationUpdate

checkCanDraw

checkCanDraw: checkCanDraw

checkIsAnimationRunning

checkIsAnimationRunning: checkIsAnimationRunning

copyVector

copyVector: copyVector

createPointMarker

createPointMarker: createPointMarker

interpolateColor

interpolateColor: interpolateColor

interpolateNumber

interpolateNumber: interpolateNumber

setSplineAnimationVectors

setSplineAnimationVectors: setSplineAnimationVectors

setSplineBandAnimationVectors

setSplineBandAnimationVectors: setSplineBandAnimationVectors

updateSplineAnimationProperties

updateSplineAnimationProperties: updateSplineAnimationProperties

updateSplineBandAnimationProperties

updateSplineBandAnimationProperties: updateSplineBandAnimationProperties

Const annotationHelpers

annotationHelpers: object

calcNewApex

calcNewApex: calcNewApex

createSvg

createSvg: createSvg

Const autoReverseEasing

autoReverseEasing: object

Reversable functions that go from 0..1..0 used throughout SciChart when animations are used

linear

  • linear(t: number): number
  • No easing acceleration like linear, but it does reverse from 0..1..0

    Parameters

    • t: number

    Returns number

Const chartBuilder

chartBuilder: object

build2DChart

build2DChart: build2DChart
inheritdoc

buildAnnotations

buildAnnotations: buildAnnotations
inheritdoc

buildAxes

buildAxes: buildAxes
inheritdoc

buildChart

buildChart: buildChart
inheritdoc

buildDataSeries

buildDataSeries: buildDataSeries
inheritdoc

buildModifiers

buildModifiers: buildModifiers
inheritdoc

buildPieChart

buildPieChart: buildPieChart
inheritdoc

buildSeries

buildSeries: buildSeries
inheritdoc

chartReviver

chartReviver: chartReviver
inheritdoc

registerFunction

registerFunction: registerFunction
inheritdoc

registerType

registerType: registerType
inheritdoc

registerWasmType

registerWasmType: registerWasmType
inheritdoc

Const easing

easing: object

Easing functions used throughout SciChart when animations are used

cubic

  • cubic(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

elastic

  • elastic(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inCirc

  • inCirc(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inCubic

  • inCubic(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inExpo

  • inExpo(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inOutCirc

  • inOutCirc(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inOutCubic

  • inOutCubic(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inOutExpo

  • inOutExpo(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inOutQuad

  • inOutQuad(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inOutQuart

  • inOutQuart(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inOutQuint

  • inOutQuint(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inOutSine

  • inOutSine(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inQuad

  • inQuad(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inQuart

  • inQuart(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inQuint

  • inQuint(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

inSine

  • inSine(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

linear

  • linear(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

outCirc

  • outCirc(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

outCubic

  • outCubic(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

outExpo

  • outExpo(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

outQuad

  • outQuad(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

outQuart

  • outQuart(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

outQuint

  • outQuint(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

outSine

  • outSine(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

quadratic

  • quadratic(t: number): number
  • inheritdoc

    Parameters

    • t: number

    Returns number

Const hitTestHelpers

hitTestHelpers: object

createHitTestInfo

createHitTestInfo: createHitTestInfo

getNearestHeatmapPoint

getNearestHeatmapPoint: getNearestHeatmapPoint

getNearestXPoint

getNearestXPoint: getNearestXPoint

getNearestXyPoint

getNearestXyPoint: getNearestXyPoint

getNearestXyyPoint

getNearestXyyPoint: getNearestXyyPoint

testIsHitForBand

testIsHitForBand: testIsHitForBand

testIsHitForColumn

testIsHitForColumn: testIsHitForColumn

testIsHitForLine

testIsHitForLine: testIsHitForLine

testIsHitForMountain

testIsHitForMountain: testIsHitForMountain

testIsHitForOHLC

testIsHitForOHLC: testIsHitForOHLC

testIsHitForPoint

testIsHitForPoint: testIsHitForPoint

Const labelCache

labelCache: object

A global cache for labels, used by all labelProviders, to reduce the amount of time spent creating label textures.

checkStyle

checkStyle: checkStyle

Check if a text style matches the one for the given id

freeStyle

freeStyle: freeStyle

Notify the cache that a style is no longer used. Linked labels are only deleted when there are no remaining uses, and then only after minAge has passed.

getLabel

getLabel: getLabel

Get a label from the cache. Returns undefined if none found.

getMaxSize

getMaxSize: getMaxSize

Get the maximum number of labels allowed to be stored in the cache. Used when calling pruneCache

getMinAge

getMinAge: getMinAge

Get the minimum age (time since last used) of labels in the cache. This prevents recently used labels from being pruned, or removed when style is freed

getStyleId

getStyleId: getStyleId

Get an identifier for the given text style. Returns an existing identifier if a matching style exists in the cache

pruneCache

pruneCache: pruneCache

Remove old labels from the cache, if there are more than MaxSize.

resetCache

resetCache: resetCache

Completely clears and resets the cache. Testing use only

setLabel

setLabel: setLabel

Add a label to the cache

setMaxSize

setMaxSize: setMaxSize

Set the maximum number of labels allowed to be stored in the cache. Used when calling pruneCache

setMinAge

setMinAge: setMinAge

Set the minimum age (time since last used) of labels in the cache. This prevents recently used labels from being pruned, or removed when style is freed

Const testLayoutManager

testLayoutManager: object

layoutAxisPartsBottomStrategy

layoutAxisPartsBottomStrategy: layoutAxisPartsBottomStrategy

layoutAxisPartsLeftStrategy

layoutAxisPartsLeftStrategy: layoutAxisPartsLeftStrategy

layoutAxisPartsRightStrategy

layoutAxisPartsRightStrategy: layoutAxisPartsRightStrategy

layoutAxisPartsTopStrategy

layoutAxisPartsTopStrategy: layoutAxisPartsTopStrategy

updateAxisLayoutState

updateAxisLayoutState: updateAxisLayoutState