Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChartXY<CursorPointMarkerType, CursorResultTableBackgroundType>

Chart type for visualizing data between two dimensions, X and Y. It has built-in Axis functionality, and supports a large set of series types.

ChartXY can be created in two different ways - to learn more about creation time configuration of ChartXY, please refer to:

ChartXY features

  1. Axes

ChartXY always has at least one X and Y axes.

The default Axis can be referenced with ChartXY.getDefaultAxisX and ChartXY.getDefaultAxisY. See Axis for features of axis.

ChartXY doesn't have a limit on number of axes. Additional axes can be created with ChartXY.addAxisX and ChartXY.addAxisY. Multiple Axes can be stacked on top of another, and axes can be positioned on either side of the chart (left, right, top, bottom, see AxisOptions).

  1. Series

ChartXY supports a variety of different series types, each with their own method of data visualization. Series are created with ChartXY.add...Series methods, for example:

When created, a series is always attached to a pair of X and Y Axes. The Axes can be specified by user, or the chart default Axes will be used.

  1. AutoCursor

Auto cursor is activated when the users mouse is over the chart. It automatically solves the nearest data point to the mouse, and displays it to the user over the chart in a result table.

Auto cursor can be configured in a variety of ways; on chart level, the cursor behavior and style can be specified using:

On series level, the cursor behavior can be configured individually for each series:

  1. LegendBox

ChartXY has built-in legend box functionality for listing the series names in a user interface. The legend box also provides additional logic, like hiding selected series by clicking on the legend box, and visualizing color look-up tables (LUT) in applications where they are used.

Legend box is added using ChartXY.addLegendBox.

  1. Title

ChartXY has a built-in title component, which can be configured using ChartXY.setTitle.

  1. Backgrounds

ChartXY contains two separate background components:

  1. UI Elements

Custom UI elements can be placed on ChartXY in same way as all other charts, using ChartXY.addUIElement.

Other APIs worthy of mention:

Index

Properties

Methods

Properties

Readonly engine

engine : PublicEngine

Public, safe interface for Panels rendering engine.

pixelScale

pixelScale : LinearScaleXY

Scale for panel area in pixels.

uiScale

uiScale : LinearScaleXY

Scale for panel area in percentages (0-100).

Methods

addAreaRangeSeries

  • Method for adding a new AreaRangeSeries to the chart. This series type is used for visualizing bands of data between two curves of data. AreaRangeSeries is optimized for large amounts of data - here are some reference specs to give an idea:

    • A static data set in millions range is rendered in a matter of seconds.
    • With streaming data, tens of thousands data points can be streamed in every second, while retaining an interactive document.

    To learn more about its features and usage, refer to AreaRangeSeries.

    Readonly configuration:

    Some properties of AreaRangeSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addAreaRangeSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to AreaRangeSeriesOptions.

    Parameters

    Returns AreaRangeSeries

    New series.

addAreaSeries

  • Method for adding a new AreaSeries to the chart. This series type is used for visualizing area between a static base line and supplied curve data. AreaSeries is optimized for large amounts of data - here are some reference specs to give an idea:

    • A static data set in millions range is rendered in a matter of seconds.
    • With streaming data, tens of thousands data points can be streamed in every second, while retaining an interactive document.

    To learn more about its features and usage, refer to AreaSeries.

    Readonly configuration:

    Some properties of AreaSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addAreaSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to AreaSeriesOptions.

    Return type:

    AreaSeries return type depends on supplied readonly configuration! Specifically, AreaSeriesOptions.type.

    Configuration type Return series type
    undefined or omitted AreaSeriesPositive
    AreaSeriesTypes.Positive AreaSeriesPositive
    AreaSeriesTypes.Negative AreaSeriesNegative
    AreaSeriesTypes.Bipolar AreaSeriesBipolar

    Type parameters

    Parameters

    • options: AreaSeriesOptions<AreaType>

      Optional object with readonly configuration arguments for AreaSeries.

    Returns InstanceType<AreaType>

    New series.

addAxisX

  • Add new X Axis to the Chart.

    Example usage:

    • Configure Axis on opposite side to default configuration (right).
     ChartXY.addAxisX({
         opposite: true,
     })
    
    • Configure Axis as logarithmic (10 base).
     ChartXY.addAxisX({
         type: 'logarithmic',
         base: 10,
     })
    
    • Configure Axis as logarithmic (natural base).
     ChartXY.addAxisX({
         type: 'logarithmic',
         base: 'natural',
     })
    

    NOTE: Not all series types support logarithmic axes! Attaching a non-supported Series will crash the application.

    List of series that support logarithmic Axes:

    List of series that do not support logarithmic Axes:

    Parameters

    • opts: AxisOptions

      Optional AxisOptions object for specifying Axis configurations that can't be changed during runtime.

    Returns Axis

    Axis object.

addAxisY

  • Add new Y Axis to the Chart.

    Example usage:

    • Configure Axis on opposite side to default configuration (right).
     ChartXY.addAxisY({
         opposite: true,
     })
    
    • Configure Axis as logarithmic (10 base).
     ChartXY.addAxisY({
         type: 'logarithmic',
         base: 10,
     })
    
    • Configure Axis as logarithmic (natural base).
     ChartXY.addAxisY({
         type: 'logarithmic',
         base: 'natural',
     })
    

    NOTE: Not all series types support logarithmic axes! Attaching a non-supported Series will crash the application.

    List of series that support logarithmic Axes:

    List of series that do not support logarithmic Axes:

    Parameters

    • opts: AxisOptions

      Optional AxisOptions object for specifying Axis configurations that can't be changed during runtime.

    Returns Axis

    Axis object.

addBoxSeries

  • Method for adding a new BoxSeries to the chart. This series type is used for visualizing data groups through quartiles.

    To learn more about its features and usage, refer to BoxSeries.

    Readonly configuration:

    Some properties of BoxSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addBoxSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to BoxSeriesOptions.

    Type parameters

    • FigureType: BoxFigure = BoxAndWhiskers

    Parameters

    • options: BoxSeriesOptions<FigureType>

      Optional object with readonly configuration arguments for BoxSeries.

    Returns BoxSeries<FigureType>

    New series.

