Options
All
  • Public
  • Public/Protected
  • All
Menu

LightningChart® JS API Documentation

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AbruptMouseEventHandler

AbruptMouseEventHandler: function

    • Parameters

      • obj: T
      • Optional event: MouseEvent

      Returns void

AngleInterval

AngleInterval: SliceInterval

AnimationEasing

AnimationEasing: function

    • Parameters

      • start: number
      • end: number
      • duration: number

      Returns Ease

AnimationFactory

AnimationFactory: function

AnimationFrameCallback

AnimationFrameCallback: function

    • Parameters

      • values: Array<number>

      Returns void

AreaSeriesTypes

AreaSeriesTypes: AreaSeriesPositive | AreaSeriesNegative | AreaSeriesBipolar

BoxSeriesFormatter

BoxSeriesFormatter: function

CursorStyler

CursorStyler: Mutator<T>

CustomTickTextFormatter

CustomTickTextFormatter: function

    • Parameters

      • value: number
      • customTick: CustomTick<TickMarkerBackgroundType>

      Returns string

DashboardResizeEventInterface

DashboardResizeEventInterface: AbstractEventInterface

DateTimeFormatter

DateTimeFormatter: DateTimeFormatOptions | FormattingFunction

DynamicUIMouseStyle

DynamicUIMouseStyle: function

    • Parameters

      • uiElement: T

      Returns string | undefined

EngineDimension

EngineDimension: [number | undefined, number | undefined] | undefined | number

EngineOptions

EngineOptions: EngineSettings & FitEngineToDiv | DimensionalEngineSize

FigureSeriesFormatter

FigureSeriesFormatter: function

    • Type parameters

      Parameters

      • tableContentBuilder: T
      • series: P
      • figure: FigureType

      Returns T

FigureStyler

FigureStyler: function

    • Parameters

      • figure: T

      Returns void

FontStyle

FontStyle: "normal" | "italic" | "oblique"

FontWeight

FontWeight: "normal" | "bold" | "bolder" | "lighter" | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900

FormattingFunction

FormattingFunction: function

    • Parameters

      Returns string

GaugeAngleIntervalEventHandler

GaugeAngleIntervalEventHandler: function

GaugeChartTypes

GaugeChartTypes: SolidGauge

ImmutableMutator

ImmutableMutator: function

    • Parameters

      • object: T

      Returns B

IntensitySeriesTypes

IntensitySeriesTypes: IntensityGridSeries | IntensityMeshSeries

IntervalChangeEventListener

IntervalChangeEventListener: function

LUTOptions

LUTOptions: LUTStepsOptions & Partial<ValuePaletteOptions>

LineSeriesStyle3D

LineSeriesStyle3D: SolidLine<SolidFill>

Matrix

Matrix: Array<Array<T>>

MouseDragEventHandler

MouseDragEventHandler: function

    • Parameters

      • obj: T
      • event: MouseEvent
      • button: number
      • startLocation: Point
      • delta: Point

      Returns void

MouseDragStartEventHandler

MouseDragStartEventHandler: function

    • Parameters

      • obj: T
      • event: MouseEvent
      • button: number

      Returns void

MouseDragStopEventHandler

MouseDragStopEventHandler: function

    • Parameters

      • obj: T
      • event: MouseEvent
      • button: number
      • startLocation: Point

      Returns void

MouseEventHandler

MouseEventHandler: function

    • Parameters

      • obj: T
      • event: MouseEvent

      Returns void

MouseWheelEventHandler

MouseWheelEventHandler: function

    • Parameters

      • obj: T
      • event: WheelEvent

      Returns void

Mutator

Mutator: function

    • Parameters

      • object: T

      Returns void

OHLCFigureStyler

OHLCFigureStyler: function

    • Parameters

      • figure: T

      Returns void

OHLCSeriesFormatter

OHLCSeriesFormatter: function

OHLCSeriesTypes

OHLCSeriesTypes: OHLCSeriesTraditional<PositiveFigure, NegativeFigure> | OHLCSeriesWithAutomaticPacking<PositiveFigure, NegativeFigure>

Padding

Padding: Margin

Palette

Palette: function

    • Parameters

      • index: number

      Returns T

PaletteFactory

