Protected _isActive state of Cursor
Readonly scaleAdds an arbitrary amount of SpiderPoints to the Series.
Animates transition if its enabled on owning chart.
Object itself
Rest ...points: SpiderPoint[]List of SpiderPoints as {'axis': string, 'value': number}
Attach object to an legendBox entry
Series itself for fluent interface
Object which has to be attached
Flag that indicates whether the Attachable should be hidden or not, when its respective Entry is clicked.
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
Object itself for fluent interface
Get whether series is taken into account with automatic scrolling and fitting of attached axes.
By default, this is true for all series.
true default, axes will take series into account in scrolling and fitting operations.
false, axes will ignore series boundaries.
Get ResultTable Formatter.
Function which builds ResultTable content for SpiderSeries.
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.
Boolean that describes whether drawing the theme effect is enabled around the component or not.
Get shape of points.
This is defined upon creation of series, and cannot be changed afterwards.
PointShape
Subscribe onDispose event.
This event is triggered whenever the ChartComponent is disposed.
// Example usage
lineSeries.onDispose(() => {
console.log('lineSeries was disposed')
})
lineSeries.dispose()
Token of subscription
Event handler function
Subscribe to highlight object event. This is called whenever an object is highlighted.
Token that can be used to unsubscribe from the event.
Function that is called when event is triggered.
Add event listener to Mouse Click Event
Token of the event listener
Event listener for Mouse Click Event
Add event listener to Mouse Double Click Event
Token of the event listener
Event listener for Mouse Double Click Event
Add event listener to Mouse Down Event
Token of the event listener
Event listener for Mouse Down Event
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Add event listener to Enter Event
Token of the event listener
Event listener for Mouse Enter Event
Add event listener to Mouse Leave Event
Token of the event listener
Event listener for Mouse Leave Event
Add event listener to Mouse Move Event
Token of the event listener
Event listener for Mouse Move Event
Add event listener to Mouse Up Event
Token of the event listener
Event listener for Mouse Up Event
Subscribe to Mouse Wheel event
Token of subscription
Event handler function
Subscribe to Touch End event
Token of subscription
Event handler function
Subscribe to Touch Move event
Token of subscription
Event handler function
Subscribe to Touch Start event
Token of subscription
Event handler function
Register new event listener to visibleStateChanged event.
Event listener for visibleStateChanged
Set animation for adding points.
Object itself
Optional easing: AnimationEasingType of easing for animation or undefined to disable animations
Optional duration: numberCustom duration for animation in milliseconds.
Set component highlight animations enabled or not. For most components this is enabled by default.
// Example usage, disable highlight animations.
component.setAnimationHighlight(false)
Object itself
Animation enabled?
Set whether series is taken into account with automatic scrolling and fitting of attached axes.
By default, this is true for all series.
By setting this to false, any series can be removed from axis scrolling/fitting.
// Example syntax, remove series from automatic scrolling / fitting.
LineSeries.setAutoScrollingEnabled(false)
Object itself for fluent interface.
true default, axes will take series into account in scrolling and fitting operations.
false, axes will ignore series boundaries.
Configure whether cursors should pick on this particular series or not.
// Example, prevent chart auto cursor from snapping to a series.
LineSeries.setCursorEnabled(false)
Related API:
Configure formatting of Cursor ResultTable when pointing at this series.
// Example usage
SpiderSeries.setCursorResultTableFormatter((tableBuilder, series, value, axis) => {
return tableBuilder
.addRow(`Pointing at`, '', series.getName())
.addRow(`Category:`, '', axis)
.addRow(`Value:`, '', value.toFixed(1))
})
The general syntax of configuring ResultTable formatting is shared between all series types; You specify a callback function, which receives a TableContentBuilder. The contents of the table are then set using methods of the table builder:
// Using TableContentBuilder.
SpiderSeries.setCursorResultTableFormatter((tableBuilder, series, value, axis) => {
// addRow adds a list of strings to a new row in the table. Empty strings ('') will allocate any extra horizontal space within the row.
tableBuilder
.addRow('Item 0:', '', 'Value 0')
.addRow('Item 1:', '', 'Value 1')
.addRow('Long row that highlights the idea of empty strings')
// After configuration, the table builder must be returned!
return tableBuilder
})
The additional values that are supplied to the callback function vary between different chart types,
refer to the series documentation of setCursorResultTableFormatter to learn the exact available information.
All Spider Series receive three extra parameters:
series | reference to the series itself.value | pointed data point value.axis | pointed data point category (name of spider axis).Related API:
Object itself
Function which builds ResultTable content.
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.
Object itself.
Theme effect enabled
Set fill style of the Polygon that represents the shape of the Series.
Example use:
// Create a new style
SpiderSeries.setFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
// Change transparency
SpiderSeries.setFillStyle((solidFill) => solidFill.setA(80))
// Set hidden
SpiderSeries.setFillStyle(emptyFill)
Series itself for fluent interface.
FillStyle which has to be used for recoloring or mutator to modify existing one.
Set state of component highlighting.
// Example usage
component.setHighlight(true)
component.setHighlight(0.5)
If highlight animations are enabled (which is true by default), the transition will be animated. As long as the component is highlighted, the active highlight intensity will be animated continuously between 0 and the configured value. Highlight animations can be disabled with setAnimationHighlight
Object itself
Boolean or number between 0 and 1, where 1 is fully highlighted.
Set highlight on mouse hover enabled or disabled.
Mouse interactions have to be enabled on the component for this to function as expected. See setMouseInteractions for more information.
Object itself for fluent interface.
True if highlighting on mouse hover, false if no highlight on mouse hover
Set component mouse interactions enabled or disabled.
Disabling mouse interactions means that the objects below this component can be interacted through it.
Possible side-effects from disabling mouse interactions:
Object itself for fluent interface
Specifies state of mouse interactions
Sets the name of the Component updating attached LegendBox entries
Object itself
Name of the Component
Set point fill style of Series. Use IndividualPointFill object to enable individual coloring of points.
Example usage:
// Create a new style
SpiderSeries.setPointFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
// Change transparency
SpiderSeries.setPointFillStyle((solidFill) => solidFill.setA(80))
// Set hidden
SpiderSeries.setPointFillStyle(emptyFill)
Series itself for fluent interface.
Set the rotation of points in degrees.
Rotation angle in degrees
Set size of point in pixels
Object itself for fluent interface
Size of point in pixels
Set stroke style of the Polygon that represents the shape of the Series.
Example usage:
// Specified LineStyle
SpiderSeries.setStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
SpiderSeries.setStrokeStyle((solidLine) => solidLine.setThickness(5))
// Hidden
SpiderSeries.setStrokeStyle(emptyLine)
Chart itself
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value.
Set element visibility.
Object itself.
true when element should be visible and false when element should be hidden.
Set animation for when series visibility changes.
This refers to default interaction when attached LegendBoxEntry is toggled, or alternatively when setVisible() method is used.
// Example, disable animation when visibility changes
SpiderSeries.setVisibleStateChangedAnimation(undefined)
// Example, specify animation easing and duration
SpiderSeries.setVisibleStateChangedAnimation(AnimationEasings.linear, 2000)
Object itself
Optional easing: AnimationEasingType of easing for animation or undefined to disable animations
Optional duration: numberCustom duration for animation in milliseconds.
Solves the nearest datapoint to a given coordinate on screen.
Undefined or data-structure for positioning of cursors
Location on screen
Class that represents a collection of linked data-points inside a SpiderChart.
Given data is visualized in the form of a polygon, where each SpiderPoint is an edge along an Axis. This polygon can be styled with 3 independent areas:
Data is pushed with addPoints in form: { axis: string, value: number }