Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OHLCSeriesTraditional <PositiveFigure, NegativeFigure >

OHLCSeries class. Takes data in format of OHLC segment interface and renders it using generic StockFigures. Currently only supports progressive X timeline!

Index

Properties

_theme

_theme: Theme

Theme from owning Chart, used for styling

axisX

axisX: Axis

Axis X

axisY

axisY: Axis

Axis Y

chart

chart: ChartXY

scale

scale: Vec2<Scale>

Scale of the series

setMaxPointsCount

setMaxPointsCount: setMaxPointCount
deprecated

Deprecated in v1.1.0. Use setMaxPointCount instead.

Methods

add

  • Add OHLC segments to series. NOTE: Added segments must always have progressive X values!

    Parameters

    • data: XOHLC | XOHLC[]

      Tuple of X+OHLC values or array of such tuples

    Returns this

    Object itself

addMarker

  • addMarker(cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>): SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>
  • Add Marker to the Series.

    Type parameters

    Parameters

    • Default value cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

      StaticCursorBuilderXY object for customized look of marker. MarkerBuilders.XY can be used to build a custom one from scratch.

    Returns SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

    SeriesMarkerXY

attach

  • Attach object to an legendBox entry

    Parameters

    • entry: LegendBoxEntry

      Object which has to be attached

    • Default value disposeOnClick: boolean

      Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.

    Returns this

    Series itself for fluent interface

clear

  • clear(): this
  • Clear all data from the series

    Returns this

    Series itself for fluent interface

dispose

  • dispose(): this
  • Remove everything related to the object from all collections associated with rendering cycle and allows the object to be collected by GC

    Returns this

    Object itself for fluent interface

getCursorEnabled

  • getCursorEnabled(): boolean
  • Returns boolean

    Whether Cursor is enabled or not

getFigureAutoFitting

  • getFigureAutoFitting(): boolean
  • Get whether auto-fitting of Figures is enabled. When enabled, figures are automatically split / fused based on distance from each other.

    Returns boolean

    Is auto-fitting enabled.

getFigureWidth

  • getFigureWidth(): pixel
  • Get width of figures in pixels.

    Returns pixel

getHighlighted

  • getHighlighted(): boolean
  • Returns boolean

    the state of highlighted flag

getIsUnderMouse

  • getIsUnderMouse(): boolean
  • Get boolean flag for whether object is currently under mouse or not

    Returns boolean

    Boolean for is object under mouse currently

getMouseInteractions

  • getMouseInteractions(): boolean
  • Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.

    Returns boolean

    Mouse interactions state

getName

  • getName(): string
  • Get the name of the Component.

    Returns string

    The name of the Component.

getResultTableFormatter

  • Get ResultTable Formatter.

    Returns OHLCSeriesFormatter

    Function which builds ResultTable content for OHLCSeries.

getXMax

  • getXMax(): number
  • Returns number

    Max X value of the series

getXMin

  • getXMin(): number
  • Returns number

    Min X value of the series

getYMax

  • getYMax(): number
  • Returns number

    Max Y value of the series

getYMin

  • getYMin(): number
  • Returns number

    Min Y value of the series

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    TODO: True for enabled and false for disabled

offHover

  • offHover(token: Token): boolean
  • Remove event listener from Series Hover Event.

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseClick

  • offMouseClick(token: Token): boolean
  • Remove event listener from Mouse Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Remove event listener from Mouse Double Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDown

  • offMouseDown(token: Token): boolean
  • Remove event listener from Mouse Down Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Remove event listener from Mouse Drag Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Remove event listener from Mouse Drag Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Remove event listener from Mouse Drag Stop Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Remove event listener from Mouse Enter Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Remove event listener from Mouse Leave Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseMove

  • offMouseMove(token: Token): boolean
  • Remove event listener from Mouse Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseUp

  • offMouseUp(token: Token): boolean
  • Remove event listener from Mouse Up Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Remove event listener from Mouse Wheel Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Remove event listener from Touch End Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchMove

  • offTouchMove(token: Token): boolean
  • Remove event listener from Touch Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchStart

  • offTouchStart(token: Token): boolean
  • Remove event listener from Touch Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

onHover

  • onHover(clbk: function): Token
  • Add event listener to Series Hover Event. Hover event is a custom mouse-event designed for Series that is the main link between Cursors and Series.

    Parameters

    • clbk: function

      Callback function that is called whenever mouse enters / moves or leaves the Series

        • Parameters

          Returns void

    Returns Token

    Token of the event listener

