Class PolarChart<CursorResultTableBackgroundType>

Chart for visualizing data in a Polar coordinate system ( angle + amplitude ). It has a multitude of methods for adding various types of Series. For example:

PolarCharts Axes can be styled similarly as those of ChartXY. Refer to them via methods:

Charts are created by methods of LightningChart interface or a Dashboard.

Type Parameters

Hierarchy

Implements

Properties

Methods

addAreaSeries addHeatmapSeries addLegendBox addLineSeries addPointLineSeries addPointSeries addPolygonSeries addSector addUIElement dispose forEachAxis getAmplitudeAxis getAnimationsEnabled getAutoCursor getAutoCursorMode getBackgroundFillStyle getBackgroundStrokeStyle getIsInView getLegendBoxes getMinimumSize getMouseInteractions getPadding getRadialAxis getSeries getSeriesBackgroundEffect getSeriesBackgroundFillStyle getSeriesBackgroundStrokeStyle getSizePixels getTheme getTitle getTitleEffect getTitleFillStyle getTitleFont getTitleMargin getTitleRotation getTitleSize offBackgroundMouseClick offBackgroundMouseDoubleClick offBackgroundMouseDown offBackgroundMouseDrag offBackgroundMouseDragStart offBackgroundMouseDragStop offBackgroundMouseEnter offBackgroundMouseLeave offBackgroundMouseMove offBackgroundMouseTouchStart offBackgroundMouseUp offBackgroundMouseWheel offBackgroundTouchEnd offBackgroundTouchMove offDispose offInViewChange offResize offSeriesBackgroundMouseClick offSeriesBackgroundMouseDoubleClick offSeriesBackgroundMouseDown offSeriesBackgroundMouseDrag offSeriesBackgroundMouseDragStart offSeriesBackgroundMouseDragStop offSeriesBackgroundMouseEnter offSeriesBackgroundMouseLeave offSeriesBackgroundMouseMove offSeriesBackgroundMouseUp offSeriesBackgroundMouseWheel offSeriesBackgroundTouchEnd offSeriesBackgroundTouchMove offSeriesBackgroundTouchStart onBackgroundMouseClick onBackgroundMouseDoubleClick onBackgroundMouseDown onBackgroundMouseDrag onBackgroundMouseDragStart onBackgroundMouseDragStop onBackgroundMouseEnter onBackgroundMouseLeave onBackgroundMouseMove onBackgroundMouseUp onBackgroundMouseWheel onBackgroundTouchEnd onBackgroundTouchMove onBackgroundTouchStart onDispose onInViewChange onResize onSeriesBackgroundMouseClick onSeriesBackgroundMouseDoubleClick onSeriesBackgroundMouseDown onSeriesBackgroundMouseDrag onSeriesBackgroundMouseDragStart onSeriesBackgroundMouseDragStop onSeriesBackgroundMouseEnter onSeriesBackgroundMouseLeave onSeriesBackgroundMouseMove onSeriesBackgroundMouseUp onSeriesBackgroundMouseWheel onSeriesBackgroundTouchEnd onSeriesBackgroundTouchMove onSeriesBackgroundTouchStart saveToFile setAnimationsEnabled setAutoCursor setAutoCursorMode setBackgroundFillStyle setBackgroundStrokeStyle setMouseInteractions setPadding setSeriesBackgroundEffect setSeriesBackgroundFillStyle setSeriesBackgroundStrokeStyle setSeriesHighlightOnHover setTitle setTitleEffect setTitleFillStyle setTitleFont setTitleMargin setTitleRotation solveNearest translateCoordinate

Properties

Selector for Polar Axis Coordinate System, measured in angles and amplitudes.

This selector can be used for translating Polar coordinates to other coordinate systems and vice versa. For example, in order to:

  • Position LCJS UI elements in Polar coordinates
  • Find client coordinate that matches a location at Polar amplitude & angle
  • Translating user click event location to a Polar amplitude & angle.
  • etc.

See translateCoordinate for more detailed use case information and example usage.

coordsClient: "client" = 'client'

Selector for "client" Coordinate System.