PaletteFactory: function

    • Parameters

      • length: number

      Returns Palette<T>

RangeSeriesFormatter

RangeSeriesFormatter: function

    • Type parameters

      Parameters

      • tableContentBuilder: T
      • series: RangeSeries
      • position: number
      • high: number
      • low: number

      Returns T

ResultTableContent

ResultTableContent: Array<string | undefined>[]

SeriesXYFormatter

SeriesXYFormatter: function

    • Type parameters

      Parameters

      • tableContentBuilder: T
      • series: SeriesXY
      • x: number
      • y: number

      Returns T

SliceLabelFormatter

SliceLabelFormatter: function

    • Parameters

      • slice: T
      • relativeValue: number

      Returns string

SliceSorter

SliceSorter: function

    • Parameters

      • sliceA: T
      • sliceB: T

      Returns number

SpiderAxisLabelStrategy

SpiderAxisLabelStrategy: function

SpiderScaleLabelStrategy

SpiderScaleLabelStrategy: function

SpiderSeriesFormatter

SpiderSeriesFormatter: function

    • Type parameters

      Parameters

      • tableContentBuilder: T
      • series: SpiderSeries
      • value: number
      • axis: string
      • formatValue: function

          • Parameters

            • value: number

            Returns string

      Returns T

TickMarker

TickMarker: StylableText & StylableBackground<BackgroundType> & Pointable

TouchEventHandler

TouchEventHandler: function

    • Parameters

      • obj: T
      • event: ExtendedPointerEvent

      Returns void

UIElementStyler

UIElementStyler: function

    • Parameters

      • object: T
      • theme: Theme

      Returns unknown

UILegendBox

UILegendBox: UIPartWithBackground<BackgroundType> & LegendBox<TitleType, DefaultEntryType>

UIMouseStyle

UIMouseStyle: string | DynamicUIMouseStyle<UIElement>

UpdateColorCallback

UpdateColorCallback: function

    • Parameters

      • Optional row: undefined | number
      • Optional column: undefined | number
      • Optional current: IntensityValue & Partial<ColorValue>

      Returns Color | undefined

UpdateGeometryCallback

UpdateGeometryCallback: function

    • Parameters

      • row: number
      • column: number
      • current: Point

      Returns Point | undefined

UpdateValueCallback

UpdateValueCallback: function

    • Parameters

      • Optional row: undefined | number
      • Optional column: undefined | number
      • Optional current: IntensityValue

      Returns number | undefined

ValueChangeEventListener

ValueChangeEventListener: function

    • Parameters

      • slice: S
      • previous: number
      • next: number

      Returns void

XOHLC

XOHLC: [number, number, number, number, number]

ZoomBandChartSeriesStyler

ZoomBandChartSeriesStyler: function

Variables

Const emptyFill

emptyFill: EmptyFill

Const emptyLine

emptyLine: LineStyle

Const emptyTick

emptyTick: TickStyle

Const transparentFill

transparentFill: SolidFill

Const transparentLine

transparentLine: SolidLine<SolidFill>

Functions

Const Animator

  • Animator(afterUpdate: function, fps: number): (Anonymous function)

  • Parameters

    • afterUpdate: function

        • Returns void

    • Default value fps: number

    Returns (Anonymous function)

Const ColorHEX

  • ColorHEX(hexColor: string): Color

  • Parameters

    • hexColor: string

    Returns Color

    Color object

Const ColorHSV

  • ColorHSV(hue: number, saturation: number, value: number): Color

  • Parameters

    • hue: number
    • Default value saturation: number
    • Default value value: number

    Returns Color

    Color object

Const ColorRGBA

  • ColorRGBA(r: number, g: number, b: number, a: number): Color

  • Parameters

    • r: number
    • g: number
    • b: number
    • Default value a: number

    Returns Color

    Color object

Const SolidFillPalette

Const lerpRGBA

  • Parameters

    Returns Color

    Color in between start and target colors.

Const lightningChart

Const saveToFile

  • saveToFile(engine: PublicEngine, fileName: string, type: string, encoderOptions: undefined | number): void

  • Parameters

    • engine: PublicEngine
    • fileName: string
    • Default value type: string
    • Optional encoderOptions: undefined | number

    Returns void