onMouseClick

  • Add event listener to Mouse Click Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDoubleClick

  • Add event listener to Mouse Double Click Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDown

  • Add event listener to Mouse Down Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Add event listener to Enter Event

    Parameters

    Returns Token

    Token of the event listener

onMouseLeave

  • Add event listener to Mouse Leave Event

    Parameters

    Returns Token

    Token of the event listener

onMouseMove

  • Add event listener to Mouse Move Event

    Parameters

    Returns Token

    Token of the event listener

onMouseUp

  • Add event listener to Mouse Up Event

    Parameters

    Returns Token

    Token of the event listener

onMouseWheel

  • Subscribe to Mouse Wheel event

    Parameters

    Returns Token

    Token of subscription

onTouchEnd

  • Subscribe to Touch End event

    Parameters

    Returns Token

    Token of subscription

onTouchMove

  • Subscribe to Touch Move event

    Parameters

    Returns Token

    Token of subscription

onTouchStart

  • Subscribe to Touch Start event

    Parameters

    Returns Token

    Token of subscription

restore

  • restore(): this
  • Tell the owning chart to restore this series.

    Returns this

    Object itself.

setCursorEnabled

  • setCursorEnabled(state: boolean): this
  • Set whether Cursor is enabled or not

    Parameters

    • state: boolean

    Returns this

setFigureAutoFitting

  • setFigureAutoFitting(enabled: boolean): this
  • Set whether auto-fitting of Figures is enabled. When enabled, figures are automatically split / fused based on distance from each other.

    Parameters

    • enabled: boolean

      Is auto-fitting enabled.

    Returns this

    Object itself for fluent interface

setFigureWidth

  • setFigureWidth(width: pixel): this
  • Set width of figures in pixels.

    Parameters

    • width: pixel

      Width in pixels

    Returns this

    Object itself

setHighlighted

  • setHighlighted(highLight: boolean): this
  • Enable or disable forced highlighting of component

    Parameters

    • highLight: boolean

      True for enabled and false for disabled

    Returns this

    component itself for fluent interface

setMaxPointCount

  • setMaxPointCount(maxPointCount: number | undefined): this
  • Set maximum amount of OHLC data-points

    Parameters

    • maxPointCount: number | undefined

      Maximum amount of OHLC data-points that should be kept around. If undefined or 0 is passed data-cleaning will be disabled.

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Set mouse interactions enabled or disabled. Disabling mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns this

    Object itself for fluent interface

setName

  • setName(name: string): this
  • Sets the name of the Component updating attached LegendBox entries

    Parameters

    • name: string

      Name of the Component

    Returns this

    Object itself

setNegativeStyle

  • Set style of negative figures. Negative style is applied after common style. NOTE: Because the function is applied for each figure added, it is not advised to create any objects inside the function.

    Example usage:

    Desired result Argument Explanation
    Explicit style (figure) => ... The type of 'figure' is equal to type parameter: NegativeFigure

    Parameters

    Returns this

    Object itself

setPositiveStyle

  • Set style of positive figures. Positive style is applied after common style. NOTE: Because the function is applied for each figure added, it is not advised to create any objects inside the function. Instead they should be previously cached and later referred to.

    Example usage:

    Desired result Argument Explanation
    Explicit style (figure) => ... The type of 'figure' is equal to type parameter: PositiveFigure

    Parameters

    Returns this

    Object itself

setResultTableFormatter

  • Method for customizing contents of ResultTables when pointing at this Series.

    Parameters

    Returns this

    Object itself

setStyle

  • Set common style for both positive and negative figures. NOTE: Because the function is applied for each figure added, it is not advised to create any objects inside the function. Instead they should be previously cached and later referred to.

    Example usage:

    Desired result Argument Explanation
    Explicit style (figure) => ... The type of figure can be equal to type parameter PositiveFigure or NegativeFigure

    Parameters

    Returns this

    Object itself

solveNearestFromScreen

  • Solves the nearest datapoint to a given coordinate on screen.

    Parameters

    • location: Point

      Location on screen

    Returns undefined | OHLCCursorPoint

    Undefined or data-structure for positioning of cursors

solveNearestFromSegment

  • Solves the nearest datapoint to a given coordinate on a screen from a specific segment.

    Parameters

    • location: Point

      Location on screen

    • segment: OHLCFigure

      Segment to solve from

    Returns undefined | OHLCCursorPoint

    Undefined or data-structure for positioning of cursors