addChartMarkerXY

  • Create new XY Chart Marker to be rendered as part of UI.

    Type parameters

    Parameters

    • cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType>

      Optional StaticCursorBuilderXY to customize structure/style of chartMarker. MarkerBuilders.XY can be used to build a custom one from scratch.

    • axisX: Axis

      Optional arbitrary X axis to attach ChartMarker on

    • axisY: Axis

      Optional arbitrary Y axis to attach ChartMarker on

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

    Created ChartMarker

addEllipseSeries

  • Method for adding a new EllipseSeries to the chart. This series type visualizes a collection of ellipses.

    To learn more about its features and usage, refer to EllipseSeries.

    Readonly configuration:

    Some properties of EllipseSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addEllipseSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to EllipseSeriesOptions.

    Parameters

    • options: EllipseSeriesOptions

      Optional object with readonly configuration arguments for EllipseSeries.

    Returns EllipseSeries

    New series.

addHeatmapGridSeries

  • Add a Series for visualizing a Heatmap Grid with a static column and grid count. Has API for fast modification of cell values.

    HeatmapGridSeries is optimized for massive amounts of data - here are some reference specs on average PC to give an idea:

    • Heatmap Chart with 1 million data points (1000x1000) is cold started in ~0.3 seconds.
    • Heatmap Chart with 1 million data points (1000x1000) is re-populated (change data set) in ~0.050 seconds.
    • Heatmap Chart with 16 million data points (4000x4000) is cold started in ~2.0 seconds.
    • Heatmap Chart with 16 million data points (4000x4000) is re-populated (change data set) in ~0.5 seconds.

    HeatmapGridSeries max data amount is entirely restricted by the client hardware RAM and more specifically amount of RAM usable by the context running LightningChart JS. If by increasing the amount of columns and rows you encounter suddenly weak performance, it is likely that there is not enough RAM memory available.

    To learn more about its features and usage, refer to HeatmapGridSeriesIntensityValues.

    Readonly configuration:

    Some properties of HeatmapSeries can only be configured when it is created. Some of these arguments are mandatory, while some are optional. They are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addHeatmapGridSeries({
         columns: 100,
         rows: 100
     })
    

    To learn about available properties, refer to HeatmapGridSeriesOptions.

    Heatmap data format is specified with heatmapDataType: 'intensity' property; in this case, each cell of the heatmap is associated with a numeric intensity value, which can be used in conjuction with a Color look up table (LUT).

    For scrolling heatmap grids, see addHeatmapScrollingGridSeries.

    Parameters

    Returns HeatmapGridSeriesIntensityValues

    Heatmap Grid Series.

addHeatmapScrollingGridSeries

  • Add a Series for visualizing a Heatmap Grid, with API for pushing data in a scrolling manner (append new data on top of existing data).

    HeatmapScrollingGridSeries is optimized for massive amounts of data - here are some reference specs on average PC to give an idea:

    • Scrolling Heatmap Chart with 2 million incoming data points per second (rows: 2048, 1000 columns/s) runs consistently and smoothly with 60 FPS and no stuttering. CPU usage stays easily below 40%.
    • Scrolling Heatmap Chart with 8 million incoming data points per second (rows: 4096, 2000 columns/s) runs consistently and smoothly with 60 FPS and minor stuttering.

    HeatmapScrollingGridSeries max data amount is entirely restricted by the client hardware RAM and more specifically amount of RAM usable by the context running LightningChart JS. If performance suddenly plummets at some approximate data threshold, then it is likely that there is not enough RAM available. Use data cleaning configuration and suitable Axis intervals to adjust to your hardware limitations.

    To learn more about its features and usage, refer to HeatmapScrollingGridSeriesIntensityValues.

    Readonly configuration:

    Some properties of ScrollingHeatmapSeries can only be configured when it is created. Some of these arguments are mandatory, while some are optional. They are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addHeatmapGridSeries({
         resolution: 100
     })
    

    To learn about available properties, refer to HeatmapScrollingGridSeriesOptions.

    Heatmap data format is specified with heatmapDataType: 'intensity' property; in this case, each cell of the heatmap is associated with a numeric intensity value, which can be used in conjuction with a Color look up table (LUT).

    For static heatmap grids, see addHeatmapGridSeries.

    Parameters

    Returns HeatmapScrollingGridSeriesIntensityValues

    Scrolling Heatmap Grid Series.

addHeatmapSeries

  • Method for adding a new HeatmapSeries to the chart. This series type is used for visualizing multi-dimensional intensity matrixes.

    NOTE: this method exists mainly for keeping backwards compatibility. New, optimized 2D heatmap series have been already published and can be created with addHeatmapGridSeries and addHeatmapScrollingGridSeries methods.

    This method will be removed in next major release (v4.0), at which point all migrations to newest version will have to use the new optimized features instead.

    HeatmapSeries is optimized for large amounts of data - here are some reference specs to give an idea:

    • A static data set in 1000 x 1000 grid range (million intensity values) is rendered in a matter of seconds.

    To learn more about its features and usage, refer to IntensitySeries.

    Readonly configuration:

    Some properties of HeatmapSeries can only be configured when it is created. Some of these arguments are mandatory, while some are optional. They are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addHeatmapSeries({
         columns: 100,
         rows: 100,
         start: { x: 0, y: 0 },
         end: { x: 100, y: 100 },
         pixelate: true,
     })
    

    To learn about available properties, refer to IntensitySeriesOptions.

    Return type:

    HeatmapSeries return type depends on supplied readonly configuration! Specifically, IntensitySeriesOptions.type.

    Configuration type Return series type
    undefined or omitted IntensityGridSeries
    IntensitySeriesTypes.Grid IntensityGridSeries
    IntensitySeriesTypes.Mesh IntensityMeshSeries
    deprecated

    Will be removed in v4.0 in favor of new optimized Heatmap Series.

    Type parameters

    Parameters

    • options: IntensitySeriesOptions<IntensityType>

      Optional object with readonly configuration arguments for HeatmapSeries.

    Returns InstanceType<IntensityType>

    New series.

