Class ChartXY <CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerBackgroundTypeX, CursorTickMarkerBackgroundTypeY >

Index

Properties

Methods

Properties

engine

engine: PublicEngine

pixelScale

pixelScale: Vec2<Scale>

uiScale

uiScale: Vec2<Scale>

Methods

addAreaRangeSeries

addAreaRangeSeries(options: SeriesOptions): AreaRangeSeries

Parameters
- Optional options: SeriesOptions
Returns AreaRangeSeries

Created series

addAreaSeries

addAreaSeries(options: AreaSeriesOptions<AreaType>): InstanceType<AreaType>

Type parameters
- AreaType: AreaSeriesTypes
Parameters
- Optional options: AreaSeriesOptions<AreaType>
Returns InstanceType<AreaType>

Created series

addAxisX

addAxisX(addTop: boolean): Axis

Parameters
- Default value addTop: boolean
Returns Axis

Axis object.

addAxisY

addAxisY(addRight: boolean): Axis

Parameters
- Default value addRight: boolean
Returns Axis

Axis object.

addBoxSeries

addBoxSeries(options: BoxSeriesOptions<FigureType>): BoxSeries<FigureType>

Type parameters
- FigureType: BoxFigure
Parameters
- Optional options: BoxSeriesOptions<FigureType>
Returns BoxSeries<FigureType>

Created series

addChartMarkerXY

addChartMarkerXY(cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>, axisX: Axis, axisY: Axis): ChartMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

Type parameters
- PointMarkerType: PointMarker
- ResultTableBackgroundType: UIBackground
- TickMarkerBackgroundTypeX: PointableBackground
- TickMarkerBackgroundTypeY: PointableBackground
Parameters
- Default value cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>
- Optional axisX: Axis
- Optional axisY: Axis
Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

Created ChartMarker

addEllipseSeries

addEllipseSeries(options: SeriesOptions): EllipseSeries

Parameters
- Optional options: SeriesOptions
Returns EllipseSeries

Created series

addHeatmapSeries

addHeatmapSeries(options: IntensitySeriesOptions<IntensityType>): InstanceType<IntensityType>

Type parameters
- IntensityType: IntensitySeriesTypes
Parameters
- options: IntensitySeriesOptions<IntensityType>
Returns InstanceType<IntensityType>

Created series

addLegendBox

