Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PointLineSeries

Implementation of SeriesXY for visualizing a collection of Points with a specifiable PointShape and connected lines.

PointLineSeries are created with ChartXY.addPointLineSeries

Index

Properties

Readonly axisX

axisX : Axis

Axis X

Readonly axisY

axisY : Axis

Axis Y

Readonly chart

chart : ChartXY

Readonly scale

scale : LinearScaleXY

Scale of the series

Methods

add

  • Append a single XY coordinate or list of coordinates into the series.

     // Example syntax
     PointLineSeries.add({ x: 0, y: 100 })
    
     PointLineSeries.add([
         { x: 0, y: 100 },
         { x: 10, y: 50 },
         { x: 20, y: 75 },
     ])
    

    There is also a set of extra attributes that can be supplied for each data point:

     PointLineSeries
         .setIndividualPointSizeEnabled(true)
         .setIndividualPointRotationEnabled(true)
         .setIndividualPointValueEnabled(true)
         .add({
             x: 0,
             y: 0,
             color: ColorRGBA(255, 0, 0),
             size: 10,
             rotation: 45,
             value: 62.5
         })
    

    Parameters

    Returns this

    Object itself for fluent interface.

addArrayX

  • addArrayX(arrayX: number[], step: number, start?: undefined | number): this
  • Each X-value will be paired with an automatically generated Y-value, based on step-argument. This method will cause some overhead based on amount of data added, using add method is recommended.

    Parameters

    • arrayX: number[]

      Array of X-values.

    • step: number

      Optional step between each Y coordinate. Defaults to 1.

    • start: undefined | number

      Optional value for first generated Y-value. If undefined, will continue after last point's Y value in series, or 0 if there are no points in series.

    Returns this

    Object itself for fluent interface.

addArrayY

  • addArrayY(arrayY: number[], step: number, start: number): this
  • Each Y-value will be paired with an automatically generated X-value, based on step-argument.

    Parameters

    • arrayY: number[]

      Array of Y-values.

    • step: number

      Optional step between each X coordinate. Defaults to 1.

    • start: number

      Optional value for first generated X-value. If undefined, will continue after last point's X value in series, or 0 if there are no points in series.

    Returns this

    Object itself for fluent interface.

addArraysXY

  • addArraysXY(arrayX: number[], arrayY: number[]): this
  • Add two individual Arrays, one for X-values, and another for Y-values.

    Parameters

    • arrayX: number[]

      Array of X-values.

    • arrayY: number[]

      Array of Y-values. Length should be equal to length of arrayX.

    Returns this

    Object itself for fluent interface.

addMarker

  • Add Marker to the Series.

    Type parameters

    Parameters

    • cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType>

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

    Returns SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType>

    SeriesMarkerXY

attach

  • Attach object to an legendBox entry

    Parameters

    • entry: LegendBoxEntry

      Object which has to be attached

    • 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 previously pushed data points from the series.

     // Example usage
     LineSeries.clear()
    

    Returns this

    Object 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

getBoundaries

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

getCursorEnabled

  • getCursorEnabled(): boolean
  • Returns boolean

    Whether Cursor is enabled or not

getCursorInterpolationEnabled

  • getCursorInterpolationEnabled(): boolean
  • Get if cursor interpolates solved data-points along series by default.

    Returns boolean

    Boolean flag

getCursorResultTableFormatter

  • Get ResultTable Formatter.

    Returns SeriesXYFormatter

    Function which builds ResultTable content for SeriesXY.

getCursorSolveBasis

  • getCursorSolveBasis(): "nearest" | "nearest-x" | "nearest-y"
  • Get basis of solving data point nearest to a given location from this series.

    Default configuration is 'nearest'.

    Returns "nearest" | "nearest-x" | "nearest-y"

    String describing the desired solve behavior.

getHighlightOnHover

  • getHighlightOnHover(): boolean
  • Get boolean flag for whether object should highlight on mouse hover

    Returns boolean

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

getHighlighted

  • getHighlighted(): boolean
  • Returns boolean

    the state of highlighted flag

getIndividualPointRotationEnabled

  • getIndividualPointRotationEnabled(): boolean
  • Gets if individual point rotation is enabled or not.

    Returns boolean

getIndividualPointSizeEnabled

  • getIndividualPointSizeEnabled(): boolean
  • Gets if individual point sizing is enabled or not.

    Returns boolean

getIndividualPointValueEnabled

  • getIndividualPointValueEnabled(): boolean
  • Gets if individual point values are enabled or disabled.

    Returns boolean