addLegendBox

  • Add a legendbox.

    Legendbox is a type of UI element, that floats inside the chart/component it is created inside. It can be freely moved around with user interactions, as well as positioned in application code.

    The purpose of legendbox is to describe the series and other visual components of the chart, by displaying their names and colors. Hovering over a series' legendbox entry will highlight that series, and clicking on the entry will toggle that series' visibility.

    Legendbox alignment:

    Alignment of legendbox can be selected by supplying one of the available LegendBoxBuilders to addLegendBox:

     // Default (vertical) LegendBox.
     const legendBox = ChartXY.addLegendBox()
    
     // Horizontal LegendBox.
     const horizontalLegendBox = ChartXY.addLegendBox(LegendBoxBuilders.HorizontalLegendBox)
    

    Custom Legendbox positioning:

    By default LegendBoxes are placed on the right side, or bottom of the chart (depending on alignment).

    A custom location can be configured with UIElement API:

    Position coordinate system is specified when creating legendbox.

    1. LegendBox with default positioning coordinate system.
     addLegendBox( LegendBoxBuilders.VerticalLegendBox )
         // Position = [0, 100] as percentages.
         .setPosition({ x: 50, y: 50 })
    
    1. Position in pixel coordinate system.
     addLegendBox( LegendBoxBuilders.VerticalLegendBox, chart.pixelScale )
         // Position = pixels.
         .setPosition({ x: 300, y: 100 })
    
    1. Position on Axes.
     addLegendBox( LegendBoxBuilders.VerticalLegendBox, { x: chartXY.getDefaultAxisX(), y: chartXY.getDefaultAxisY() } )
         // Position = Axis values.
         .setPosition({ x: 5, y: 5 })
    

    For more information on LegendBox features, and usage, see LegendBox.

    Parameters

    • builder: UILegendBoxBuilder

      LegendBoxBuilder. If omitted, VerticalLegendBox will be selected. Use LegendBoxBuilders for selection.

    • scale: UserScaleDefinition

      Optional parameter for altering the coordinate system used for positioning the LegendBox. Defaults to whole Chart in percentages [0, 100].

    Returns LegendBox & UIElement

    Object with two interfaces: LegendBox and UIElement.

addLineSeries

  • Method for adding a new LineSeries to the chart. This series type visualizes a list of Points (pair of X and Y coordinates), with a continuous stroke. LineSeries is optimized for massive amounts of data - here are some reference specs to give an idea:

    • A static data set in tens of millions range is rendered in a matter of seconds.
    • With streaming data, even millions of data points can be streamed in every second, while retaining an interactive document.

    To learn more about its features and usage, refer to LineSeries.

    Readonly configuration:

    Some properties of LineSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const lineSeries = ChartXY.addLineSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to LineSeriesOptions.

    Parameters

    • options: LineSeriesOptions

      Optional object with readonly configuration arguments for LineSeries.

    Returns LineSeries

    New series.

addOHLCSeries

  • addOHLCSeries(options?: OHLCSeriesOptions<PositiveFigure, NegativeFigure, OHLCSeriesType>): OHLCSeriesType
  • Method for adding a new OHLCSeries to the chart. This series type is used for visualizing trading figures.

    To learn more about its features and usage, refer to OHLCSeries.

    Readonly configuration:

    Some properties of OHLCSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addOHLCSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to OHLCSeriesOptions.

    Type parameters

    • PositiveFigure: OHLCFigure = OHLCCandleStick

    • NegativeFigure: OHLCFigure = PositiveFigure

    • OHLCSeriesType: OHLCSeriesTypes<PositiveFigure, NegativeFigure> = OHLCSeriesTraditional<PositiveFigure, NegativeFigure>

    Parameters

    • options: OHLCSeriesOptions<PositiveFigure, NegativeFigure, OHLCSeriesType>

      Optional object with readonly configuration arguments for OHLCSeries.

    Returns OHLCSeriesType

    New series.

addOnScreenMenu

addPointLineSeries

  • Method for adding a new PointLineSeries to the chart. This series type visualizes a list of Points (pair of X and Y coordinates), with a continuous stroke and configurable markers over each coordinate. PointLineSeries is optimized for massive amounts of data - here are some reference specs to give an idea:

    • A static data set in tens of millions range is rendered in a matter of seconds.
    • With streaming data, even millions of data points can be streamed in every second, while retaining an interactive document.

    To learn more about its features and usage, refer to PointLineSeries.

    Readonly configuration:

    Some properties of PointLineSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const pointLineSeries = ChartXY.addPointLineSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to PointLineSeriesOptions.

    Parameters

    Returns PointLineSeries

    New series.

addPointSeries

  • Method for adding a new PointSeries to the chart. This series type visualizes a list of Points (pair of X and Y coordinates), with configurable markers over each coordinate. PointSeries is optimized for massive amounts of data - here are some reference specs to give an idea:

    • A static data set in tens of millions range is rendered in a matter of seconds.
    • With streaming data, even millions of data points can be streamed in every second, while retaining an interactive document.

    To learn more about its features and usage, refer to PointSeries.

    Readonly configuration:

    Some properties of PointSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const pointSeries = ChartXY.addPointSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to PointSeriesOptions.

    Parameters

    • options: PointSeriesOptions

      Optional object with readonly configuration arguments for PointSeries.

    Returns PointSeries

    New series.

addPolygonSeries

  • Method for adding a new PolygonSeries to the chart. This series type visualizes a collection of polygons.

    To learn more about its features and usage, refer to PolygonSeries.

    Readonly configuration:

    Some properties of PolygonSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const polygonSeries = ChartXY.addPolygonSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to PolygonSeriesOptions.

    Parameters

    • options: PolygonSeriesOptions

      Optional object with readonly configuration arguments for PolygonSeries.

    Returns PolygonSeries

    New series.