This references the coordinate system used in HTML. It starts at top left of the web page and is measured in pixels. For example, { x: 100, y: 20 } corresponds to 100 pixels from left and 20 pixels from top.

JavaScript events are tracked and HTML elements are positioned in the client coordinate system.

This selector can be used for translating client coordinates to other coordinate systems and vice versa. For example, in order to:

  • Position LCJS UI elements in client coordinates
  • Find client coordinate that matches a location along LCJS Axis or Chart.
  • etc.

See translateCoordinate for more detailed use case information and example usage.

coordsRelative: "relative" = 'relative'

Selector for "relative" Coordinate System.

This coordinate system is relative to the bottom left corner of the Control (chart/dashboard/etc.), and is measured as pixels. For example, { x: 100, y: 20 } corresponds to 100 pixels from left and 20 pixels from bottom.

This selector can be used for two purposes:

Positioning LCJS UI elements in pixels:

 // Position UI element in pixels by supplying `Control.coordsRelative` as its positioning system.
const textBox = Control.addUIElement(UIElementBuilders.TextBox, Control.coordsRelative)
.setOrigin(UIOrigins.LeftBottom)
.setPosition({ x: 100, y: 20 })

Translations between coordinate systems:

Use with translateCoordinate method to translate coordinates from "relative" to another coordinate system.

engine: PublicEngine

Interface for end user API of the LCJS engine. It provides some useful capabilities over the area enclosed by a single LCJS context (which can be just a single chart, or a Dashboard with several charts).

pixelScale: LinearScaleXY

Scale for panel area in pixels.

Deprecated

Deprecated since v4.2.0. Use coordsRelative instead. It works exactly the same.

removePanel: ((panel: Panel) => void)

Type declaration

    • (panel: Panel): void
    • Parameters

      Returns void

uiScale: LinearScaleXY

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

While it is not functionally equal to this, using coordsRelative coordinate system is preferred (more confidence for long term support).

