Public, safe interface for Panels rendering engine.
Scale for panel area in pixels.
Scale for panel area in percentages (0-100).
Add a new axis to Spider Chart
Object itself
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.
addLegendBox( LegendBoxBuilders.VerticalLegendBox )
// Position = [0, 100] as percentages.
.setPosition({ x: 50, y: 50 })
addLegendBox( LegendBoxBuilders.VerticalLegendBox, chart.pixelScale )
// Position = pixels.
.setPosition({ x: 300, y: 100 })
addLegendBox( LegendBoxBuilders.VerticalLegendBox, { x: chartXY.getDefaultAxisX(), y: chartXY.getDefaultAxisY() } )
// Position = Axis values.
.setPosition({ x: 5, y: 5 })
LegendBoxBuilder. If omitted, VerticalLegendBox will be selected. Use LegendBoxBuilders for selection.
Optional parameter for altering the coordinate system used for positioning the LegendBox. Defaults to whole Chart in percentages [0, 100].
Object with two interfaces: LegendBox and UIElement.
Adds a new SpiderSeries to the SpiderChart.
Shape of points for SpiderSeries. Defaults to PointShape.Circle
SpiderSeries instance
Add a stand-alone UIElement using a builder.
Example usage:
addUIElement( UIElementBuilders.TextBox )
// Position = [0, 100] as percentages.
.setPosition({ x: 50, y: 50 })
addUIElement( UIElementBuilders.TextBox, chart.pixelScale )
// Position = pixels.
.setPosition({ x: 300, y: 100 })
addUIElement( UIElementBuilders.TextBox, { x: chartXY.getDefaultAxisX(), y: chartXY.getDefaultAxisY() } )
// Position = Axis values.
.setPosition({ x: 5, y: 5 })
Type of UIElement that is specified by 'builder'-parameter.
UIElementBuilder. If omitted, TextBoxBuilder will be selected. Use UIElementBuilders for selection.
Optional parameter for altering the coordinate system used for positioning the UIElement. Defaults to whole Chart in percentages [0, 100].
Object that fulfills interfaces: UIElementType (typeparam) and UIElement
Disable all animations for the chart.
All animations have to be re-enabled individually if you wish to re-enable animations.
Chart itself for fluent interface.
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
Object itself for fluent interface
Format value along an axis.
Value along an axis
Value formated to string
Gets if animations are enabled or not
Automatic axis creation state
Get reference to charts AutoCursor
.
See AutoCursorXY for all available methods for configuring the AutoCursor
.
AutoCursor
.
Get AutoCursor
behavior, from a collection of preset options (AutoCursorModes).
Active selection of AutoCursor behavior.
Get font of axis labels.
FontSettings object
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.
Padding in pixels
Get fill style of axis labels.
FillStyle object
Gets the AxisScrollStrategy of Charts Axes
Get style of axes as SolidLine.
SolidLine object
Get fillstyle of chart background.
FillStyle
Get stroke style of chart background.
LineStyle
Get axis value at edges of chart
Value at edges of chart
Get minimum size of Panel. Depending on the type of class this value might be automatically computed to fit different elements.
Vec2 minimum size or undefined if unimplemented
Get are mouse-interactions on chart enabled or not
Boolean flag
Get length of axis nibs in pixels.
Length of nibs in pixels
Get style of axis nibs as SolidLine.
SolidLine object
Get axis value at center of chart
Value at center of chart
Get padding around Chart in pixels.
Padding datastructure
Get font of scale labels.
FontSettings
Get padding of scale labels.
Padding in pixels
Get fill style of scale labels.
FillStyle object
Get series of a chart
series
Get FillStyle of Series background area (area behind series).
FillStyle
Get Stroke style of Series background area (area behind series).
LineStyle
Get number of series inside chart.
Amount of series inside chart
Returns the Theme currently being used.
An object containing the Theme.
Get text of Chart title.
Chart title as a string.
Get fill style of Chart Title.
FillStyle object
Get font of Chart title.
FontSettings object
Padding after Chart title
Padding before Chart title
Get rotation of Chart title.
Rotation in degrees
Get count of 'webs' displayed
Count of web lines
Get mode of SpiderCharts web and background.
Enum SpiderWebMode
Get fill style of web lines.
LineStyle object
Check if Chart has an Axis with specified tag
Name of desirable axis
True if axis exists, false if not.
Remove subscription from mouse-click event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-doubleClick event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-down event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-drag event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-dragStart event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-dragStop event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-enter event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-leave event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-move event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from touch-start event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-up event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from mouse-wheel event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from touch-end event on Panel background
Event listener
True if the listener is successfully removed and false if it is not found
Remove subscription from touch-move event on Chart background
Event listener
True if the listener is successfully removed and false if it is not found
Remove event listener from resize event.
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from mouse-click event on Series Background
Remove event listener from mouse-doubleClick event on Series Background
Remove event listener from mouse-down event on Series Background
Remove event listener from mouse-drag event on Series Background
Remove event listener from mouse-drag start event on Series Background
Remove event listener from mouse-drag stop event on Series Background
Remove event listener from mouse-enter event on Series Background
Remove event listener from mouse-leave event on Series Background
Remove event listener from mouse-move event on Series Background
Remove event listener from mouse-up event on Series Background
Remove event listener from mouse-wheel event on Series Background
Remove event listener from touch end event on Series Background
Remove event listener from touch move event on Series Background
Remove event listener from touch start event on Series Background
Subscribe to mouse-click event on Chart background
Subscribe to mouse-doubleClick event on Chart background
Subscribe to mouse-down event on Chart background
Subscribe to mouse-drag event on Chart background
Subscribe to mouse-drag start event on Chart background
Subscribe to mouse-drag stop event on Chart background
Subscribe to mouse-enter event on Chart background
Subscribe to mouse-leave event on Chart background
Subscribe to mouse-move event on Chart background
Subscribe to mouse-up event on Chart background
Subscribe to mouse-wheel event on Chart background
Subscribe to touch-end event on Chart background
Subscribe to touch-move event on Chart background
Subscribe to touch-start event on Chart background
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)
})
Handler function for event
Token of subscription
Subscribe to mouse-click event on Series Background
Subscribe to mouse-doubleClick event on Series Background
Subscribe to mouse-down event on Series Background
Subscribe to mouse-drag event on Series Background
Subscribe to mouse-drag start event on Series Background
Subscribe to mouse-drag stop event on Series Background
Subscribe to mouse-enter event on Series Background
Subscribe to mouse-leave event on Series Background
Subscribe to mouse-move event on Series Background
Subscribe to mouse-up event on Series Background
Subscribe to mouse-wheel event on Series Background
Subscribe to touch end event on Series Background
Subscribe to touch move event on Series Background
Subscribe to touch start event on Series Background
Remove axis from Spider Chart
Axis or tag of an Axis which has to be removed
Object itself for fluent interface
Restore given axis to the Spider Chart.
Axis to restore.
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)
Name of prompted download file as string. File extension shouldn't be included as it is automatically detected from 'type'-argument.
A DOMString indicating the image format. The default format type is image/png.
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.
Sets if animations are enabled or not
Specifies if auto creation of axis is turned on or not
State of automatic axis creation
Object itself for fluent interface
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)),
)
)
Callback function that receives reference to the charts AutoCursor
.
Object itself for fluent interface.
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:
'nearest-x'
, 'nearest'
, etc.).Selection of AutoCursor behavior.
Object itself for fluent interface.
Set interval of Charts Axes
Value at edges of chart
Value at center of chart. Defaults to zero
Object itself
Set font of axis labels.
FontSettings or mutator function for existing settings
Object itself
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.
Padding in pixels
Object itself
Set strategy for drawing axis labels. Defines how axis labels are aligned.
SpiderAxisLabelStrategy or undefined to never show axis labels
Object itself
Set fill style of axis labels.
FillStyle object or mutator to modify existing one
Object itself
Sets the AxisScrollStrategy of Charts Axes
AxisScrollStrategy or undefined to disable automatic scrolling. See AxisScrollStrategies for a collection of options.
Object itself
Set style of axes as SolidLine.
SolidLine object or mutator to modify existing one
Object itself
Set FillStyle of chart background.
// Example usage,
ChartXY.setBackgroundFillStyle(new SolidFill({ color: ColorRGBA( 80, 0, 0 ) }))
Related API:
FillStyle
or function which mutates the active FillStyle
.
Object itself
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:
LineStyle
or function which mutates the active LineStyle
.
Object itself
Set if mouse-interactions on chart are enabled or not
Boolean flag
Object itself
Set length of axis nibs in pixels.
Sum length of nibs in pixels (both directions)
Set style of axis nibs as SolidLine.
SolidLine object or mutator to modify existing one
Object itself
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 })
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.
Object itself
Set font of scale labels.
FontSettings or mutator function for existing settings
Object itself
Set padding of scale labels.
Padding in pixels
Object itself
Set strategy for drawing scale labels. Defines on which positions labels are drawn and whether they are flipped or not.
SpiderScaleLabelStrategy or undefined to never show scale labels
Object itself
Set fill style of scale labels.
FillStyle object or mutator to modify existing one
Set FillStyle of series background (area behind series).
// Example usage,
ChartXY.setSeriesBackgroundFillStyle(new SolidFill({ color: ColorRGBA( 60, 0, 0 ) }))
Related API:
FillStyle
or function which mutates the active FillStyle
.
Object itself
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:
LineStyle
or function which mutates the active LineStyle
.
Object itself
Set the state for all Series in the Chart to highlight on mouse hover.
True if all Series should be highlighted on mouse hover, false if not.
Object itself for fluent interface.
Set text of Chart title.
Chart title as a string.
Object itself for fluent interface.
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)
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Chart itself
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'))
Either a FontSettings object or a function, which will be used to create a new FontSettings based on current value.
Chart itself
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)
Gap after the chart title in pixels.
Chart itself for fluent interface
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)
Gap between the top of chart and its title in pixels.
Chart itself for fluent interface
Set rotation of Chart title.
Rotation in degrees
Object itself
Set count of 'webs' displayed.
Count of web lines
Object itself
Set mode of SpiderCharts web and background.
Enum SpiderWebMode
Object itself
Set style of spider charts webs as LineStyle.
LineStyle object or mutator to modify existing one
Object itself
Solves the nearest data-point from series inside Chart of a given coordinate on screen
Location on screen or omit for cur mouse location
Undefined or data-structure for positioning of markers (and cursors)
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 SpiderChart.addSeries. Data can then be pushed in with SpiderSeries.addPoints
By default, SpiderChart automatically creates Axes based on the data that are pushed to its Series.