addLegendBox(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addLineSeries

addLineSeries(options: LineSeriesOptions): LineSeries

Parameters
- Optional options: LineSeriesOptions
Returns LineSeries

LineSeries.

addOHLCSeries

addOHLCSeries(options: OHLCSeriesOptions<PositiveFigure, NegativeFigure, OHLCSeriesType>): OHLCSeriesType

Type parameters
- PositiveFigure: OHLCFigure
- NegativeFigure: OHLCFigure
- OHLCSeriesType: OHLCSeriesTypes<PositiveFigure, NegativeFigure>
Parameters
- Optional options: OHLCSeriesOptions<PositiveFigure, NegativeFigure, OHLCSeriesType>
Returns OHLCSeriesType

Created OHLCSeries whose interface is related to value of 'seriesConstructor' parameter

addPointLineSeries

addPointLineSeries(options: PointSeriesOptions): PointLineSeries

Parameters
- Optional options: PointSeriesOptions
Returns PointLineSeries

Created plot

addPointSeries

addPointSeries(options: PointSeriesOptions): PointSeries

Parameters
- Optional options: PointSeriesOptions
Returns PointSeries

Created series.

addRectangleSeries

addRectangleSeries(options: SeriesOptions): RectangleSeries

Parameters
- Optional options: SeriesOptions
Returns RectangleSeries

Created series

addSegmentSeries

addSegmentSeries(options: SeriesOptions): SegmentSeries

Parameters
- Optional options: SeriesOptions
Returns SegmentSeries

Created series

addSplineSeries

addSplineSeries(options: SplineSeriesOptions): SplineSeries

Parameters
- Optional options: SplineSeriesOptions
Returns SplineSeries

Created series

addStepSeries

addStepSeries(options: StepSeriesOptions): StepSeries

Parameters
- Optional options: StepSeriesOptions
Returns StepSeries

Created series

addUIElement

addUIElement(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

disableAnimations(): this

Returns this

Chart itself for fluent interface.

dispose

dispose(): this

Returns this

Object itself for fluent interface

forEachAxis

forEachAxis(clbk: function): void

Parameters
- clbk: function
  - - Parameters
      - axis: Axis
      Returns void
Returns void

forEachAxisX

forEachAxisX(clbk: function): void

Parameters
- clbk: function
  - - Parameters
      - axis: Axis
      - i: number
      - arr: Axis[]
      Returns void
Returns void

forEachAxisY

forEachAxisY(clbk: function): void

Parameters
- clbk: function
  - - Parameters
      - axis: Axis
      - i: number
      - arr: Axis[]
      Returns void
Returns void

getAxes

getAxes(axisPositions: AxisPosition[]): Axis[]

Parameters
- Rest axisPositions: AxisPosition[]
Returns Axis[]

An array of axis

getBackgroundFillStyle

getBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getBackgroundStrokeStyle

getBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getChartBackgroundFillStyle

getChartBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getChartBackgroundStrokeStyle

getChartBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getDefaultAxisX

getDefaultAxisX(): Axis

Returns Axis

Primary X axis is the bottom one. If there is no bottom axis, the top one became default.

getDefaultAxisY

getDefaultAxisY(): Axis

Returns Axis

Primary Y axis is the left one. If there is no left axis, the right one became default.

getFittingRectangleFillStyle

getFittingRectangleFillStyle(): FillStyle

Returns FillStyle

FillStyle

getFittingRectangleStrokeStyle

getFittingRectangleStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getMinimumSize

getMinimumSize(): Point | undefined

Returns Point | undefined

Vec2 minimum size or undefined if unimplemented

getMouseInteractionPan

getMouseInteractionPan(): boolean

Returns boolean

Boolean flag

getMouseInteractionRectangleFit

getMouseInteractionRectangleFit(): boolean

Returns boolean

Boolean flag

getMouseInteractionRectangleZoom

getMouseInteractionRectangleZoom(): boolean

Returns boolean

Boolean flag

getMouseInteractionWheelZoom

getMouseInteractionWheelZoom(): boolean

Returns boolean

Boolean flag

getMouseInteractionsWhileScrolling

getMouseInteractionsWhileScrolling(): boolean

Returns boolean

True if interactions with series are disabled, false if not.

getMouseInteractionsWhileZooming

getMouseInteractionsWhileZooming(): boolean

Returns boolean

True if interactions with series are disabled, false if not.

getPadding

getPadding(): Margin

Returns Margin

Padding datastructure

getSeries

getSeries(): SeriesXY[]

Returns SeriesXY[]

series

getTitle

getTitle(): string

Returns string

Chart title as a string.

getTitleFillStyle

getTitleFillStyle(): FillStyle

Returns FillStyle

FillStyle object

getTitleFont

getTitleFont(): FontSettings

Returns FontSettings

FontSettings object

getTitleMarginBottom

getTitleMarginBottom(): number

Returns number

Padding after Chart title

getTitleMarginTop

getTitleMarginTop(): number

Returns number

Padding before Chart title

getZoomingRectangleFillStyle

getZoomingRectangleFillStyle(): FillStyle

Returns FillStyle

FillStyle

getZoomingRectangleStrokeStyle

getZoomingRectangleStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

offChartBackgroundMouseClick

offChartBackgroundMouseClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDoubleClick

offChartBackgroundMouseDoubleClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDown

offChartBackgroundMouseDown(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDrag

offChartBackgroundMouseDrag(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDragStart

offChartBackgroundMouseDragStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDragStop

offChartBackgroundMouseDragStop(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseEnter

offChartBackgroundMouseEnter(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseLeave

offChartBackgroundMouseLeave(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseMove

offChartBackgroundMouseMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseUp

offChartBackgroundMouseUp(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseWheel

offChartBackgroundMouseWheel(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundTouchEnd

offChartBackgroundTouchEnd(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundTouchMove

offChartBackgroundTouchMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundTouchStart

offChartBackgroundTouchStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

offResize

offResize(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onChartBackgroundMouseClick

onChartBackgroundMouseClick(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseDoubleClick

onChartBackgroundMouseDoubleClick(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseDown

onChartBackgroundMouseDown(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseDrag

onChartBackgroundMouseDrag(handler: MouseDragEventHandler<this>): Token

Parameters
- handler: MouseDragEventHandler<this>
Returns Token

onChartBackgroundMouseDragStart

onChartBackgroundMouseDragStart(handler: MouseDragStartEventHandler<this>): Token

Parameters
- handler: MouseDragStartEventHandler<this>
Returns Token

onChartBackgroundMouseDragStop

onChartBackgroundMouseDragStop(handler: MouseDragStopEventHandler<this>): Token

Parameters
- handler: MouseDragStopEventHandler<this>
Returns Token

onChartBackgroundMouseEnter

onChartBackgroundMouseEnter(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseLeave

onChartBackgroundMouseLeave(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseMove

onChartBackgroundMouseMove(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseUp

onChartBackgroundMouseUp(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseWheel

onChartBackgroundMouseWheel(handler: MouseWheelEventHandler<this>): Token

Parameters
- handler: MouseWheelEventHandler<this>
Returns Token

onChartBackgroundTouchEnd

onChartBackgroundTouchEnd(handler: TouchEventHandler<this>): Token

Parameters
- handler: TouchEventHandler<this>
Returns Token

onChartBackgroundTouchMove

onChartBackgroundTouchMove(handler: TouchEventHandler<this>): Token

Parameters
- handler: TouchEventHandler<this>
Returns Token

onChartBackgroundTouchStart

onChartBackgroundTouchStart(handler: TouchEventHandler<this>): Token

Parameters
- handler: TouchEventHandler<this>
Returns Token

onResize

onResize(handler: function): Token

Parameters
- handler: function
  - - Parameters
      - obj: this
      - width: pixel
      - height: pixel
      - engineWidth: pixel
      - engineHeight: pixel
      Returns void
Returns Token

Token of subscription

saveToFile

saveToFile(fileName: string, type: undefined | string, encoderOptions: undefined | number): this

Parameters
- fileName: string
- Optional type: undefined | string
- Optional encoderOptions: undefined | number
Returns this

setBackgroundFillStyle

setBackgroundFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setBackgroundStrokeStyle

setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setChartBackgroundFillStyle

setChartBackgroundFillStyle(fillStyle: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- fillStyle: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setChartBackgroundStrokeStyle

setChartBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setFittingRectangleFillStyle

setFittingRectangleFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setFittingRectangleStrokeStyle

setFittingRectangleStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setMouseBackgroundStyle

setMouseBackgroundStyle(mouseStyle: string): this

Parameters
- Default value mouseStyle: string
Returns this

Object itself

setMouseFitStyle

setMouseFitStyle(mouseStyle: string): this

Parameters
- Default value mouseStyle: string
Returns this

Object itself

setMouseInteractionPan

setMouseInteractionPan(enabled: boolean): this

Parameters
- enabled: boolean
Returns this

Object itself

setMouseInteractionRectangleFit

setMouseInteractionRectangleFit(enabled: boolean): this

Parameters
- enabled: boolean
Returns this

Object itself

setMouseInteractionRectangleZoom

setMouseInteractionRectangleZoom(enabled: boolean): this

Parameters
- enabled: boolean
Returns this

Object itself

setMouseInteractionWheelZoom

setMouseInteractionWheelZoom(enabled: boolean): this

Parameters
- enabled: boolean
Returns this

Object itself

setMouseInteractions

setMouseInteractions(enabled: boolean): this

Parameters
- enabled: boolean
Returns this

Object itself

setMouseInteractionsWhileScrolling

setMouseInteractionsWhileScrolling(state: boolean): this

Parameters
- state: boolean
Returns this

Chart itself for fluent interface.

setMouseInteractionsWhileZooming

setMouseInteractionsWhileZooming(state: boolean): this

Parameters
- state: boolean
Returns this

Chart itself for fluent interface.

setMousePanStyle

setMousePanStyle(mouseStyle: string): this

Parameters
- Default value mouseStyle: string
Returns this

Object itself

setMouseZoomStyle

setMouseZoomStyle(mouseStyle: string): this

Parameters
- Default value mouseStyle: string
Returns this

Object itself

setPadding

setPadding(padding: Partial<Margin> | number): this

Parameters
- padding: Partial<Margin> | number
Returns this

Object itself

setSeriesHighlightOnHover

setSeriesHighlightOnHover(state: boolean): this

Parameters
- state: boolean
Returns this

Object itself for fluent interface.

setTitle

setTitle(title: string): this

Parameters
- title: string
Returns this

Object itself for fluent interface.

setTitleFillStyle

setTitleFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Chart itself

setTitleFont

setTitleFont(value: FontSettings | ImmutableMutator<FontSettings>): this

Parameters
- value: FontSettings | ImmutableMutator<FontSettings>
Returns this

Chart itself

setTitleMarginBottom

setTitleMarginBottom(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface

setTitleMarginTop

setTitleMarginTop(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface

setZoomingRectangleFillStyle

setZoomingRectangleFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setZoomingRectangleStrokeStyle

setZoomingRectangleStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

solveNearest

solveNearest(location: Point | undefined): undefined | CursorPoint

Parameters
- Default value location: Point | undefined
Returns undefined | CursorPoint

Undefined or data-structure for positioning of markers (and cursors)