Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OHLCCandleStick

Candlestick OHLCFigure.

Index

Properties

Methods

Properties

positive

positive: boolean

Does figure represent positive or negative segments

scale

scale: Vec2<Scale>

Rendering scale

Methods

dispose

  • dispose(): this

  • Dispose shapes from rendering layer

    Returns this

getBodyFillStyle

  • getBodyFillStyle(): FillStyle

  • Get fill style of candles body.

    Returns FillStyle

    FillStyle object

getBodyFillStyleHighlight

  • getBodyFillStyleHighlight(): FillStyle | undefined

  • Get fill style of candles body when highlighted.

    Returns FillStyle | undefined

    FillStyle object if unassigned

getBodyStrokeStyle

  • getBodyStrokeStyle(): LineStyle

  • Get stroke style of candles body.

    Returns LineStyle

    LineStyle object

getBodyStrokeStyleHighlight

  • getBodyStrokeStyleHighlight(): LineStyle | undefined

  • Get style of candles body when highlighted.

    Returns LineStyle | undefined

    LineStyle object or undefined if unassigned

getClose

  • getClose(): number

getDataIndices

  • getDataIndices(): number | number[]

  • Get indices of data that figure represents.

    Returns number | number[]

    Either index array for multiple samples or single index

getDominantStyle

  • getDominantStyle(): FillStyle

  • Return some dominant fill style of the segment

    Returns FillStyle

    FillStyle object

getHigh

  • getHigh(): number

getHighlighted

  • getHighlighted(): boolean

  • Returns boolean

    True for highlighted state of object and false for basic

getIsUnderMouse

  • getIsUnderMouse(): boolean

  • Get boolean flag for whether object is currently under mouse or not

    Returns boolean

    Boolean for is object under mouse currently

getLow

  • getLow(): number

getMouseInteractions

  • getMouseInteractions(): boolean

  • Returns boolean

    Mouse interactions state

getOpen

  • getOpen(): number

getPosition

  • getPosition(): number

getStrokeStyle

  • getStrokeStyle(): LineStyle

  • Get stoke style of candles.

    Returns LineStyle

    LineStyle object

getStrokeStyleHighlight

  • getStrokeStyleHighlight(): LineStyle | undefined

  • Get stroke style of candles when highlighted.

    Returns LineStyle | undefined

    FillStyle object or undefined if unassigned

getWidth

  • getWidth(): number

  • Get Width of figure on x axis

    Returns number

    Width on x axis

isDisposed

  • isDisposed(): boolean

  • Returns boolean

    True if all shapes are disposed, false if not.

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

onMouseClick

  • Subscribe to Mouse Click event

    Parameters

    • listener: MouseEventHandler<this>

      Function that will be called when mouse clicks the bounds of UiObject.

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseDoubleClick

  • Subscribe to Mouse Double Click event

    Parameters

    Returns Token

onMouseDown

  • Subscribe to Mouse Down event

    Parameters

    Returns Token

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Subscribe to Mouse Enter event

    Parameters

    • listener: MouseEventHandler<this>

      Function that will be called when mouse enters the bounds of UiObject.

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseLeave

  • Subscribe to Mouse Leave event

    Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseMove

  • Subscribe to Mouse Move event

    Parameters

    Returns Token

    Token of subscription

onMouseUp

  • Subscribe to Mouse Up event

    Parameters

    Returns Token

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

  • Restore shapes to the rendering layer.

    Returns this

setBodyFillStyle

  • Set fill style of candles body.

    Parameters

    • value: FillStyle | ImmutableMutator<FillStyle>

      FillStyle object or mutator to modify existing one

    Returns this

    Object itself

setBodyFillStyleHighlight

  • setBodyFillStyleHighlight(fillStyle: FillStyle | ImmutableMutator<FillStyle> | undefined): this

  • Set fill style of candles body when highlighted.

    Parameters

    • fillStyle: FillStyle | ImmutableMutator<FillStyle> | undefined

      FillStyle object or mutator to modify existing one or undefined for automatic assignment

    Returns this

    Object itself

setBodyStrokeStyle

  • Set stroke style of candles body.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

      LineStyle object or mutator to modify existing one

    Returns this

    Object itself

setBodyStrokeStyleHighlight

  • setBodyStrokeStyleHighlight(value: LineStyle | ImmutableMutator<LineStyle> | undefined): this

  • Set style of candles body when highlighted.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle> | undefined

      LineStyle object or mutator to modify existing one or undefined for automatic assignment

    Returns this

    Object itself

setHighlighted

  • setHighlighted(isHighlighted: boolean): this

  • Set highlighted state of the Object

    Parameters

    • isHighlighted: boolean

      Highlight state of the object

    Returns this

    Object itself for fluent interface

setMouseInteractions

  • setMouseInteractions(state: boolean): this

  • Set mouse interactions enabled or disabled

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns this

    Object itself for fluent interface

setStrokeStyle

  • Set stroke style of candles lines.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

      LineStyle object or mutator to modify existing one

    Returns this

    Object itself

setStrokeStyleHighlight

  • setStrokeStyleHighlight(value: LineStyle | ImmutableMutator<LineStyle> | undefined): this

  • Set stroke style of candles when highlighted.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle> | undefined

      FillStyle object or mutator to modify existing one or undefined for automatic computation

    Returns this

    Object itself

setValues

  • setValues(position: number, open: number, high: number, low: number, close: number, dataIndices: number | number[]): this

  • Set values of figure.

    This is an internal function, it should not be used from applications.

    Parameters

    • position: number

      Position

    • open: number

      Open value

    • high: number

      High value

    • low: number

      Low value

    • close: number

      Close value

    • dataIndices: number | number[]

    Returns this

    Object itself

setWidth

  • setWidth(width: number): this

  • Set width of figure.

    This is an internal function, it should not be used from applications. For customizing width of Figure, see OHLCSeries.setFigureWidth

    Parameters

    • width: number

      Width of figure on its X scale

    Returns this

    Object itself