addRectangleSeries

  • Method for adding a new RectangleSeries to the chart. This series type visualizes a collection of rectangles.

    To learn more about its features and usage, refer to RectangleSeries.

    Readonly configuration:

    Some properties of RectangleSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const rectSeries = ChartXY.addRectangleSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to RectangleSeriesOptions.

    Parameters

    Returns RectangleSeries

    New series.

addSegmentSeries

  • Method for adding a new SegmentSeries to the chart. This series type visualizes a collection of line segments (A -> B).

    To learn more about its features and usage, refer to SegmentSeries.

    Readonly configuration:

    Some properties of SegmentSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const series = ChartXY.addSegmentSeries({
         // Specify non-default X Axis to attach series to.
         xAxis: myNonDefaultAxisX
     })
    

    To learn about available properties, refer to SegmentSeriesOptions.

    Parameters

    • options: SegmentSeriesOptions

      Optional object with readonly configuration arguments for SegmentSeries.

    Returns SegmentSeries

    New series.

addSplineSeries

  • Method for adding a new SplineSeries to the chart. This series type visualizes a list of Points (pair of X and Y coordinates), with a smoothed curve stroke + point markers over each data point.

    To learn more about its features and usage, refer to SplineSeries.

    Readonly configuration:

    Some properties of SplineSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const splineSeries = ChartXY.addSplineSeries({
         // Select shape of point markers.
         pointShape: PointShape.Circle
     })
    

    To learn about available properties, refer to SplineSeriesOptions.

    Parameters

    • options: SplineSeriesOptions

      Optional object with readonly configuration arguments for SplineSeries.

    Returns SplineSeries

    New series.

addStepSeries

  • Method for adding a new StepSeries to the chart. This series type visualizes a list of Points (pair of X and Y coordinates), with a stepped stroke + point markers over each data point.

    Possible step modes are: 'before', 'middle' and 'after'.

    To learn more about its features and usage, refer to StepSeries.

    Readonly configuration:

    Some properties of StepSeries can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

     // Example,
     const stepSeries = ChartXY.addStepSeries({
         // Select shape of point markers.
         pointShape: PointShape.Circle
     })
    

    To learn about available properties, refer to StepSeriesOptions.

    Parameters

    • options: StepSeriesOptions

      Optional object with readonly configuration arguments for StepSeries.

    Returns StepSeries

    New series.

addUIElement

  • Add a stand-alone UIElement using a builder.

    Example usage:

    1. TextBox with default positioning coordinate system.
     addUIElement( UIElementBuilders.TextBox )
         // Position = [0, 100] as percentages.
         .setPosition({ x: 50, y: 50 })
    
    1. Position in pixel coordinate system.
     addUIElement( UIElementBuilders.TextBox, chart.pixelScale )
         // Position = pixels.
         .setPosition({ x: 300, y: 100 })
    
    1. Position on Axes.
     addUIElement( UIElementBuilders.TextBox, { x: chartXY.getDefaultAxisX(), y: chartXY.getDefaultAxisY() } )
         // Position = Axis values.
         .setPosition({ x: 5, y: 5 })
    

    Type parameters

    • UIElementType: UIPart = UITextBox

      Type of UIElement that is specified by 'builder'-parameter.

    Parameters

    • builder: UIElementBuilder<UIElementType>

      UIElementBuilder. If omitted, TextBoxBuilder will be selected. Use UIElementBuilders for selection.

    • scale: UserScaleDefinition

      Optional parameter for altering the coordinate system used for positioning the UIElement. Defaults to whole Chart in percentages [0, 100].

    Returns UIElementType & UIElement

    Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

  • disableAnimations(): this
  • Disable all animations for the chart.

    After calling this function, animations (Zooming, scaling) for all Axes will be disabled. Animations must be recreated manually afterwards.

    deprecated

    Deprecated in v3.1.0. Will be removed in v4.0.0. Use setAnimationsEnabled instead.

    Returns this

    Chart itself for fluent interface.

dispose

  • dispose(): this
  • Permanently dispose the component.

    To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.

    let chart = ...ChartXY()
    let axisX = chart.getDefaultAxisX()
    // Dispose Chart, and remove all references so that they can be garbage-collected.
    chart.dispose()
    chart = undefined
    axisX = undefined
    

    Returns this

    Object itself for fluent interface

forEachAxis

  • forEachAxis(clbk: function): void
  • Operate on each axis of chart, x and y

    Parameters

    • clbk: function

      Callback function for axis

        • Parameters

          Returns void

    Returns void

forEachAxisX

  • forEachAxisX(clbk: function): void
  • Operate on each x axis of chart

    Parameters

    • clbk: function

      Callback function for axis

        • Parameters

          Returns void

    Returns void

forEachAxisY

  • forEachAxisY(clbk: function): void
  • Operate on each y axis of chart

    Parameters

    • clbk: function

      Callback function for axis

        • Parameters

          Returns void

    Returns void

getAnimationsEnabled

  • getAnimationsEnabled(): boolean
  • Get animations disable/enable state.

    Returns boolean

    Animations default state.

getAutoCursor

  • getAutoCursor(): AutoCursorXY<CursorPointMarkerType, CursorResultTableBackgroundType>
  • Get reference to charts AutoCursor.

    See AutoCursorXY for all available methods for configuring the AutoCursor.

    Returns AutoCursorXY<CursorPointMarkerType, CursorResultTableBackgroundType>

    AutoCursor.

getAutoCursorMode

getAxes

  • getAxes(...axisPositions: AxisPosition[]): Axis[]
  • Parameters

    • ...axisPositions: AxisPosition[]

      array of axis positions which have to be included to the output empty array indicates all of positions are included

    Returns Axis[]

    An array of axis

getBackgroundFillStyle

  • Get fillstyle of chart background.

    Returns FillStyle

    FillStyle

getBackgroundStrokeStyle

  • Get stroke style of chart background.

    Returns LineStyle

    LineStyle

