Axis X
Axis Y
Scale of the series
Add Marker to the Series.
StaticCursorBuilderXY object for customized look of marker. MarkerBuilders.XY can be used to build a custom one from scratch.
SeriesMarkerXY
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
Clear all points and segments from the dataset.
Series itself for fluent interface
Tell the owning chart to remove this series.
Object itself.
Whether Cursor is enabled or not
Get if cursor interpolates solved data-points along series by default.
Boolean flag
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 amount of points that series should keep around at all times (data-cleaning won't touch them).
Number of points, or undefined if data-cleaning is disabled
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.
Get a current fill style used for the coloring of the negative area in the series.
Current fill style used for the coloring of the negative area in the series.
Get a current highlight fill style used for the coloring of the negative area during series highlighting.
Current highlight fill style used for the coloring of the negative area during series highlighting.
Get a current line style of a border used for the coloring of the negative border in the series.
Current line style of a border used for the coloring of the negative border.
Get a current line style of a border used for the coloring of of the negative border during highlighting.
Current line style of a border used for the coloring of the negative border during highlighting.
Get amount of points that series currently has.
Number of points
Get a current fill style used for the coloring of the positive area in the series.
Current fill style used for the coloring of the positive area in the series.
Get a current highlight fill style used for the coloring of the positive area during series highlighting.
Current highlight fill style used for the coloring of the positive area during series highlighting.
Get a current line style of a stroke used for the coloring of the positive stroke in the series.
Current line style of a stroke used for the coloring of the positive stroke.
Get a current line style of a stroke used for the coloring of the positive border during highlighting.
Current line style of a border used for the coloring of the positive border during highlighting.
Get ResultTable Formatter.
Function which builds ResultTable content for RangeSeries.
Max X value of the series
Min X value of the series
Max Y value of the series
Min Y value of the series
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
Tell the owning chart to restore this series.
Object itself.
Set whether Cursor is enabled or not
Set if cursor interpolates solved data-points along series by default.
Boolean flag
Object itself for fluent interface
Set highlight on mouse hover enabled or disabled
True if highlighting on mouse hover, false if no highlight on mouse hover
Object itself for fluent interface.
Enable or disable forced highlighting of component
True for enabled and false for disabled
component itself for fluent interface
Set amount of points that should be kept around at all times (data-cleaning won't touch them). NOTE: The actual data starts if there is at least 1 full segment (>8000 points normally).
Guaranteed amount of visible points. If undefined or 0 is passed, data-cleaning will be disabled.
Object itself
Set mouse interactions enabled or disabled. Disabling mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.
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 negative area style of Series.
Example Usage:
// Specified FillStyle
AreaSeriesBipolar.setNegativeFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
// Changed transparency
AreaSeriesBipolar.setNegativeFillStyle((solidFill) => solidFill.setA(80))
// Hidden (emptyFill is not supported)
AreaSeriesBipolar.setNegativeFillStyle(transparentFill)
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Series itself for fluent interface.
Set negative area style of Series when it is highlighted.
Example Usage:
// Specified FillStyle
AreaSeriesBipolar.setNegativeFillStyleHighlight(new SolidFill({ color: ColorHEX('#F00') }))
// Changed transparency
AreaSeriesBipolar.setNegativeFillStyleHighlight((solidFill) => solidFill.setA(80))
// Hidden (emptyFill is not supported)
AreaSeriesBipolar.setNegativeFillStyleHighlight(transparentFill)
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value or undefined for automatic value based on normal style.
Series itself for fluent interface.
Set negative stroke style of Series.
Example usage:
// Specified SolidLine
AreaSeriesBipolar.setNegativeStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
AreaSeriesBipolar.setNegativeStrokeStyle((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
AreaSeriesBipolar.setNegativeStrokeStyle(transparentLine)
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value.
Series itself for fluent interface.
Set negative stroke style of Series when it is highlighted. Highlighting is activated by placing mouse on top / touching Series (if mouse-interactions are not disabled), or by using setHighlighted() method.
Example usage:
// Specified SolidLine
AreaSeriesBipolar.setNegativeStrokeStyleHighlight(new SolidLine(
{ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
AreaSeriesBipolar.setNegativeStrokeStyleHighlight((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
AreaSeriesBipolar.setNegativeStrokeStyleHighlight(transparentLine)
// Automatic
AreaSeriesBipolar.setNegativeStrokeStyleHighlight(undefined)
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value or undefined for automatic value based on normal style.
Chart itself
Set positive area style of Series.
Example Usage:
// Specified FillStyle
AreaSeriesBipolar.setPositiveFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
// Changed transparency
AreaSeriesBipolar.setPositiveFillStyle((solidFill) => solidFill.setA(80))
// Hidden (emptyFill is not supported)
AreaSeriesBipolar.setPositiveFillStyle(transparentFill)
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Series itself for fluent interface.
Set positive area style of Series when it is highlighted.
Example Usage:
// Specified FillStyle
AreaSeriesBipolar.setPositiveFillStyleHighlight(new SolidFill({ color: ColorHEX('#F00') }))
// Changed transparency
AreaSeriesBipolar.setPositiveFillStyleHighlight((solidFill) => solidFill.setA(80))
// Hidden (emptyFill is not supported)
AreaSeriesBipolar.setPositiveFillStyleHighlight(transparentFill)
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value or undefined for automatic value based on normal style.
Series itself for fluent interface.
Set positive stroke style of Series.
Example usage:
// Specified SolidLine
AreaSeriesBipolar.setPositiveStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
AreaSeriesBipolar.setPositiveStrokeStyle((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
AreaSeriesBipolar.setPositiveStrokeStyle(transparentLine)
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value.
Series itself for fluent interface.
Set positive stroke style of Series when it is highlighted. Highlighting is activated by placing mouse on top / touching Series (if mouse-interactions are not disabled), or by using setHighlighted() method.
Example usage:
// Specified SolidLine
AreaSeriesBipolar.setPositiveStrokeStyleHighlight(new SolidLine(
{ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
AreaSeriesBipolar.setPositiveStrokeStyleHighlight((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
AreaSeriesBipolar.setPositiveStrokeStyleHighlight(transparentLine)
// Automatic
AreaSeriesBipolar.setPositiveStrokeStyleHighlight(undefined)
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value or undefined for automatic value based on normal style.
Chart itself
Method for customizing contents of ResultTables when pointing at this Series.
Function which builds ResultTable content. See definition of RangeSeriesFormatter for supplied formatting information.
Object itself
Method that solves the nearest datapoint on mountain to a given coordinate on screen.
Location on screen
Undefined or data-structure for positioning of cursors
Method that solves the nearest datapoint on mountain to a given coordinate on a screen from a specific segment.
Location on screen
Segment to solve from
Undefined or data-structure for positioning of cursors
Implementation of SeriesXY for visualizing a collection of progressive Points by filling the area between the points Y-values and a static baseline value.
This type of AreaSeries shows data on both sides of the baseline, and it has individual styles for each side: positive and negative. Each side is also composed of the areas fill and border.
AreaSeriesBipolar are created with ChartXY.addAreaSeries and selecting AreaSeriesTypes.Bipolar.