Class SpiderChart<CursorResultTableBackgroundType>

Chart for visualizing data in a radial form as dissected by named axes.

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

A SpiderChart can have any number of SpiderSeries added to it using addSeries. Data can then be pushed in with addPoints

By default, SpiderChart automatically creates Axes based on the data that are pushed to its Series.

Type Parameters

Hierarchy

Implements

Properties

Methods

addAxis addCursor addEventListener addLegendBox addSeries addUIElement dispose getAnimationsEnabled getAutoAxis getAxes getAxis getAxisLabelEffect getAxisLabelFont getAxisLabelPadding getAxisLabelStyle getAxisStyle getBackgroundFillStyle getBackgroundStrokeStyle getCursor getCursorFormatting getCursorMode getIsInView getLegendBoxes getMinimumSize getNibLength getNibStyle getPadding getScaleLabelFont getScaleLabelPadding getScaleLabelShadow getScaleLabelStyle getSeries getSeriesBackgroundEffect getSeriesBackgroundFillStyle getSeriesBackgroundStrokeStyle getSeriesCount getSizePixels getTheme getTitle getTitleEffect getTitleFillStyle getTitleFont getTitleMargin getTitleRotation getTitleShadow getTitleSize getWebCount getWebMode getWebStyle hasAxis isDisposed removeEventListener saveToFile setAnimationsEnabled setAutoAxis setAxisInterval setAxisLabelEffect setAxisLabelFont setAxisLabelPadding setAxisLabelStrategy setAxisLabelStyle setAxisStyle setBackgroundFillStyle setBackgroundStrokeStyle setCursor setCursorFormatting setCursorMode setCustomCursor setNibLength setNibStyle setPadding setScaleLabelFont setScaleLabelFormatter setScaleLabelPadding setScaleLabelShadow setScaleLabelStrategy setScaleLabelStyle setScrollStrategy setSeriesBackgroundEffect setSeriesBackgroundFillStyle setSeriesBackgroundStrokeStyle setSeriesHighlightOnHover setTitle setTitleEffect setTitleFillStyle setTitleFont setTitleMargin setTitleRotation setTitleShadow setWebCount setWebMode setWebStyle translateCoordinate

Properties

_isPanelResized: boolean = true

Flag that is set whenever Panel or any scale is resized.

Will be handled before plot to update scale and trigger resize event just once per frame.

background: Eventer<LCJSInteractionEventMap, any> = ...

Interface for attaching listeners to user interaction events (click, pointerenter, etc.) on chart background.

 // Example syntax
chart.background.addEventListener('click', (event) => {
console.log(event)
})

For syntax examples, refer to EventInterface. Available event keys are listed under LCJSInteractionEventMap

Please note that many chart types have a separate "series background" (area enclosed by axes), which has its own separate events. This is accessed via seriesBackground property.

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

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

Type declaration

    • (panel: Panel): void
    • Parameters

      Returns void

seriesBackground: Eventer<LCJSInteractionEventMap, any> = ...

Interface for attaching listeners to user interaction events (click, pointerenter, etc.) on chart series background (area enclosed by axes).

 // Example syntax
chart.seriesBackground.addEventListener('click', (event) => {
console.log(event)
})

For more syntax examples, refer to EventInterface. Available event keys are listed under LCJSInteractionEventMap

title: Eventer<LCJSInteractionEventMap, any> = ...

Interface for attaching listeners to user interaction events (click, pointerenter, etc.) on chart title.

 // Example syntax
chart.title.addEventListener('click', (event) => {
console.log(event)
})