getDefaultAxisX

  • getDefaultAxisX(): Axis
  • Get reference to the default X Axis of the ChartXY.

    This will always return reference to the X Axis that is closest to the chart (starting from bottom). The user can safely destroy the default Axis (with Axis.dispose, as long as there are no series attached to it).

    Returns Axis

    Default X Axis of chart.

getDefaultAxisY

  • getDefaultAxisY(): Axis
  • Get reference to the default Y Axis of the ChartXY.

    This will always return reference to the Y Axis that is closest to the chart (starting from left). The user can safely destroy the default Axis (with Axis.dispose, as long as there are no series attached to it).

    Returns Axis

    Default Y Axis of chart.

getFittingRectangleFillStyle

  • Get fillStyle for fitting rectangle when fitting.

    Returns FillStyle

    FillStyle

getFittingRectangleStrokeStyle

  • getFittingRectangleStrokeStyle(): LineStyle
  • Get stroke style for fitting rectangle when fitting.

    Returns LineStyle

    LineStyle

getMinimumSize

  • getMinimumSize(): Point | undefined
  • Get minimum size of Panel. Depending on the type of class this value might be automatically computed to fit different elements.

    Returns Point | undefined

    Vec2 minimum size or undefined if unimplemented

getMouseInteractionPan

  • getMouseInteractionPan(): boolean
  • Get is mouse-interaction enabled: Panning axes by dragging mouse on frame.

    Returns boolean

    Boolean flag

getMouseInteractionRectangleFit

  • getMouseInteractionRectangleFit(): boolean
  • Get is mouse-interaction enabled: Fitting axes by capturing rectangle on frame.

    Returns boolean

    Boolean flag

getMouseInteractionRectangleZoom

  • getMouseInteractionRectangleZoom(): boolean
  • Get is mouse-interaction enabled: Zooming axes by capturing rectangle on frame.

    Returns boolean

    Boolean flag

getMouseInteractionWheelZoom

  • getMouseInteractionWheelZoom(): boolean
  • Get is mouse-interaction enabled: Zooming axes with mouse-wheel on frame.

    Returns boolean

    Boolean flag

getMouseInteractionsWhileScrolling

  • getMouseInteractionsWhileScrolling(): boolean
  • Get if mouse and cursor interactions are disabled during scrolling animations for the chart's series.

    Returns boolean

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

getMouseInteractionsWhileZooming

  • getMouseInteractionsWhileZooming(): boolean
  • Get if mouse and cursor interactions are disabled during zooming animations for the chart's series.

    Returns boolean

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

getPadding

  • Get padding around Chart in pixels.

    Returns Margin

    Padding datastructure

getSeries

  • getSeries(): SeriesXY[]
  • Get series of a chart

    Returns SeriesXY[]

    series

getSeriesBackgroundFillStyle

  • Get FillStyle of Series background area (area behind series).

    Returns FillStyle

    FillStyle

getSeriesBackgroundStrokeStyle

  • getSeriesBackgroundStrokeStyle(): LineStyle
  • Get Stroke style of Series background area (area behind series).

    Returns LineStyle

    LineStyle

getTheme

  • Returns the Theme currently being used.

    Returns Theme

    An object containing the Theme.

getTitle

  • getTitle(): string
  • Get text of Chart title.

    Returns string

    Chart title as a string.

getTitleFillStyle

  • Get fill style of Chart Title.

    Returns FillStyle

    FillStyle object

getTitleFont

  • Get font of Chart title.

    Returns FontSettings

    FontSettings object

getTitleMarginBottom

  • getTitleMarginBottom(): number
  • Returns number

    Padding after Chart title

getTitleMarginTop

  • getTitleMarginTop(): number
  • Returns number

    Padding before Chart title

getTitleRotation

  • getTitleRotation(): number
  • Get rotation of Chart title.

    Returns number

    Rotation in degrees

getZoomingRectangleFillStyle

  • Get fillStyle for zooming rectangle when zooming.

    Returns FillStyle

    FillStyle

getZoomingRectangleStrokeStyle

  • getZoomingRectangleStrokeStyle(): LineStyle
  • Get stroke style for zooming rectangle when zooming.

    Returns LineStyle

    LineStyle

offBackgroundMouseClick

  • offBackgroundMouseClick(token: Token): boolean
  • Remove subscription from mouse-click event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseDoubleClick

  • offBackgroundMouseDoubleClick(token: Token): boolean
  • Remove subscription from mouse-doubleClick event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseDown

  • offBackgroundMouseDown(token: Token): boolean
  • Remove subscription from mouse-down event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseDrag

  • offBackgroundMouseDrag(token: Token): boolean
  • Remove subscription from mouse-drag event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseDragStart

  • offBackgroundMouseDragStart(token: Token): boolean
  • Remove subscription from mouse-dragStart event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseDragStop

  • offBackgroundMouseDragStop(token: Token): boolean
  • Remove subscription from mouse-dragStop event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseEnter

  • offBackgroundMouseEnter(token: Token): boolean
  • Remove subscription from mouse-enter event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseLeave

  • offBackgroundMouseLeave(token: Token): boolean
  • Remove subscription from mouse-leave event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseMove

  • offBackgroundMouseMove(token: Token): boolean
  • Remove subscription from mouse-move event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseTouchStart

  • offBackgroundMouseTouchStart(token: Token): boolean
  • Remove subscription from touch-start event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseUp

  • offBackgroundMouseUp(token: Token): boolean
  • Remove subscription from mouse-up event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundMouseWheel

  • offBackgroundMouseWheel(token: Token): boolean
  • Remove subscription from mouse-wheel event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundTouchEnd

  • offBackgroundTouchEnd(token: Token): boolean
  • Remove subscription from touch-end event on Panel background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offBackgroundTouchMove

  • offBackgroundTouchMove(token: Token): boolean
  • Remove subscription from touch-move event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

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

offResize

  • offResize(token: Token): boolean
  • Remove event listener from resize 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