Const translatePoint

  • Parameters

    Returns Point

    value translated to targetScale

Object literals

Const AnimationEasings

AnimationEasings: object

ease

ease: function

    • Parameters

      • start: number
      • end: number
      • duration: number

      Returns Ease

easeIn

easeIn: function

    • Parameters

      • start: number
      • end: number
      • duration: number

      Returns Ease

easeOut

easeOut: function

    • Parameters

      • start: number
      • end: number
      • duration: number

      Returns Ease

linear

linear: function

    • Parameters

      • start: number
      • end: number
      • duration: number

      Returns Ease

Const AreaSeriesTypes

AreaSeriesTypes: object

Bipolar

Bipolar: AreaSeriesBipolar

Negative

Negative: AreaSeriesNegative

Positive

Positive: AreaSeriesPositive

Const AutoCursorBuilders

AutoCursorBuilders: object

Spider

Spider: AutoCursor2DBuilder<PointMarker, UIBackground>

XY

XY: AutoCursorXYBuilder<PointMarker, UIBackground, PointableBackground, PointableBackground>

Const AutoFitStrategies

AutoFitStrategies: object

Flip

Flip: _AutoFitByFlip

FontSize

FontSize: _AutoFitByFontSize

Const AxisScrollStrategies

AxisScrollStrategies: object

expansion

expansion: AxisScrollStrategy

fitting

fitting: AxisScrollStrategy

progressive

progressive: AxisScrollStrategy

regressive

regressive: AxisScrollStrategy

Const AxisTickStrategies

AxisTickStrategies: object

DateTime

DateTime: "DateTime"

Empty

Empty: "Empty"

Numeric

Numeric: "Numeric"

Const ColorPalettes

ColorPalettes: object

arction

arction: function

    • Parameters

      • length: number

      Returns Palette<T>

arctionWarm

arctionWarm: function

    • Parameters

      • length: number

      Returns Palette<T>

cold

cold: function

    • Parameters

      • length: number

      Returns Palette<T>

flatUI

flatUI: function

    • Parameters

      • length: number

      Returns Palette<T>

fullSpectrum

fullSpectrum: function

    • Parameters

      • length: number

      Returns Palette<T>

reverseSpectrum

reverseSpectrum: function

    • Parameters

      • length: number

      Returns Palette<T>

warm

warm: function

    • Parameters

      • length: number

      Returns Palette<T>

sector

  • sector(start: number, end: number, saturation: number, vibrance: number): PaletteFactory<Color>

  • Parameters

    • start: number
    • end: number
    • Default value saturation: number
    • Default value vibrance: number

    Returns PaletteFactory<Color>

Const DataPatterns

DataPatterns: object

freeform

freeform: FreeFormPattern

horizontalProgressive

horizontalProgressive: ProgressivePattern

horizontalRegressive

horizontalRegressive: ProgressivePattern

verticalProgressive

verticalProgressive: ProgressivePattern

verticalRegressive

verticalRegressive: ProgressivePattern

Const DefaultLibraryStyle

DefaultLibraryStyle: object

axesStyles3D

axesStyles3D: object

axisNibOverlayStyle

axisNibOverlayStyle: SolidFill

axisNibStyle

axisNibStyle: SolidLine<SolidFill>

axisOverlayStyle

axisOverlayStyle: SolidFill

axisStyle

axisStyle: SolidLine<SolidFill>

axisTitleFillStyle

axisTitleFillStyle: SolidFill

axisTitleFont

axisTitleFont: FontSettings

boundingBoxStyle3D

boundingBoxStyle3D: SolidLine<SolidFill>

chartBackgroundFillStyle

chartBackgroundFillStyle: SolidFill

chartBackgroundStrokeStyle

chartBackgroundStrokeStyle: LineStyle

chartXYFittingRectangleFillStyle

chartXYFittingRectangleFillStyle: EmptyFill

chartXYFittingRectangleStrokeStyle

chartXYFittingRectangleStrokeStyle: SolidLine<SolidFill>

chartXYTitleFont

chartXYTitleFont: FontSettings

chartXYZoomingRectangleFillStyle

chartXYZoomingRectangleFillStyle: EmptyFill

chartXYZoomingRectangleStrokeStyle

