Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LineSeries <CursorPointInterface >

Index

Properties

axisX

axisX: Axis

axisY

axisY: Axis

chart

chart: ChartXY

scale

scale: Vec2<Scale>

Methods

add

  • Parameters

    Returns this

    Object itself for fluent interface.

addArrayX

  • addArrayX(arrayX: number[], step: number, start: undefined | number): this
  • Parameters

    • arrayX: number[]
    • Default value step: number
    • Optional start: undefined | number

    Returns this

    Object itself for fluent interface.

addArrayY

  • addArrayY(arrayY: number[], step: number, start: number): this
  • Parameters

    • arrayY: number[]
    • Default value step: number
    • Default value start: number

    Returns this

    Object itself for fluent interface.

addArraysXY

  • addArraysXY(arrayX: number[], arrayY: number[]): this
  • Parameters

    • arrayX: number[]
    • arrayY: number[]

    Returns this

    Object itself for fluent interface.

addMarker

  • addMarker(cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>): SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

attach

  • Parameters

    Returns this

    Series itself for fluent interface

clear

  • clear(): this
  • Returns this

    Series itself for fluent interface

dispose

  • dispose(): this
  • Returns this

    Object itself for fluent interface

getBoundaries

  • getBoundaries(): Interval<Point>
  • Returns Interval<Point>

getCursorEnabled

  • getCursorEnabled(): boolean
  • Returns boolean

    Whether Cursor is enabled or not

getCursorInterpolationEnabled

  • getCursorInterpolationEnabled(): boolean
  • Returns boolean

    Boolean flag

getHighlightOnHover

  • getHighlightOnHover(): boolean
  • Returns boolean

    Boolean for if object should highlight on mouse hover or not.

getHighlighted

  • getHighlighted(): boolean
  • Returns boolean

    the state of highlighted flag

getIsUnderMouse

  • getIsUnderMouse(): boolean
  • Returns boolean

    Boolean for is object under mouse currently

getLastPoint

  • getLastPoint(): Point | undefined
  • Returns Point | undefined

    Copy of last point added to the Series or undefined if it doesn't exist.

getMaxPointCount

  • getMaxPointCount(): number | undefined
  • Returns number | undefined

    Number of points, or undefined if data-cleaning is disabled

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getName

  • getName(): string
  • Returns string

    The name of the Component.

getPointAmount

  • getPointAmount(): number
  • Returns number

    Number of points

getResultTableFormatter

getStrokeStyle

getStrokeStyleHighlight

getXMax

  • getXMax(): number | undefined
  • Returns number | undefined

    Max X value of the series

getXMin

  • getXMin(): number | undefined
  • Returns number | undefined

    Min X value of the series

getYMax

  • getYMax(): number | undefined
  • Returns number | undefined

    Max Y value of the series

getYMin

  • getYMin(): number | undefined
  • Returns number | undefined

    Min Y value of the series

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    TODO: True for enabled and false for disabled

offHover

  • offHover(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseClick

  • offMouseClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseDown

  • offMouseDown(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseMove

  • offMouseMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseUp

  • offMouseUp(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offTouchMove

  • offTouchMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

offTouchStart

  • offTouchStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

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

onHover

  • onHover(clbk: function): Token
  • Parameters

    • clbk: function
        • Parameters

          • series: this
          • cursorPoint: CursorPointInterface | undefined

          Returns void

    Returns Token

    Token of the event listener

onMouseClick

onMouseDoubleClick

onMouseDown

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

onMouseLeave

onMouseMove

onMouseUp

onMouseWheel

onTouchEnd

onTouchMove

onTouchStart

restore

  • restore(): this
  • Returns this

    Object itself.

setCursorEnabled

  • setCursorEnabled(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

setCursorInterpolationEnabled

  • setCursorInterpolationEnabled(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface

setHighlightOnHover

  • setHighlightOnHover(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface.

setHighlighted

  • setHighlighted(highLight: boolean): this
  • Parameters

    • highLight: boolean

    Returns this

    component itself for fluent interface

setMaxPointCount

  • setMaxPointCount(maxPointCount: number | undefined): this
  • Parameters

    • maxPointCount: number | undefined

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface

setName

  • setName(name: string): this
  • Parameters

    • name: string

    Returns this

    Object itself

setResultTableFormatter

setStrokeStyle

setStrokeStyleHighlight

solveNearestFromScreen

  • solveNearestFromScreen(location: Point, interpolate: boolean): undefined | CursorPoint
  • Parameters

    • location: Point
    • Default value interpolate: boolean

    Returns undefined | CursorPoint

    Undefined or data-structure for positioning of cursors

solveNearestFromSegment

  • solveNearestFromSegment(location: Point, segment: LineSet, interpolate: boolean): undefined | CursorPoint
  • Parameters

    • location: Point
    • segment: LineSet
    • Default value interpolate: boolean

    Returns undefined | CursorPoint

    Undefined or data-structure for positioning of cursors