offSeriesBackgroundMouseClick

  • offSeriesBackgroundMouseClick(token: Token): boolean
  • Remove event listener from mouse-click event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseDoubleClick

  • offSeriesBackgroundMouseDoubleClick(token: Token): boolean
  • Remove event listener from mouse-doubleClick event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseDown

  • offSeriesBackgroundMouseDown(token: Token): boolean
  • Remove event listener from mouse-down event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseDrag

  • offSeriesBackgroundMouseDrag(token: Token): boolean
  • Remove event listener from mouse-drag event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseDragStart

  • offSeriesBackgroundMouseDragStart(token: Token): boolean
  • Remove event listener from mouse-drag start event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseDragStop

  • offSeriesBackgroundMouseDragStop(token: Token): boolean
  • Remove event listener from mouse-drag stop event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseEnter

  • offSeriesBackgroundMouseEnter(token: Token): boolean
  • Remove event listener from mouse-enter event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseLeave

  • offSeriesBackgroundMouseLeave(token: Token): boolean
  • Remove event listener from mouse-leave event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseMove

  • offSeriesBackgroundMouseMove(token: Token): boolean
  • Remove event listener from mouse-move event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseUp

  • offSeriesBackgroundMouseUp(token: Token): boolean
  • Remove event listener from mouse-up event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundMouseWheel

  • offSeriesBackgroundMouseWheel(token: Token): boolean
  • Remove event listener from mouse-wheel event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundTouchEnd

  • offSeriesBackgroundTouchEnd(token: Token): boolean
  • Remove event listener from touch end event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundTouchMove

  • offSeriesBackgroundTouchMove(token: Token): boolean
  • Remove event listener from touch move event on Series Background

    Parameters

    • token: Token

    Returns boolean

offSeriesBackgroundTouchStart

  • offSeriesBackgroundTouchStart(token: Token): boolean
  • Remove event listener from touch start event on Series Background

    Parameters

    • token: Token

    Returns boolean

onBackgroundMouseClick

  • Subscribe to mouse-click event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDoubleClick

  • Subscribe to mouse-doubleClick event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDown

  • Subscribe to mouse-down event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDrag

  • Subscribe to mouse-drag event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDragStart

onBackgroundMouseDragStop

onBackgroundMouseEnter

  • Subscribe to mouse-enter event on Chart background

    Parameters

    Returns Token

onBackgroundMouseLeave

  • Subscribe to mouse-leave event on Chart background

    Parameters

    Returns Token

onBackgroundMouseMove

  • Subscribe to mouse-move event on Chart background

    Parameters

    Returns Token

onBackgroundMouseUp

  • Subscribe to mouse-up event on Chart background

    Parameters

    Returns Token

onBackgroundMouseWheel

  • Subscribe to mouse-wheel event on Chart background

    Parameters

    Returns Token

onBackgroundTouchEnd

  • Subscribe to touch-end event on Chart background

    Parameters

    Returns Token

onBackgroundTouchMove

  • Subscribe to touch-move event on Chart background

    Parameters

    Returns Token

onBackgroundTouchStart

  • Subscribe to touch-start event on Chart background

    Parameters

    Returns Token

onResize

  • onResize(handler: function): Token
  • Subscribe to resize event. This event is triggered whenever the area of chart changes (due to document or dashboard resizing).

     // Example usage,
     ChartXY.onResize((chart, width, height, engineWidth, engineHeight) => {
         console.log('Chart resized', 'width', width, 'height', height, 'engineWidth', engineWidth, 'engineHeight', engineHeight)
     })
    

    Parameters

    • handler: function

      Handler function for event

        • Parameters

          • obj: this
          • width: pixel
          • height: pixel
          • engineWidth: pixel
          • engineHeight: pixel

          Returns void

    Returns Token

    Token of subscription

onSeriesBackgroundMouseClick

  • Subscribe to mouse-click event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseDoubleClick

  • Subscribe to mouse-doubleClick event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseDown

  • Subscribe to mouse-down event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseDrag

  • Subscribe to mouse-drag event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseDragStart

onSeriesBackgroundMouseDragStop

onSeriesBackgroundMouseEnter

  • Subscribe to mouse-enter event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseLeave

  • Subscribe to mouse-leave event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseMove

  • Subscribe to mouse-move event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseUp

  • Subscribe to mouse-up event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundMouseWheel

  • Subscribe to mouse-wheel event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundTouchEnd

  • Subscribe to touch end event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundTouchMove

  • Subscribe to touch move event on Series Background

    Parameters

    Returns Token

onSeriesBackgroundTouchStart

  • Subscribe to touch start event on Series Background

    Parameters

    Returns Token

pan

  • pan(delta: Point): void
  • Method pans axes by pixels.

    // Pan the chart 100 pixels to right.
    chart.pan({x: 100, y: 0})
    

    Parameters

    • delta: Point

      Amount to pan X/Y in pixels

    Returns void

saveToFile

  • saveToFile(fileName: string, type?: undefined | string, encoderOptions?: undefined | number): this
  • Capture rendered state in an image file. Prompts the browser to download the created file.

    NOTE: The download might be blocked by browser/plugins as harmful. To prevent this, only call the method in events tied to user-interactions. From mouse-event handlers, for example.

    Has two optional parameters which directly reference JavaScript API HTMLCanvasElement.toDataURL. For supported image formats, compression quality, Etc. refer to:

    https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL

    Example usage:

    // Download 'screenshot.png'
    Panel.saveToFile('screenshot')
    // Attempt download 'maybeNotSupported.bmp'
    Panel.saveToFile('maybeNotSupported', 'image/bmp')
    // Attempt download jpeg.file with specified compression quality
    Panel.saveToFile('fileName', 'image/jpeg', 0.50)
    
    sideeffect

    If 'type' is not supported by browser, an Error will be thrown.

    Parameters

    • fileName: string

      Name of prompted download file as string. File extension shouldn't be included as it is automatically detected from 'type'-argument.

    • type: undefined | string

      A DOMString indicating the image format. The default format type is image/png.

    • encoderOptions: undefined | number

      A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If this argument is anything else, the default value for image quality is used. The default value is 0.92.

    Returns this