chartXYZoomingRectangleStrokeStyle: SolidLine<SolidFill>

customTickGridStrokeStyle

customTickGridStrokeStyle: SolidLine<SolidFill>

customTickLabelFont

customTickLabelFont: FontSettings

dashboardBackgroundFillStyle

dashboardBackgroundFillStyle: SolidFill

dashboardBackgroundStrokeStyle

dashboardBackgroundStrokeStyle: SolidLine<SolidFill>

dashboardSplitterStyle

dashboardSplitterStyle: SolidLine<SolidFill>

defaultBandFillStyle

defaultBandFillStyle: SolidFill

defaultBandStrokeStyle

defaultBandStrokeStyle: LineStyle

defaultBoxFigureLineStyle

defaultBoxFigureLineStyle: SolidLine<SolidFill>

defaultBoxFigureMedianLineStyle

defaultBoxFigureMedianLineStyle: SolidLine<SolidFill>

defaultBoxFigureStrokeStyle

defaultBoxFigureStrokeStyle: SolidLine<SolidFill>

defaultBoxFigureStyle

defaultBoxFigureStyle: SolidFill

defaultCandleStickNegativeStyle

defaultCandleStickNegativeStyle: SolidFill

defaultCandleStickPositiveStyle

defaultCandleStickPositiveStyle: SolidFill

defaultCandleStickStyle

defaultCandleStickStyle: SolidLine<SolidFill>

defaultConstantLineStrokeStyle

defaultConstantLineStrokeStyle: SolidLine<SolidFill>

defaultLineSeriesStyle

defaultLineSeriesStyle: SolidLine<SolidFill>

defaultMountainsFillStyle

defaultMountainsFillStyle: SolidFill

defaultMountainsInvertedFillStyle

defaultMountainsInvertedFillStyle: SolidFill

defaultMountainsInvertedStrokeStyle

defaultMountainsInvertedStrokeStyle: SolidLine<SolidFill>

defaultMountainsStrokeStyle

defaultMountainsStrokeStyle: SolidLine<SolidFill>

defaultOHLCBarNegativeStyle

defaultOHLCBarNegativeStyle: SolidLine<SolidFill>

defaultOHLCBarPositiveStyle

defaultOHLCBarPositiveStyle: SolidLine<SolidFill>

defaultPointSeriesStyle3D

defaultPointSeriesStyle3D: TriangulatedPoints3D

funnelChartTitleFont

funnelChartTitleFont: FontSettings

funnelLabelConnectorStyle

funnelLabelConnectorStyle: SolidLine<SolidFill | RadialGradientFill | LinearGradientFill>

funnelLabelFillStyle

funnelLabelFillStyle: SolidFill

funnelLabelFont

funnelLabelFont: FontSettings

funnelSliceFillStylePalette

funnelSliceFillStylePalette: function

    • Parameters

      • index: number

      Returns T

funnelSliceStrokeStyle

funnelSliceStrokeStyle: LineStyle

panelBackgroundFillStyle

panelBackgroundFillStyle: SolidFill

panelBackgroundStrokeStyle

panelBackgroundStrokeStyle: LineStyle

pieChartTitleFont

pieChartTitleFont: FontSettings

pieLabelConnectorStyle

pieLabelConnectorStyle: SolidLine<SolidFill | RadialGradientFill | LinearGradientFill>

pieLabelFillStyle

pieLabelFillStyle: SolidFill

pieLabelFont

pieLabelFont: FontSettings

pieSliceFillStylePalette

pieSliceFillStylePalette: function

    • Parameters

      • index: number

      Returns T

pieSliceStrokeStyle

pieSliceStrokeStyle: LineStyle

pointLinePointFillStyle

pointLinePointFillStyle: SolidFill

pointMarkerFillStyle

pointMarkerFillStyle: SolidFill

pointMarkerStrokeStyle

pointMarkerStrokeStyle: LineStyle

pyramidChartTitleFont

pyramidChartTitleFont: FontSettings

pyramidLabelConnectorStyle

pyramidLabelConnectorStyle: SolidLine<SolidFill | RadialGradientFill | LinearGradientFill>

pyramidLabelFillStyle

pyramidLabelFillStyle: SolidFill

pyramidLabelFont

