Adds an arbitrary amount of SpiderPoints to the Series.
Animates transition if its enabled on owning chart.
List of SpiderPoints as {'axis': string, 'value': number}
Object itself
Attach object to an legendBox entry
Object which has to be attached
Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.
Series itself for fluent interface
Enable or disable the series
Series 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.
Whether Cursor is enabled or not
Get ResultTable Formatter.
Function which builds ResultTable content for SpiderSeries.
Current series fill style
Gets the highlighted fillStyle of the Polygon that represents the shape of this Series
Get boolean flag for whether object should highlight on mouse hover
Boolean for if object should highlight on mouse hover or not.
the state of highlighted flag
Get boolean flag for whether object is currently under mouse or not
Boolean for is object under mouse currently
Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.
Mouse interactions state
Get the name of the Component.
The name of the Component.
Current point fill style
Current highlight point fill style
Get the current rotation of points.
Get shape of points.
This is defined upon creation of series, and cannot be changed afterwards.
PointShape
Size of point in pixels
Gets the stroke style of the Polygon that represents the shape of this Series
Get stroke style of highlighted polygon.
LineStyle or undefined for auto assignment
Returns the respective value of a data-point with the given tag (if any)
If set to true, will take series animating into account for result
TODO: True for enabled and false for disabled
Unsubscribe from Highlight object event. This is called whenever an object is highlighted
Token that was received when subscribing to the event.
True if the unsubscription was successful.
Remove event listener from Series Hover 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
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 Double Click 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 Down 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 Drag 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 Drag Start 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 Drag Stop 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 Enter 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 Leave 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 Move 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 Up 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 Wheel 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 Touch End 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 Touch Move 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 Touch Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Subscribe to highlight object event. This is called whenever an object is highlighted.
Function that is called when event is triggered.
Token that can be used to unsubscribe from the event.
Add event listener to Series Hover Event. Hover event is a custom mouse-event designed for Series that is the main link between Cursors and Series.
Callback function that is called whenever mouse enters / moves or leaves the Series
Token of the event listener
Add event listener to Mouse Click Event
Event listener for Mouse Click Event
Token of the event listener
Add event listener to Mouse Double Click Event
Event listener for Mouse Double Click Event
Token of the event listener
Add event listener to Mouse Down Event
Event listener for Mouse Down Event
Token of the event listener
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Add event listener to Enter Event
Event listener for Mouse Enter Event
Token of the event listener
Add event listener to Mouse Leave Event
Event listener for Mouse Leave Event
Token of the event listener
Add event listener to Mouse Move Event
Event listener for Mouse Move Event
Token of the event listener
Add event listener to Mouse Up Event
Event listener for Mouse Up Event
Token of the event listener
Subscribe to Mouse Wheel event
Event handler function
Token of subscription
Subscribe to Touch End event
Event handler function
Token of subscription
Subscribe to Touch Move event
Event handler function
Token of subscription
Subscribe to Touch Start event
Event handler function
Token of subscription
Enable or disable the series
Series itself for fluent interface
Set animation for adding points.
Type of easing for animation or undefined to disable animations
Custom duration for animation in milliseconds.
Object itself
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)
true default, axes will take series into account in scrolling and fitting operations.
false, axes will ignore series boundaries.
Object itself for fluent interface.
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:
'nearest-x', 'nearest', etc.).
This method is not available for all series types (more support will be added in near future).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:
Function which builds ResultTable content.
Object itself
Set animation for disabling/enabling series.
Type of easing for animation or undefined to disable animations
Custom duration for animation in milliseconds.
Object itself
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)
FillStyle which has to be used for recoloring or mutator to modify existing one.
Series itself for fluent interface.
Set fill style of the highlighted Polygon that represents the shape of the Series.
Example use:
// Create a new style
SpiderSeries.setFillStyleHighlight(new SolidFill({ color: ColorHEX('#F00') }))
// Change transparency
SpiderSeries.setFillStyleHighlight((solidFill) => solidFill.setA(80))
// Set hidden
SpiderSeries.setFillStyleHighlight(emptyFill)
// Automatic
SpiderSeries.setFillStyleHighlight(undefined)
FillStyle which has to be used for recoloring or mutator to modify existing one.
Series itself for fluent interface.
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.
True if highlighting on mouse hover, false if no highlight on mouse hover
Object itself for fluent interface.
Enable or disable forced highlighting of series
True for enabled and false for disabled
Series itself for fluent interface
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:
Specifies state of mouse interactions
Object itself for fluent interface
Sets the name of the Component updating attached LegendBox entries
Name of the Component
Object itself
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 point fill style of Series when it is highlighted.
Example usage:
// Create a new style
SpiderSeries.setPointFillStyleHighlight(new SolidFill({ color: ColorHEX('#F00') }))
// Change transparency
SpiderSeries.setPointFillStyleHighlight((solidFill) => solidFill.setA(80))
// Set hidden
SpiderSeries.setPointFillStyleHighlight(emptyFill)
// Automatic
SpiderSeries.setPointFillStyleHighlight(undefined)
Series itself for fluent interface.
Set the rotation of points in degrees.
Rotation angle in degrees
Set size of point in pixels
Size of point in pixels
Object itself for fluent interface
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)
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value.
Chart itself
Set stroke style of the highlighted Polygon that represents the shape of the Series. Highlighting is activated by placing mouse on top / touching Series (if mouse-interactions are not disabled), or by using setHighlighted() method.
Example usage:
// Specified LineStyle
SpiderSeries.setStrokeStyleHighlight(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
SpiderSeries.setStrokeStyleHighlight((solidLine) => solidLine.setThickness(5))
// Hidden
SpiderSeries.setStrokeStyleHighlight(emptyLine)
// Automatic
SpiderSeries.setStrokeStyleHighlight(undefined)
Either a SolidLine object or a function, which will be used to modify current value.
Chart itself
Solves the nearest datapoint to a given coordinate on screen.
Location on screen
Undefined or data-structure for positioning of cursors
Solves the nearest datapoint to a given coordinate on a screen from a specific segment.
Location on screen
Undefined or data-structure for positioning of cursors
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 SpiderSeries.addPoints in form: { axis: string, value: number }