setAnimationsEnabled

  • setAnimationsEnabled(animationsEnabled: boolean | undefined): this
  • Disable/Enable all animations of the Chart.

    Parameters

    • animationsEnabled: boolean | undefined

      Boolean value to enable or disable animations.

    Returns this

    Chart itself for fluent interface.

setAutoCursor

  • setAutoCursor(mutator: Mutator<AutoCursorXY<CursorPointMarkerType, CursorResultTableBackgroundType>>): this
  • Style chart AutoCursor using a callback function.

     // Example syntax
     ChartXY.setAutoCursor((autoCursor) => autoCursor
         // `autoCursor` is of type AutoCursorXY, use its API for styling the cursor.
         .setGridStrokeXStyle(new SolidLine({
             thickness: 1,
             fillStyle: new SolidFill({ color: ColorRGBA( 255, 0, 0 ) })
         }))
     )
    

    See AutoCursorXY for all available methods for configuring the AutoCursor.

    Example usage:

     // Example 1, disable Y Axis tick marker & grid line.
     ChartXY.setAutoCursor((autoCursor) => autoCursor
         .disposeTickMarkerY()
         .setGridStrokeYStyle(emptyLine),
     )
    
     // Example 2, style AutoCursor ResultTable.
     ChartXY.setAutoCursor((autoCursor) => autoCursor
         .setResultTable((resultTable) => resultTable
             .setOrigin(UIOrigins.LeftTop)
             .setTextFillStyle(new SolidFill({ color: ColorRGBA(255, 0, 0) }))
             .setTextFont((font) => font
                 .setSize(12)
                 .setFamily('sans-serif')
             )
             .setBackground((background) => background
                 .setFillStyle(new SolidFill({ color: ColorRGBA(0, 0, 0, 0) }))
             )
         )
     )
    
     // Example 3, style AutoCursor TickMarker X.
     ChartXY.setAutoCursor((autoCursor) => autoCursor
         .setTickMarkerX((tickMarker: UIPointableTextBox) => tickMarker
             .setTextFont((font) => font.setWeight('bold'))
             .setTextFillStyle(new SolidFill({ color: ColorRGBA(0, 255, 0) }))
             .setBackground((background) => background.setFillStyle(emptyFill).setStrokeStyle(emptyLine)),
         )
     )
    

    Parameters

    • mutator: Mutator<AutoCursorXY<CursorPointMarkerType, CursorResultTableBackgroundType>>

      Callback function that receives reference to the charts AutoCursor.

    Returns this

    Object itself for fluent interface.

setAutoCursorMode

  • Set chart AutoCursor behavior, by selecting a preset option from AutoCursorModes.

    Possible values:

    • AutoCursorModes.snapToClosest (default) | AutoCursor snaps to closest data point from mouse location.
    • AutoCursorModes.onHover | AutoCursor is only shown when it is directly over a series.
    • AutoCursorModes.disabled | AutoCursor is disabled
     // Example, disable AutoCursor
     ChartXY.setAutoCursorMode(AutoCursorModes.disabled)
    

    Related information:

    On series level, AutoCursor behavior can be configured individually for each series, and there are also more series specific options available. Here is LineSeries for example:

    Parameters

    Returns this

    Object itself for fluent interface.

setBackgroundFillStyle

  • Set FillStyle of chart background.

     // Example usage,
     ChartXY.setBackgroundFillStyle(new SolidFill({ color: ColorRGBA( 80, 0, 0 ) }))
    

    Related API:

    • Use SolidFill to describe a solid fill color.
    • Use ColorRGBA to create a color from Red, Green, Blue (and optionally) Alpha values in range [0, 255].

    Parameters

    Returns this

    Object itself

setBackgroundStrokeStyle

  • Set LineStyle of chart background border stroke.

     // Example usage,
     ChartXY.setBackgroundStrokeStyle(new SolidLine({
         thickness: 2,
         fillStyle: new SolidFill({ color: ColorRGBA( 0, 255, 0 ) })
     }))
    

    Related API:

    • Use SolidLine to describe a solid line style.
    • Use SolidFill to describe a solid fill color.
    • Use ColorRGBA to create a color from Red, Green, Blue (and optionally) Alpha values in range [0, 255].

    Parameters

    Returns this

    Object itself

setFittingRectangleFillStyle

  • Set fillStyle for zooming rectangle when fitting.

    Parameters

    Returns this

    Object itself

setFittingRectangleStrokeStyle

  • Set stroke style for zooming rectangle when fitting.

    Parameters

    Returns this

    Object itself

setMouseBackgroundStyle

  • setMouseBackgroundStyle(mouseStyle: string): this
  • Set mouse style when hovering over series background.

    Parameters

    • mouseStyle: string

      Mouse-style preset name (see MouseStyles)

    Returns this

    Object itself

setMouseFitStyle

  • setMouseFitStyle(mouseStyle: string): this
  • Set mouse style when fitting over series background.

    Parameters

    • mouseStyle: string

      Mouse-style preset name (see MouseStyles)

    Returns this

    Object itself

setMouseInteractionPan

  • setMouseInteractionPan(enabled: boolean): this
  • Set is mouse-interaction enabled: Panning axes by dragging mouse on frame.

    Parameters

    • enabled: boolean

      Boolean flag

    Returns this

    Object itself

setMouseInteractionRectangleFit

  • setMouseInteractionRectangleFit(enabled: boolean): this
  • Set is mouse-interaction enabled: Fitting axes by capturing rectangle on frame.

    Parameters

    • enabled: boolean

      Boolean flag

    Returns this

    Object itself

setMouseInteractionRectangleZoom

  • setMouseInteractionRectangleZoom(enabled: boolean): this
  • Set is mouse-interaction enabled: Zooming axes by capturing rectangle on frame.

    Parameters

    • enabled: boolean

      Boolean flag

    Returns this

    Object itself