pyramidLabelFont: FontSettings

pyramidSliceFillStylePalette

pyramidSliceFillStylePalette: function

    • Parameters

      • index: number

      Returns T

pyramidSliceStrokeStyle

pyramidSliceStrokeStyle: LineStyle

resultTableFillStyle

resultTableFillStyle: SolidFill

resultTableStrokeStyle

resultTableStrokeStyle: SolidLine<SolidFill>

resultTableTextStyle

resultTableTextStyle: SolidFill

segmentSeriesStyle

segmentSeriesStyle: SolidLine<SolidFill>

seriesStyle

seriesStyle: SolidFill

spiderAxisLabelFillStyle

spiderAxisLabelFillStyle: SolidFill

spiderAxisLabelFont

spiderAxisLabelFont: FontSettings

spiderAxisStyle

spiderAxisStyle: SolidLine<SolidFill>

spiderChartTitleFont

spiderChartTitleFont: FontSettings

spiderScaleLabelFillStyle

spiderScaleLabelFillStyle: SolidFill

spiderScaleLabelFont

spiderScaleLabelFont: FontSettings

spiderSeriesFillStyle

spiderSeriesFillStyle: SolidFill

spiderSeriesStrokeStyle

spiderSeriesStrokeStyle: SolidLine<SolidFill>

spiderWebStyle

spiderWebStyle: SolidLine<SolidFill>

uiBackgroundFillStyle

uiBackgroundFillStyle: SolidFill

uiBackgroundStrokeStyle

uiBackgroundStrokeStyle: SolidLine<SolidFill>

uiButtonFillStyle

uiButtonFillStyle: SolidFill

uiButtonSize

uiButtonSize: number

uiTextFillStyle

uiTextFillStyle: SolidFill

styleButton

  • styleButton(button: StylableButton, fillStyle: FillStyle): void

  • Parameters

    • button: StylableButton
    • fillStyle: FillStyle

    Returns void

Const FormattingFunctions

FormattingFunctions: object

Numeric

  • Parameters

    Returns string

    Value formated as string

NumericUnits

  • Parameters

    Returns string

    Value formated as string with units

Const FunnelChartTypes

FunnelChartTypes: object

LabelsInsideSlices

LabelsInsideSlices: FunnelChartWithLabelsInsideSlices

LabelsOnSides

LabelsOnSides: FunnelChartWithLabelsOnSides

Const GaugeChartTypes

GaugeChartTypes: object

Solid

Solid: SolidGauge

Const IntensitySeriesTypes

IntensitySeriesTypes: object

Grid

Grid: IntensityGridSeries

Mesh

Mesh: IntensityMeshSeries

Const LegendBoxBuilders

LegendBoxBuilders: object

HorizontalLegendBox

HorizontalLegendBox: UILegendBoxBuilder<InternalBackground, UITextBox<UIBackground>, LegendBoxEntry>

VerticalLegendBox

VerticalLegendBox: UILegendBoxBuilder<InternalBackground, UITextBox<UIBackground>, LegendBoxEntry>

Const MarkerBuilders

MarkerBuilders: object

XY

XY: StaticCursorXYBuilder<PointMarker, UIBackground, PointableBackground, PointableBackground>

Const OHLCFigures

OHLCFigures: object

Bar

Bar: OHLCBar

Candlestick

Candlestick: OHLCCandleStick

Const OHLCSeriesTypes

OHLCSeriesTypes: object

AutomaticPacking

AutomaticPacking: OHLCSeriesWithAutomaticPacking

Normal

Normal: OHLCSeriesTraditional

Const PieChartTypes

PieChartTypes: object

LabelsInsideSlices

LabelsInsideSlices: PieChartWithLabelsInsideSlices

LabelsOnSides

LabelsOnSides: PieChartWithLabelsOnSides

Const PointMarkers

PointMarkers: object

None

None: EmptyPointMarker

UICircle

UICircle: UICircle

UIDiamond

UIDiamond: UIDiamond

UIRectangle

UIRectangle: UIRectangle

Const PointSeriesTypes3D

PointSeriesTypes3D: object

Pixelated

Pixelated: PointCloudSeries3D

Triangulated

Triangulated: PointSeries3D

Const PointStyle3D

PointStyle3D: object