getIsUnderMouse

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

    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
  • Get amount of points that series should keep around at all times (data-cleaning won't touch them).

    deprecated

    Will be removed in v4.0.

    Returns number | undefined

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

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.

getPointFillStyle

  • Get normal points fill style.

    Returns FillStyle

    Normal point fill style.

getPointFillStyleHighlight

  • Returns FillStyle

    Current highlight point fill style

getPointRotation

  • getPointRotation(): number
  • Get the current rotation of points.

    Returns number

getPointShape

  • Get shape of points.

    This is defined upon creation of series, and cannot be changed afterwards.

    Returns PointShape

    PointShape

getPointSize

  • getPointSize(): number
  • Returns number

    Size of point in pixels

getStrokeStyle

  • Get stroke style of Series.

    Returns SolidLine

    SolidLine object

getStrokeStyleHighlight

  • Get stroke style of Series when it is highlighted. Highlighting is activated by placing mouse on top / touching Series (if mouse-interactions are not disabled), or by using setHighlighted() method.

    Returns SolidLine

    SolidLine object

getXMax

  • getXMax(): number
  • Returns number

    Max X value of the series or 0 if series has no data.

getXMin

  • getXMin(): number
  • Returns number

    Min X value of the series or 0 if series has no data.

getYMax

  • getYMax(): number
  • Returns number

    Max Y value of the series or 0 if series has no data.

getYMin

  • getYMin(): number
  • Returns number

    Min Y value of the series or 0 if series has no data.

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    TODO: True for enabled and false for disabled

offHighlight

  • offHighlight(token: Token): boolean
  • Unsubscribe from Highlight object event. This is called whenever an object is highlighted

    Parameters

    • token: Token

      Token that was received when subscribing to the event.

    Returns boolean

    True if the unsubscription was successful.

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

onHighlight

  • onHighlight(handler: function): Token
  • Subscribe to highlight object event. This is called whenever an object is highlighted.

    Parameters

    • handler: function

      Function that is called when event is triggered.

        • Parameters

          • isHighlighted: boolean

          Returns void

    Returns Token

    Token that can be used to unsubscribe from the event.

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
  • Configure whether cursors should pick on this particular series or not.

     // Example, prevent chart auto cursor from snapping to a series.
     LineSeries.setCursorEnabled(false)
    

    Related API:

    • setCursorResultTableFormatter | configure formatting of result table contents, when this series is pointed.
    • setCursorSolveBasis | configure basis of finding nearest data point for the series ('nearest-x', 'nearest', etc.). This method is not available for all series types (more support will be added in near future).
    • setCursorInterpolationEnabled | configure whether cursor should interpolate the displayed data point between the two closest data points, or snap to the nearest real data point. This method is not available for all series types.
    • ChartXY.setAutoCursorMode | configure behavior when auto cursor is visible.

    Parameters

    • state: boolean

    Returns this

setCursorInterpolationEnabled

  • setCursorInterpolationEnabled(state: boolean): this
  • Set if cursor interpolates solved data-points along series by default.

     // Example, disable default interpolation of progressiveX point line series.
     const series = ChartXY.addPointLineSeries({
         dataPattern: {
             pattern: 'ProgressiveX'
         }
     })
         .setCursorInterpolationEnabled(false)
    

    Cursor interpolation is only supported with a collection of configuration combinations:

    • Freeform data + cursor solve basis = 'nearest'
    • ProgressiveX data + cursor solve basis = 'nearestX'
    • ProgressiveY data + cursor solve basis = 'nearestY'

    With any other combination, or if cursor intepolation is disabled, the closest actual data point will be selected.

    Related API:

    Related API:

    Parameters

    • state: boolean

      Boolean flag

    Returns this

    Object itself for fluent interface

setCursorResultTableFormatter

  • Configure formatting of Cursor ResultTable when pointing at this series.

     // Example usage
     LineSeries.setCursorResultTableFormatter((tableBuilder, series, x, y) => {
         return tableBuilder
             .addRow(`Pointing at`, '', series.getName())
             .addRow(`X:`, '', x.toFixed(1))
             .addRow(`Y:`, '', y.toFixed(1))
     })
    

    The general syntax of configuring ResultTable formatting is shared between all series types; You specify a callback function, which receives a TableContentBuilder. The contents of the table are then set using methods of the table builder:

     // Using TableContentBuilder.
     LineSeries.setCursorResultTableFormatter((tableBuilder, series, x, y) => {
         // addRow adds a list of strings to a new row in the table. Empty strings ('') will allocate any extra horizontal space within the row.
         tableBuilder
             .addRow('Item 0:', '', 'Value 0')
             .addRow('Item 1:', '', 'Value 1')
             .addRow('Long row that highlights the idea of empty strings')
    
         // After configuration, the table builder must be returned!
         return tableBuilder
     })
    

    The additional values that are supplied to the callback function, vary per series, refer to the series documentation of setCursorResultTableFormatter to learn the exact available information. For example, LineSeries receives three extra parameters:

    1. series | reference to the series itself.
    2. x | pointed data point X coordinate.
    3. y | pointed data point Y coordinate.

    Related API:

    Parameters

    Returns this

    Object itself

setCursorSolveBasis

  • setCursorSolveBasis(basis: "nearest" | "nearest-x" | "nearest-y"): this
  • Set basis of solving data point nearest to a given location from this series.

    Default configuration is 'nearest-x'.

     // Example, configure series cursor to snap to closest data point along both X and Y dimensions.
     PointLineSeries.setCursorSolveBasis('nearest')
    

    Related API:

    Parameters

    • basis: "nearest" | "nearest-x" | "nearest-y"

      String describing the desired solve behavior.

    Returns this

setDataCleaning

  • setDataCleaning(arg: undefined): this
  • setDataCleaning(arg: object): this
  • Disable automatic data cleaning.

     // Example syntax, disable data cleaning.
     series.setDataCleaning(undefined)
    

    Parameters

    • arg: undefined

      Data cleaning configuration.

    Returns this

    Object itself for fluent interface.

  • Enable automatic data cleaning by minDataPointCount configuration.

    Specifying minDataPointCount enables lazy cleaning of data that is outside view as long as the remaining data amount doesn't go below the configured threshold.

     // Example syntax for specifying minDataPointCount
     series.setDataCleaning({ minDataPointCount: 10000 })
    

    Usage of minDataPointCount is recommended in most common applications that require automatic data cleaning. The actual value is often not very particular, just setting it above 0 to enable it is usually enough (lazy data cleaning of out of view data).

     // Example, enable lazy data cleaning of out of view data.
     series.setDataCleaning({ minDataPointCount: 1 })
    

    Parameters

    • arg: object

      Data cleaning configuration.

      • minDataPointCount: number | undefined

    Returns this

    Object itself for fluent interface.

setHighlightOnHover

  • setHighlightOnHover(state: boolean): this
  • Set highlight on mouse hover enabled or disabled.

    Mouse interactions have to be enabled on the component for this to function as expected. See setMouseInteractions for more information.

    Parameters

    • state: boolean

      True if highlighting on mouse hover, false if no highlight on mouse hover

    Returns this

    Object itself for fluent interface.

setHighlighted

  • setHighlighted(highlight: boolean): this
  • Enable or disable forced highlighting of series

    Parameters

    • highlight: boolean

      True for enabled and false for disabled

    Returns this

    Series itself for fluent interface

setIndividualPointRotationEnabled

  • setIndividualPointRotationEnabled(enabled: boolean): this
  • Enable or disable individual point rotation.

    When enabled, rotation for each point can be provided with the location of the point.

    pointSeries.add({x: 1, y: 2, rotation: 45 })
    

    Parameters

    • enabled: boolean

      Boolean state for individual point size enabled

    Returns this

setIndividualPointSizeEnabled

  • setIndividualPointSizeEnabled(enabled: boolean): this
  • Enable or disable individual point sizing.

    When enabled, size for each point can be provided with the location of the point.

    pointSeries.add({x: 1, y: 2, size: 10 })
    

    Parameters

    • enabled: boolean

      Boolean state for individual point size enabled

    Returns this

setIndividualPointValueEnabled

  • setIndividualPointValueEnabled(enabled: boolean): this
  • Enable or disable individual point value attributes.

    When enabled, each added data point can be associated with a numeric value attribute.

     PointLineSeries.add({ x: 1, y: 2, value: 10 })
    

    Can be used for dynamic per data point coloring when points are styled with PalettedFill. See setPointFillStyle.

    Parameters

    • enabled: boolean

      Individual point values enabled or disabled.

    Returns this

setMaxPointCount

  • setMaxPointCount(maxPointCount?: undefined | number): this
  • Configure automatic data cleaning by maxPointCount. This allows the cleaning of all excess data points that are outside view, so that after cleaning at least maxPointCount data points are retained. Essentially it configures the head length of a series.

     // Example, progressive X line series with automatic data cleaning.
     const series = ChartXY.addLineSeries({
         dataPattern: {
             pattern: 'ProgressiveX'
         }
     })
         // Keep at least 1000 data points in series, otherwise excess out of view data can be cleaned for more memory.
         .setMaxPointCount(1000)
    
    // Setup automatically scrolling X Axis.
    chart.getDefaultAxisX().setScrollStrategy(AxisScrollStrategies.progressive).setInterval(0, 1000)
    
     // Continously stream data into series.
     let x = 0
     setInterval(() => {
         const newDataPoints = []
         for (let i = 0; i <= 10; i += 1) {
             newDataPoints.push({ x: x + i, y: Math.random() * 100 })
         }
         x += newDataPoints.length
         series.add(newDataPoints)
     }, 1000 / 60)
    

    For progressive Series, there is another way to enable automatic data cleaning: setDataCleaningThreshold.

    Enabling automatic data cleaning is crucial in applications that run for a long time, or even forever, because it allows clearing memory for allocating new data points.

    deprecated

    Will be removed in v4.0 in favour of setDataCleaning.

    Parameters

    • maxPointCount: undefined | number

      Configuration for automatic data cleaning by maxPointCount. If undefined or 0 is passed, automatic data cleaning by maxPointCount will be disabled.

    Returns this

    Object itself for fluent interface.

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Set component mouse interactions enabled or disabled.

    Disabling mouse interactions means that the objects below this component can be interacted through it.

    Possible side-effects from disabling mouse interactions:

    • Mouse events are not triggered. For example, onMouseMove.
    • Mouse driven highlighting will not work.

    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

setPointFillStyle

  • Set point fill style of Series. Use IndividualPointFill to enable individual coloring of points.

    Example usage:

    // Create a new style
    PointLineSeries.setPointFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
    // Change transparency
    PointLineSeries.setPointFillStyle((solidFill) => solidFill.setA(80))
    // Set hidden
    PointLineSeries.setPointFillStyle(emptyFill)
    

    Parameters

    Returns this

    Series itself for fluent interface.

setPointFillStyleHighlight

  • Set point fill style of Series when it is highlighted. Use IndividualPointFill to enable individual coloring of points.

    Example usage:

    // Create a new style
    PointLineSeries.setPointFillStyleHighlight(new SolidFill({ color: ColorHEX('#F00') }))
    // Change transparency
    PointLineSeries.setPointFillStyleHighlight((solidFill) => solidFill.setA(80))
    // Set hidden
    PointLineSeries.setPointFillStyleHighlight(emptyFill)
    // Automatic
    PointLineSeries.setPointFillStyleHighlight(undefined)
    

    Parameters

    • value: FillStyle | ImmutableMutator<FillStyle> | undefined

      Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value or undefined for automatic value based on normal style.

    Returns this

    Series itself for fluent interface.

setPointRotation

  • setPointRotation(angle: number): this
  • Set the rotation of points.

    Parameters

    • angle: number

      Rotation angle in degrees

    Returns this

setPointSize

  • setPointSize(size: number): this
  • Set size of point in pixels

    Parameters

    • size: number

      Size of point in pixels

    Returns this

    Object itself for fluent interface

setStrokeStyle

  • Set stroke style of Series.

    Example usage:

    // Specified LineStyle
    LineSeries.setStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
    // Changed thickness
    LineSeries.setStrokeStyle((solidLine) => solidLine.setThickness(5))
    // Hidden must be done with dispose() method, emptyLine is not supported
    

    Parameters

    Returns this

    Chart itself

setStrokeStyleHighlight

  • Set stroke style of Series when it is highlighted. Highlighting is activated by placing mouse on top / touching Series (if mouse-interactions are not disabled), or by using setHighlighted() method.

    Example usage:

    // Specified LineStyle
    LineSeries.setStrokeStyleHighlight(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
    // Changed thickness
    LineSeries.setStrokeStyleHighlight((solidLine) => solidLine.setThickness(5))
    // Hidden must be done with transparentLine, emptyLine is not supported
    LineSeries.setStrokeStyleHighlight(transparentLine)
    // Automatic
    LineSeries.setStrokeStyleHighlight(undefined)
    

    Parameters

    • value: SolidLine | ImmutableMutator<SolidLine> | undefined

      Either a SolidLine object or a function, which will be used to modify current value or undefined for automatic value based on normal style.

    Returns this

    Chart itself

solveNearestFromScreen

  • solveNearestFromScreen(location: Point, interpolate: boolean): undefined | CursorPoint
  • Solves the nearest datapoint to a given coordinate on screen.

    Parameters

    • location: Point

      Location on screen

    • interpolate: boolean

    Returns undefined | CursorPoint

    Undefined or data-structure for positioning of cursors

solveNearestFromSegment

  • solveNearestFromSegment(location: Point, segment: LineSet | PointSet, interpolate: boolean): undefined | CursorPoint
  • Solves the nearest datapoint to a given coordinate on a screen from a specific segment.

    Parameters

    • location: Point

      Location on screen

    • segment: LineSet | PointSet

      Segment to solve from

    • interpolate: boolean

    Returns undefined | CursorPoint

    Undefined or data-structure for positioning of cursors