setMouseInteractionWheelZoom

  • setMouseInteractionWheelZoom(enabled: boolean): this
  • Set is mouse-interaction enabled: Zooming axes with mouse-wheel on frame (also touch pinch currently).

    Parameters

    • enabled: boolean

      Boolean flag

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(enabled: boolean): this
  • Set all mouse-interaction flags at once.

    Parameters

    • enabled: boolean

      Are mouse-interactions enabled

    Returns this

    Object itself

setMouseInteractionsWhileScrolling

  • setMouseInteractionsWhileScrolling(state: boolean): this
  • Set if mouse and cursor interactions should be disabled during scrolling animations for the chart's series.

    Parameters

    • state: boolean

      True if mouse and cursor interactions should be disabled during scrolling animations, false if not.

    Returns this

    Chart itself for fluent interface.

setMouseInteractionsWhileZooming

  • setMouseInteractionsWhileZooming(state: boolean): this
  • Set if mouse and cursor interactions should be disabled during zooming animations for the chart's series.

    Parameters

    • state: boolean

      True if mouse and cursor interactions should be disabled during zooming animations, false if not.

    Returns this

    Chart itself for fluent interface.

setMousePanStyle

  • setMousePanStyle(mouseStyle: string): this
  • Set mouse style when panning over series background.

    Parameters

    • mouseStyle: string

      Mouse-style preset name (see MouseStyles)

    Returns this

    Object itself

setMouseZoomStyle

  • setMouseZoomStyle(mouseStyle: string): this
  • Set mouse style when zooming over series background.

    Parameters

    • mouseStyle: string

      Mouse-style preset name (see MouseStyles)

    Returns this

    Object itself

setPadding

  • setPadding(padding: Partial<Margin> | number): this
  • Set padding around Chart in pixels.

     // Example 1, specify complete padding (four sides).
     ChartXY.setPadding({ left: 16, right: 16, top: 32, bottom: 8 })
    
     // Example 2, specify only single padding.
     ChartXY.setPadding({ right: 64 })
    

    Parameters

    • padding: Partial<Margin> | number

      Number with pixel margins for all sides or datastructure with individual pixel paddings for each side. Any side can be omitted, only passed values will be overridden.

    Returns this

    Object itself

setSeriesBackgroundFillStyle

  • Set FillStyle of series background (area behind series).

     // Example usage,
     ChartXY.setSeriesBackgroundFillStyle(new SolidFill({ color: ColorRGBA( 60, 0, 0 ) }))
    

    Related API:

    • Use SolidFill to describe a solid fill color.
    • Use ColorRGBA to create a color from Red, Green, Blue (and optionally) Alpha values in range [0, 255].

    Parameters

    Returns this

    Object itself

setSeriesBackgroundStrokeStyle

  • Set LineStyle of series background border stroke.

     // Example usage,
     ChartXY.setSeriesBackgroundStrokeStyle(new SolidLine({
         thickness: 2,
         fillStyle: new SolidFill({ color: ColorRGBA( 0, 255, 0 ) })
     }))
    

    Related API:

    • Use SolidLine to describe a solid line style.
    • Use SolidFill to describe a solid fill color.
    • Use ColorRGBA to create a color from Red, Green, Blue (and optionally) Alpha values in range [0, 255].

    Parameters

    Returns this

    Object itself

setSeriesHighlightOnHover

  • setSeriesHighlightOnHover(state: boolean): this
  • Set the state for all Series in the Chart to highlight on mouse hover.

    Parameters

    • state: boolean

      True if all Series should be highlighted on mouse hover, false if not.

    Returns this

    Object itself for fluent interface.

setTitle

  • setTitle(title: string): this
  • Set text of Chart title.

    Parameters

    • title: string

      Chart title as a string.

    Returns this

    Object itself for fluent interface.

setTitleFillStyle

  • Set fill style of Chart Title.

    Example usage:

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

    Parameters

    Returns this

    Chart itself

setTitleFont

  • Set font of Chart Title.

    Example usage:

    // Create a new FontSettings
    Chart.setTitleFont(new FontSettings({ size: 24, style: 'italic' }))
    // Change existing settings
    Chart.setTitleFont((fontSettings) => fontSettings.setWeight('bold'))
    

    Parameters

    Returns this

    Chart itself

setTitleMarginBottom

  • setTitleMarginBottom(marginPixels: pixel): this
  • Specifies padding after chart title.

    This does not have an effect if title is hidden (empty FillStyle).

     // Example usage,
     // Add empty space between title and series.
     ChartXY.setTitleMarginBottom(32)
    

    Parameters

    • marginPixels: pixel

      Gap after the chart title in pixels.

    Returns this

    Chart itself for fluent interface

setTitleMarginTop

  • setTitleMarginTop(marginPixels: pixel): this
  • Specifies padding before chart title.

    This does not have an effect if title is hidden (empty FillStyle).

     // Example usage,
     // Add empty space at top of chart, before title.
     ChartXY.setTitleMarginTop(32)
    

    Parameters

    • marginPixels: pixel

      Gap between the top of chart and its title in pixels.

    Returns this

    Chart itself for fluent interface

setTitleRotation

  • setTitleRotation(value: number): this
  • Set rotation of Chart title.

    Parameters

    • value: number

      Rotation in degrees

    Returns this

    Object itself

setZoomingRectangleFillStyle

  • Set fillStyle for zooming rectangle when zooming.

    Parameters

    Returns this

    Object itself

setZoomingRectangleStrokeStyle

  • Set stroke style for zooming rectangle when zooming.

    Parameters

    Returns this

    Object itself

solveNearest

  • Solves the nearest data-point from series inside Chart of a given coordinate on screen

    Parameters

    • location: Point | undefined

      Location on screen or omit for cur mouse location

    Returns undefined | CursorPoint

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

zoom

  • Method zooms axes by pixels.

    // Zoom the chart out.
    chart.zoom({x: 500, y: 500}, {x: 1, y: 1})
    

    Parameters

    • location: Point

      Origin location for zooming as viewport pixels

    • amount: Point

      Amount to zoom X/Y in pixels

    Returns void