Pixelated

Pixelated: PixelatedPoints3D

Triangulated

Triangulated: TriangulatedPoints3D

Const PyramidChartTypes

PyramidChartTypes: object

LabelsInsideSlices

LabelsInsideSlices: PyramidChartWithLabelsInsideSlices

LabelsOnSides

LabelsOnSides: PyramidChartWithLabelsOnSides

Const SliceLabelFormatters

SliceLabelFormatters: object

Name

Name: function

    • Parameters

      • slice: T
      • relativeValue: number

      Returns string

NamePlusRelativeValue

NamePlusRelativeValue: function

    • Parameters

      • slice: T
      • relativeValue: number

      Returns string

NamePlusValue

NamePlusValue: function

    • Parameters

      • slice: T
      • relativeValue: number

      Returns string

Const SliceSorters

SliceSorters: object

None

None: function

    • Parameters

      • sliceA: T
      • sliceB: T

      Returns number

SortByName

SortByName: function

    • Parameters

      • sliceA: T
      • sliceB: T

      Returns number

SortByValueAscending

SortByValueAscending: function

    • Parameters

      • sliceA: T
      • sliceB: T

      Returns number

SortByValueDescending

SortByValueDescending: function

    • Parameters

      • sliceA: T
      • sliceB: T

      Returns number

Const Themes

Themes: object

dark

dark: Theme

light

light: Theme

Const UIBackgrounds

UIBackgrounds: object

Circle

Circle: UICircle

Diamond

Diamond: UIDiamond

None

None: UIEmptyBackground

Pointer

Pointer: UIPointer

Rectangle

Rectangle: UIRectangle

Const UIButtonPictures

UIButtonPictures: object

Circle

Circle: UICircle

Diamond

Diamond: UIDiamond

Rectangle

Rectangle: UIRectangle

Const UIElementBuilders

UIElementBuilders: object

ButtonBox

ButtonBox: UICheckBoxBuilder<UIBackground, UIButtonPicture, UIButtonPicture>

CheckBox

CheckBox: UICheckBoxBuilder<UIBackground, UIButtonPicture, UIButtonPicture>

PointableTextBox

PointableTextBox: UIPointableTextBoxBuilder<PointableBackground>

TextBox

TextBox: UITextBoxBuilder<UIBackground>

Const UILayoutBuilders

UILayoutBuilders: object

Column

Column: UIColumnBuilder<UIBackground>

Row

Row: UIRowBuilder<UIBackground>

Const UIOrigins

UIOrigins: object

Center

Center: Point

CenterBottom

CenterBottom: Point

CenterTop

CenterTop: Point

LeftBottom

LeftBottom: Point

LeftCenter

LeftCenter: Point

LeftTop

LeftTop: Point

RightBottom

RightBottom: Point

RightCenter

RightCenter: Point

RightTop

RightTop: Point

Const xDimensionStrategy

xDimensionStrategy: object

getHeight

  • getHeight(size: Vec2<T>): T

  • Parameters

    • size: Vec2<T>

    Returns T

    Height of Vec2

getWidth

  • getWidth(size: Vec2<T>): T

  • Parameters

    • size: Vec2<T>

    Returns T

    Width of Vec2

toPoint

  • toPoint(value: number, height: number): Point

  • Parameters

    • value: number
    • height: number

    Returns Point

    Vec2 which represents relevant for custom tick position

toVec2

  • toVec2(value: T, height: T): object

  • Parameters

    • value: T
    • height: T

    Returns object

    Vec2 which represents relevant for custom tick position

Const yDimensionStrategy

yDimensionStrategy: object

getHeight

  • getHeight(size: Vec2<T>): T

  • Parameters

    • size: Vec2<T>

    Returns T

    Height of Vec2

getWidth

  • getWidth(size: Vec2<T>): T

  • Parameters

    • size: Vec2<T>

    Returns T

    Width of Vec2

toPoint

  • toPoint(value: number, height: number): Point

  • Parameters

    • value: number
    • height: number

    Returns Point

    Vec2 which represents relevant for custom tick position

toVec2

  • toVec2(value: T, height: T): object

  • Parameters

    • value: T
    • height: T

    Returns object

    Vec2 which represents relevant for custom tick position