Methods

  • Add a Area series to the PolarChart.

    PolarAreaSeries are used to render a list of PolarPoints by filling the enclosed area.

    Example usage:

    • Plot sub section (< 360 degrees) of the Polar Chart
     const areaSeries = polarChart.addAreaSeries()
    .setData(
    new Array( 90 ).fill( 0 ).map(( _, i ) => ({
    angle: i,
    amplitude: 60 + 25 * Math.cos( 5 * i * Math.PI / 180 )
    }))
    )
    • Plot a fully connected (360 degrees) section of the Polar Chart
     const areaSeries = polarChart.addAreaSeries()
    .setConnectDataAutomaticallyEnabled(true)
    .setData(
    new Array(360).fill(0).map((_, i) => ({
    angle: i,
    amplitude: 60 + 25 * Math.cos((5 * i * Math.PI) / 180),
    })),
    )

    Returns

    PolarAreaSeries.

    Parameters

    • Optional options: SeriesOptions

    Returns PolarAreaSeriesInterior

  • Add a Series for visualizing a Polar Heatmap with a static sector and annuli count. Has API for fast modification of cell values.

    PolarHeatmapSeries is optimized for high resolution data. For example, 1 degree precision or less along Radial Axis, and up to 2000 samples along Amplitude Axis.

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

    Readonly configuration:

    Some properties of PolarHeatmapSeries 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 = PolarChart.addHeatmapSeries({
    sectors: 360,
    annuli: 100
    })

    To learn about available properties, refer to PolarHeatmapSeriesOptions.

    Each cell of the heatmap is associated with a numeric intensity value, which can be used together with a Color look up table (LUT).

    Returns

    Polar Heatmap Series.

    Parameters

    Returns PolarHeatmapSeries

  • 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.coordsRelative )
    // 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 })

    Returns

    LegendBox

    Parameters

    • builder: UILegendBoxBuilder<InternalBackground> = _legendBoxBuilder

      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<UIBackground>

  • Add a Line series to the PolarChart.

    PolarLineSeries are used to render a list of PolarPoints by a continuous line that can be styled arbitrarily.

    Example usage:

     const lineSeries = polarChart.addLineSeries().setData(
    new Array( 90 ).fill( 0 ).map(( _, i ) => ({
    angle: i,
    amplitude: 60 + 25 * Math.cos( 5 * i * Math.PI / 180 )
    }))
    )

    Returns

    PolarLineSeries.

    Parameters

    • Optional options: SeriesOptions

    Returns PolarLineSeries

  • Add a Point Line series to the PolarChart.

    PolarPointLineSeries are used to render a list of PolarPoints by a continuous line drawn between the points plus configurable shapes over each data point.

    Example usage:

     const pointLineSeries = polarChart.addPointLineSeries().setData(
    new Array( 90 ).fill( 0 ).map(( _, i ) => ({
    angle: i,
    amplitude: 60 + 25 * Math.cos( 5 * i * Math.PI / 180 )
    }))
    )

    Returns

    PolarPointLineSeries.

    Parameters

    • Optional options: SeriesOptions

    Returns PolarPointLineSeries

  • Add a Point series to the PolarChart.

    PolarPointSeries are used to render a list of PolarPoints by different shapes.

    Example usage:

     const pointSeries = polarChart.addPointSeries().setData(
    new Array( 90 ).fill( 0 ).map(( _, i ) => ({
    angle: i,
    amplitude: 60 + 25 * Math.cos( 5 * i * Math.PI / 180 )
    }))
    )

    Returns

    PolarPointSeries.

    Parameters

    • Optional options: SeriesOptions

    Returns PolarPointSeries

  • Add a Polygon series to the PolarChart.

    PolarPolygonSeries are used to render a collection of polygons inside the Polar coordinate system. They are especially useful for highlighting parts of the Polar coordinate system.

    Example usage:

     const polygonSeries = polarChart.addPolygonSeries()
    let ang = 45
    let amplitude = 50
    const polygon = polygonSeries.addPolygon()
    .setGeometry([
    { angle: (ang += 10), amplitude: (amplitude += 10) },
    { angle: (ang += 10), amplitude: (amplitude += 5) },
    { angle: (ang += 10), amplitude: (amplitude += 10) },
    { angle: (ang += 10), amplitude: (amplitude -= 5) },
    { angle: (ang += 10), amplitude: (amplitude += 5) },
    { angle: (ang += 5), amplitude: (amplitude -= 5) },
    { angle: (ang += 0), amplitude: (amplitude -= 10) },
    { angle: (ang -= 5), amplitude: (amplitude -= 5) },
    { angle: (ang -= 10), amplitude: (amplitude -= 10) },
    { angle: (ang -= 10), amplitude: (amplitude -= 5) },
    { angle: (ang -= 10), amplitude: (amplitude += 5) },
    { angle: (ang -= 10), amplitude: (amplitude += 10) },
    ])

    Returns

    PolarPolygonSeries.

    Parameters

    • Optional options: SeriesOptions

    Returns PolarPolygonSeries

  • 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.coordsRelative )
    // 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 })

    Returns

    Object that fulfills interfaces: UIElementType (typeparam) and UIElement

    Type Parameters

    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

  • Permanently destroy 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

    Object itself for fluent interface

    Returns PolarChart<CursorResultTableBackgroundType>

  • Get are mouse-interactions on chart enabled or not

    Returns

    Boolean flag

    Returns boolean

  • Get theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
    Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Boolean that describes whether drawing the theme effect is enabled around the component or not.

    Returns boolean

  • Get size of control as pixels.

    For stand-alone component, the size will be equal to the size of its containing HTML <div> (Control.engine.container)

    For component inside Dashboard, the size will only include the component itself, so size can be less than the size of containing HTML <div>.

    Returns

    Object with x and y properties { x: number, y: number }, where both are pixel values.

    Returns Point

  • Get theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
    Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Boolean that describes whether drawing the theme effect is enabled around the component or not.

    Returns boolean

  • Remove event listener from dispose event.

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from inViewChange event.

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from resize event.

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Subscribe onDispose event. This event is triggered whenever the Control (Dashboards and all chart types) is disposed.

     // Example usage

    Chart.onDispose(() => {
    console.log('chert was disposed')
    })

    Chart.dispose()

    Returns

    Token of subscription

    Parameters

    • handler: ((object: PolarChart<CursorResultTableBackgroundType>) => unknown)

      Handler function for event

        • (object: PolarChart<CursorResultTableBackgroundType>): unknown
        • Parameters

          • object: PolarChart<CursorResultTableBackgroundType>

          Returns unknown

    Returns Token

  • Subscribe to inViewChange event. This event is triggered when the chart transitions from being off-screen to being on-screen and vice versa.

    Returns

    Token of subscription

    Parameters

    • handler: ((obj: this, inView: boolean) => void)
        • (obj: this, inView: boolean): void
        • Parameters

          • obj: this
          • inView: boolean

          Returns void

    Returns 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)
    })

    Returns

    Token of subscription

    Parameters

    • handler: ((obj: PolarChart<CursorResultTableBackgroundType>, width: number, height: number, engineWidth: number, engineHeight: number) => void)

      Handler function for event

        • (obj: PolarChart<CursorResultTableBackgroundType>, width: number, height: number, engineWidth: number, engineHeight: number): void
        • Parameters

          • obj: PolarChart<CursorResultTableBackgroundType>
          • width: number
          • height: number
          • engineWidth: number
          • engineHeight: number

          Returns void

    Returns Token

  • 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)

    Remarks

    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.

    • Optional type: string

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

    • Optional encoderOptions: 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 PolarChart<CursorResultTableBackgroundType>

  • See AutoCursor for all available methods for configuring the AutoCursor.

    Example usage:

     // Example 1, style AutoCursor ResultTable.
    PolarChart.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 2, style AutoCursor PointMarker.
    PolarChart.setAutoCursor((autoCursor) => autoCursor
    .setPointMarker((marker) => marker
    .setFillStyle(new SolidFill({ color: ColorRGBA(255, 0, 0) }))
    .setSize({ x: 10, y: 10 })
    .setStrokeStyle(emptyLine),
    ),
    )

    Returns

    Object itself for fluent interface.

    Parameters

    • mutator: Mutator<AutoCursor<CursorResultTableBackgroundType>>

      Callback function that receives reference to the charts AutoCursor.

    Returns PolarChart<CursorResultTableBackgroundType>

  • 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. NOTE: Series mouse interactions must be enabled for this to work!
    • AutoCursorModes.disabled | AutoCursor is disabled
     // Example, disable AutoCursor
    PolarChart.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:

    • setCursorEnabled | configure whether cursor should pick on the series or not.
    • SeriesXY.setCursorResultTableFormatter | configure formatting of result table contents, when this series is pointed.
    • setCursorInterpolationEnabled | configure whether cursor should interpolate the displayed data point between the two closest data points, or snap to the nearest real data point.
    • SeriesXY.setCursorSolveBasis | configure basis of finding nearest data point for the series ('nearest-x', 'nearest', etc.).

    Returns

    Object itself for fluent interface.

    Parameters

    Returns PolarChart<CursorResultTableBackgroundType>

  • 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].

    Transparent chart backgrounds:

    LightningChart JS charts can be configured to be fully or partially transparent.

     // Example, partially transparent chart

    // Engine background exists under all LCJS components. In case of Dashboard, there is only 1 shared engine background.
    chart.engine.setBackgroundFillStyle(emptyFill)
    // Chart background covers every 1 chart. In case of Dashboard, every chart has its own chart background.
    chart.setBackgroundFillStyle(new SolidFill({ color: ColorRGBA(0, 0, 0, 100) }))
    // Some charts also have a separate series background.
    chart.setSeriesBackgroundFillStyle(new SolidFill({ color: ColorRGBA(0, 0, 0, 100) }))

    Returns

    Object itself

    Parameters

    Returns PolarChart<CursorResultTableBackgroundType>

  • Set if mouse-interactions on chart are enabled or not

    Returns

    Object itself

    Parameters

    • enabled: boolean

      Boolean flag

    Returns PolarChart<CursorResultTableBackgroundType>

  • 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 })

    Returns

    Object itself

    Parameters

    • padding: number | Partial<Margin>

      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 PolarChart<CursorResultTableBackgroundType>

  • Set theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
    Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Object itself.

    Parameters

    • enabled: boolean

      Theme effect enabled

    Returns PolarChart<CursorResultTableBackgroundType>

  • 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].

    Transparent chart backgrounds:

    LightningChart JS charts can be configured to be fully or partially transparent.

     // Example, partially transparent chart

    // Engine background exists under all LCJS components. In case of Dashboard, there is only 1 shared engine background.
    chart.engine.setBackgroundFillStyle(emptyFill)
    // Chart background covers every 1 chart. In case of Dashboard, every chart has its own chart background.
    chart.setBackgroundFillStyle(new SolidFill({ color: ColorRGBA(0, 0, 0, 100) }))
    // Some charts also have a separate series background.
    chart.setSeriesBackgroundFillStyle(new SolidFill({ color: ColorRGBA(0, 0, 0, 100) }))

    Returns

    Object itself

    Parameters

    Returns PolarChart<CursorResultTableBackgroundType>

  • Set theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
    Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Object itself.

    Parameters

    • enabled: boolean

      Theme effect enabled

    Returns PolarChart<CursorResultTableBackgroundType>

  • Specifies padding after chart title.

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

     // Example 2, specify margins for all sides with same value for Title.
    ChartXY.setTitleMargin(40)

    Returns

    Chart itself for fluent interface

    Parameters

    • marginPixels: number | Partial<Margin>

      Gap after the chart title in pixels.

    Returns PolarChart<CursorResultTableBackgroundType>

  • Method for solving the nearest data point from all existing series relative to a given coordinate on screen.

     // Example usage, from mouse move event.
    ChartXY.onSeriesBackgroundMouseMove((_, event) => {
    const result = ChartXY.solveNearest(event)
    })
     // Example usage, arbitrary coordinate on client coordinate system.
    const result = ChartXY.solveNearest({ clientX: 100, clientY: 200 })

    Translating coordinates from other coordinate systems is also possible, see translateCoordinate.

    Returns

    undefined or data structure with solve result information that can also be used for positioning custom cursors.

    Parameters

    Returns undefined | CursorPoint<Point>

  • Translate a coordinate to another coordinate system.

    Supports following coordinate systems:

    Most common example use cases:

    (1) Translate a coordinate from HTML client coordinates to Polar axes

     PolarChart.onSeriesBackgroundMouseClick((_, event) => {
    const locationAxis = chart.translateCoordinate(event, chart.coordsAxis)
    // locationAxis tells the clicked location along Axis interval (in same value range as data points).
    })

    (2) Translate a coordinate from Polar axes to HTML client coordinates

     const locationAxis = { angle: 45, amplitude: 5 }
    const locationClient = chart.translateCoordinate(locationAxis, chart.coordsClient)

    Client coordinates can be used to absolute position HTML elements using CSS, for example.

     myHTMLElement.style.position = 'absolute'
    myHTMLElement.style.left = locationClient.clientX
    myHTMLElement.style.top = locationClient.clientY

    (3) Translate a coordinate from Polar axes to relative coordinates

     const locationAxis = { angle: 45, amplitude: 5 }
    const locationRelative = chart.translateCoordinate(locationAxis, chart.coordsRelative)

    Relative coordinates can be used for positioning LightningChart JS UI components:

     const textBox = chart.addUIElement(UIElementBuilders.TextBox, chart.coordsRelative)
    // Left bottom of TextBox is positioned 20 pixels right and 20 pixels up from charts bottom left corner
    .setOrigin(UIOrigins.LeftBottom)
    .setPosition({ x: 20, y: 20 })

    (4) Translate a coordinate from relative chart coordinates to axes

     const locationRelative = { x: 0, y: 0 }
    const locationAxis = chart.translateCoordinate(locationRelative, chart.coordsRelative, chart.coordsAxis)

    NOTE: Currently coordinate translations can't be guaranteed to be in sync with latest updates to charts. For example, if you change axis interval, or add data to a series, you need to wait for 1 frame to be displayed before translateCoordinate will behave as expected.

     LineSeries.add(myData)
    requestAnimationFrame(() => {
    // translateCoordinate should now consider data added just now.
    })

    Type Parameters

    Parameters

    Returns T extends "client" ? CoordinateClient : T extends CoordinateSystemPolar ? PolarPoint : T extends "relative" ? CoordinateXY : never

  • Translate a coordinate from relative control coordinates to another coordinate system.

    This coordinate system is relative to the bottom left corner of the Control (chart/dashboard/etc.), and is measured as pixels. For example, { x: 100, y: 20 } corresponds to 100 pixels from left and 20 pixels from bottom.

    (1) Polar axis coordinate system:

     const locationRelative = { x: 100, y: 200 }
    const locationAxis = polarChart.translateCoordinate(locationRelative, polarChart.coordsRelative, polarChart.coordsAxis)

    Polar axis locations can be used for example with different Polar Series, like PolarPointSeries.

    (2) HTML client coordinate system

     const locationRelative = { x: 100, y: 200 }
    const locationClient = polarChart.translateCoordinate(locationRelative, polarChart.coordsRelative, polarChart.client)

    Client coordinates can be used to absolute position HTML elements using CSS, for example.

     myHTMLElement.style.position = 'absolute'
    myHTMLElement.style.left = locationClient.clientX
    myHTMLElement.style.top = locationClient.clientY

    NOTE: Currently coordinate translations can't be guaranteed to be in sync with latest updates to charts. For example, if you change axis interval, or add data to a series, you need to wait for 1 frame to be displayed before translateCoordinate will behave as expected.

     LineSeries.add(myData)
    requestAnimationFrame(() => {
    // translateCoordinate should now consider data added just now.
    })

    Type Parameters

    Parameters

    • coordinate: CoordinateXY
    • srcCoordinateSystem: "relative"
    • targetCoordinateSystem: T

    Returns T extends "client" ? CoordinateClient : T extends CoordinateSystemPolar ? PolarPoint : never

  • Translate a coordinate in HTML client coordinate system to relative coordinates within the component.

     const locationClient = { clientX: document.body.clientWidth * 0.2, clientY: document.body.clientHeight * 0.5 }
    const locationRelative = chart.translateCoordinate(locationClient, chart.coordsRelative)
    // locationRelative is in pixels relative to bottom left corner of the chart

    Relative coordinates can be used for positioning LightningChart JS UI components:

     const textBox = chart.addUIElement(UIElementBuilders.TextBox, chart.coordsRelative)
    // Left bottom of TextBox is positioned 20 pixels right and 20 pixels up from charts bottom left corner
    .setOrigin(UIOrigins.LeftBottom)
    .setPosition({ x: 20, y: 20 })

    NOTE: Currently coordinate translations can't be guaranteed to be in sync with latest updates to charts. For example, if you change axis interval, or add data to a series, you need to wait for 1 frame to be displayed before translateCoordinate will behave as expected.

     LineSeries.add(myData)
    requestAnimationFrame(() => {
    // translateCoordinate should now consider data added just now.
    })

    Type Parameters

    • T extends "relative"

    Parameters

    Returns T extends "relative" ? CoordinateXY : never

  • Translate a coordinate from relative control coordinates to HTML client coordinate system.

     // 10 pixels left and 20 pixels up from controls bottom left corner
    const locationRelative = { x: 10, y: 20 }
    const locationClient = chart.translateCoordinate(locationRelative, chart.coordsRelative, chart.coordsClient)

    Client coordinates can be used to absolute position HTML elements using CSS, for example.

     myHTMLElement.style.position = 'absolute'
    myHTMLElement.style.left = locationClient.clientX
    myHTMLElement.style.top = locationClient.clientY

    NOTE: Currently coordinate translations can't be guaranteed to be in sync with latest updates to charts. For example, if you change axis interval, or add data to a series, you need to wait for 1 frame to be displayed before translateCoordinate will behave as expected.

     LineSeries.add(myData)
    requestAnimationFrame(() => {
    // translateCoordinate should now consider data added just now.
    })

    Type Parameters

    • T extends "client"

    Parameters

    • coordinate: CoordinateXY
    • srcCoordinateSystem: "relative"
    • targetCoordinateSystem: T

    Returns T extends "client" ? CoordinateClient : never