For syntax examples, refer to EventInterface. Available event keys are listed under LCJSInteractionEventMap

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 new axis to Spider Chart

    Returns

    Object itself

    Parameters

    • tag: string

    Returns SpiderAxis

  • Add manually controlled Cursor object. These have exactly same functions as built-in cursors but they can be freely controlled by application logic.

     const cursor = chart.addCursor()
    

    Styling works same as built-in cursors (e.g. setCursor).

    Position is set using setPosition method and displayed content using setResultTable(table => table.setContent(...)) For more details, see Developer documentation > Features > Cursor > Manual cursors

    Returns

    Cursor object.

    Type Parameters

    Parameters

    • cursorBuilder: CursorBuilder2D<ResultTableBackgroundType> = ...

      Builder for cursor. Can be used to tweak a handful of properties which can't be changed during runtime.

    Returns Cursor2D<ResultTableBackgroundType>

  • Add callback function to be triggered when specified event is fired.

     // Example syntax
    object.addEventListener('click', (event) => {
    console.log(event)
    })

    Some classes also report extra information about the interacted object with the second parameter:

     // Most series share information about interacted data point
    series.addEventListener('click', (event, info) => {
    console.log(info)
    })

    Optional third parameter allows registering event handlers that will automatically remove themselves after first trigger:

     // Example this listener will only fire once
    object.addEventListener('click', (event) => {})

    Each class has its own list of supported events. Some events are from HTML standard (click, pointerdown, etc.), while others are own events from LightningChart JS (dispose, resize, etc.)

    To find what events are available, you can try following:

    • If your development environment has TypeScript enabled, just write addEventListener and see what possible event types the IDE suggests. These APIs are strongly typed, and even the callback event will be correctly typed.
    • Otherwise, open the class section in API documentation and check out which interface K type parameter extends.

    Type Parameters

    Parameters

    Returns void

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

  • Adds a new SpiderSeries to the SpiderChart.

    Returns

    SpiderSeries instance

    Parameters

    • Optional options: SpiderSeriesOptions

      Optional object with readonly configuration arguments for SpiderSeries.

       // Example,
      SpiderChart.addSeries()
      SpiderChart.addSeries({ automaticColorIndex: 5 })
      SpiderChart.addSeries({ pointShape: PointShape.Triangle, automaticColorIndex: 10 })

    Returns SpiderSeries

  • 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 SpiderChart<CursorResultTableBackgroundType>

  • Returns

    Automatic axis creation state

    Returns boolean

  • Get axis by tag.

    Returns

    SpiderAxis or undefined

    Parameters

    • tag: string

    Returns SpiderAxis

  • 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 padding of axis labels. NOTE: The value of this padding is simply passed to the axis label strategy of chart, so overriding the default strategy will naturally leave the handling of padding logic up to you.

    Returns

    Padding in pixels

    Returns number

  • Get fill style of axis labels.

    Returns

    FillStyle object

    Returns FillStyle

  • Get style of axes as LineStyle.

    Returns

    LineStyle object

    Returns LineStyle

  • Get reference to the built-in cursor object of the chart.

    Returns

    Generic cursor object.

    Returns Cursor2D<CursorResultTableBackgroundType>

  • Get length of axis nibs in pixels.

    Returns

    Length of nibs in pixels

    Returns number

  • Get style of axis nibs as LineStyle.

    Returns

    LineStyle object

    Returns LineStyle

  • Get padding of scale labels.

    Returns

    Padding in pixels

    Returns number

  • Beta

    Not to be confused with GlowEffect

    Introduced in v7.0. API may be changed according to user feedback and reports.
    

    Returns undefined | Color

  • Get fill style of scale labels.

    Returns

    FillStyle object

    Returns FillStyle

  • 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 number of series inside chart.

    Returns

    Amount of series inside chart

    Returns number

  • 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

  • Get count of 'webs' displayed

    Returns

    Count of web lines

    Returns number

  • Get fill style of web lines.

    Returns

    LineStyle object

    Returns LineStyle

  • Check if Chart has an Axis with specified tag

    Returns

    True if axis exists, false if not.

    Parameters

    • tag: string

      Name of desirable axis

    Returns boolean

  • Remove event listener added using addEventListener. The expected argument should be the exact same callback function that was supplied using addEventListener:

     // Basic example syntax
    const listener = () => {}
    obj.addEventListener('click', listener)
    obj.removeEventListener('click', listener)
     // Basic boilerplate of custom interaction when user drags on an object
    obj.addEventListener('pointerdown', (eventDown) => {
    let prevCoord = eventDown
    const handlePointerMove: LCJSInteractionEventListener<'pointermove'> = (eventMove) => {
    const delta = { x: eventMove.clientX - prevCoord.clientX, y: eventMove.clientY - prevCoord.clientY }
    prevCoord = eventMove
    console.log(delta, eventMove.clientX, eventMove.clientY)
    }
    const handlePointerUp: LCJSInteractionEventListener<'pointerup'> = (eventUp) => {
    window.removeEventListener('pointermove', handlePointerMove)
    window.removeEventListener('pointerup', handlePointerUp)
    }
    window.addEventListener('pointermove', handlePointerMove)
    window.addEventListener('pointerup', handlePointerUp)
    })

    Type Parameters

    Parameters

    Returns void

  • 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 SpiderChart<CursorResultTableBackgroundType>

  • Specifies if auto creation of axis is turned on or not

    Returns

    Object itself for fluent interface

    Parameters

    • createAxesAutomatically: boolean

      State of automatic axis creation

    Returns SpiderChart<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 SpiderChart<CursorResultTableBackgroundType>

  • Set padding of axis labels. NOTE: The value of this padding is simply passed to the axis label strategy of chart, so overriding the default strategy will naturally leave the handling of padding logic up to you.

    Returns

    Object itself

    Parameters

    • padding: number

      Padding in pixels

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Set strategy for drawing axis labels. Defines how axis labels are aligned.

    Returns

    Object itself

    Parameters

    • Optional axisLabelStrategy: SpiderAxisLabelStrategy

      SpiderAxisLabelStrategy or undefined to never show axis labels

    Returns SpiderChart<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 SpiderChart<CursorResultTableBackgroundType>

  • Style chart cursor using a callback function. Available style APIs can depend on the type of chart.

     // Example syntax
    chart.setCursor((cursor) => cursor
    .setGridStrokeXStyle(new SolidLine({
    thickness: 1,
    fillStyle: new SolidFill({ color: ColorRGBA( 255, 0, 0 ) })
    }))
    )

    See Cursor2D, CursorXY or Cursor3D for all available methods for configuring the cursor.

    Example usage:

     // Example 1, disable Y Axis tick marker & grid line.
    chart.setCursor((cursor) => cursor
    .setTickMarkerYVisible(false)
    .setGridStrokeYStyle(emptyLine)
    )
     // Example 2, style cursor ResultTable.
    chart.setCursor((cursor) => cursor
    .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 cursor TickMarker X.
    chart.setCursor((cursor) => cursor
    .setTickMarkerX((tickMarker: UIPointableTextBox) => tickMarker
    .setTextFont((font) => font.setWeight('bold'))
    .setTextFillStyle(new SolidFill({ color: ColorRGBA(0, 255, 0) }))
    .setBackground((background) => background.setFillStyle(emptyFill).setStrokeStyle(emptyLine)),
    )
    )

    Returns

    Object itself for fluent interface.

    Parameters

    • mutator: Mutator<Cursor2D<CursorResultTableBackgroundType>>

      Callback function that receives reference to the charts cursor.

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Set cursor formatting, controlling the text displayed in built-in cursor.

     chart.setCursorFormatting((_, hit, hits) => {
    return [
    ['Cursor pointing at'],
    [hit.series], // returning a series will display the series color and its name automatically.
    ['X', '', hit.axisX.formatValue(hit.x)], // utilizing axis formatValue is useful for considering active zoom level and type of axis
    ['Y', '', hit.y.toFixed(2)], // empty string '' results in gap between cells
    [{ text: 'Example', font: { weight: 'bold' }, fillStyle: fillRed }] // any cell can also be styled individually
    ]
    })

    Before overriding default cursor formatting, it is recommended to check if using setUnits or configuring Axis cursor formatting would be enough.

    In order to use series specific data properties (e.g. Heatmap sample "intensity"), you should use type guards to assert the type of the SolveResult:

     // Example of using type guard in cursor formatter
    Chart.setCursorFormatting((chart, hit, hits) => {
    if (!isHitHeatmap(hit)) return undefined
    return [hit.intensity.toFixed(1)]
    })

    More details in Developer documentation (Features > Cursor).

    Returns

    Object itself

    Parameters

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Set cursor behavior. This affects both built-in cursor as well as any custom cursor connected using setCustomCursor.

    For possible values see SolveNearestMode. Additionally, you can supply undefined value to disable cursor completely.

     // Example, show 1 nearest solve result only
    chart.setCursorMode('show-nearest')
     // Example, disable cursor
    chart.setCursorMode(undefined)
     // Example, enable interpolation
    chart.setCursorMode('show-all-interpolated')

    Returns

    Object itself

    Parameters

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Connect a custom cursor to the chart. This has 2 effects:

    1. The built-in cursor is disabled.
    2. The provided callback function is called whenever the custom cursor should be updated, along with the data that the cursor should be pointing at.

    Custom cursors are still affected by other cursor behavior controls such as:

    The custom cursor can be anything defined by the user, such as:

    • Using other LCJS means of displaying the cursor, like custom ticks, constant lines, text boxes, etc.
    • Displaying a cursor using HTML/JS/CSS
    • Displaying a cursor using UI framework, like Angular, React, Vue, Next, ...
     // Example of plugging in a custom cursor
    chart.setCustomCursor((event) => {
    if (event) {
    // Display custom cursor
    } else {
    // Hide custom cursor
    }
    })

    Returns

    Object itself

    Parameters

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Set length of axis nibs in pixels.

    Parameters

    • length: number

      Sum length of nibs in pixels (both directions)

    Returns SpiderChart<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 SpiderChart<CursorResultTableBackgroundType>

  • Set strategy for formatting scale labels. This will override all existing and future axes scale label formatters.

     chart.setScaleLabelFormatter((value) => `${value} km`)
    

    Returns

    Object itself

    Parameters

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Set padding of scale labels.

    Returns

    Object itself

    Parameters

    • padding: number

      Padding in pixels

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Beta

    Not to be confused with GlowEffect

    Introduced in v7.0. API may be changed according to user feedback and reports.
    

    Parameters

    • color: undefined | Color

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Set strategy for drawing scale labels. Defines on which positions labels are drawn and whether they are flipped or not.

    Returns

    Object itself

    Parameters

    • Optional scaleLabelStrategy: SpiderScaleLabelStrategy

      SpiderScaleLabelStrategy or undefined to never show scale labels

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Sets the AxisScrollStrategy of Spider Axes. This will override all existing and future axes scroll strategies.

    Returns

    Object itself

    Parameters

    Returns SpiderChart<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 SpiderChart<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 SpiderChart<CursorResultTableBackgroundType>

  • Set the state for all Series in the Chart to highlight on mouse hover.

    Returns

    Object itself for fluent interface.

    Parameters

    • state: boolean

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

    Returns SpiderChart<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 SpiderChart<CursorResultTableBackgroundType>

  • Specifies padding after chart title.

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

     // Example 1, specify vertical margins
    ChartXY.setTitleMargin({ top: 0, bottom: 10 })

    // 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 SpiderChart<CursorResultTableBackgroundType>

  • Set count of 'webs' displayed.

    Returns

    Object itself

    Parameters

    • webCount: number

      Count of web lines

    Returns SpiderChart<CursorResultTableBackgroundType>

  • Set mode of SpiderCharts web and background.

    Returns

    Object itself

    Parameters

    Returns SpiderChart<CursorResultTableBackgroundType>

  • 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