Protected _isActive state of Cursor
Readonly axisXReadonly axisYReadonly chartReadonly scaleScale of the series
Append a single XY coordinate or list of coordinates into the series.
// Example syntax
LineSeries.add({ x: 0, y: 100 })
LineSeries.add([
{ x: 0, y: 100 },
{ x: 10, y: 50 },
{ x: 20, y: 75 },
])
Object itself for fluent interface.
Each Y-value will be paired with an automatically generated X-value, based on step-argument.
Object itself for fluent interface.
Array of Y-values.
Optional step between each X coordinate. Defaults to 1.
Optional value for first generated X-value. If undefined, will continue after last point's X value in series, or 0 if there are no points in series.
Add Marker to the Series.
SeriesMarkerXY
StaticCursorBuilderXY object for customized look of marker. MarkerBuilders.XY can be used to build a custom one from scratch.
Add point to the Series.
Series itself for fluent interface
New point
Add points to the Stock series.
Series itself for fluent interface
Array of new points
Attach object to an legendBox entry
Series itself for fluent interface
Object which has to be attached
Optional toggleVisibilityOnClick: booleanFlag that indicates whether the Attachable should be hidden or not, when its respective Entry is clicked.
Clear all previously pushed data points from the series.
// Example usage
LineSeries.clear()
Object itself for fluent interface.
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 OHLCSeries.
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.
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 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
OHLCSeries.setCursorResultTableFormatter((tableBuilder, series, ohlcSegment) => {
return tableBuilder
.addRow(`Pointing at`, '', series.getName())
.addRow(`X:`, '', ohlcSegment.getPosition())
.addRow(`Open:`, '', ohlcSegment.getOpen())
.addRow(`High:`, '', ohlcSegment.getHigh())
.addRow(`Low:`, '', ohlcSegment.getLow())
.addRow(`Close:`, '', ohlcSegment.getClose())
})
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.
OHLCSeries.setCursorResultTableFormatter((tableBuilder, series, ohlcSegment) => {
// 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
})
Default Axis formatting can be referenced by using formatValue method.
The additional values that are supplied to the callback function vary between different chart and series types,
refer to the series documentation of setCursorResultTableFormatter to learn the exact available information.
OHLC Series receive two extra parameters:
series | reference to the series itself.ohlcSegment | reference to the pointed OHLCSegment, which contains position, open, high, low and close values.Related API:
Object itself
Function which builds ResultTable content.
Disable automatic data cleaning.
// Example syntax, disable data cleaning.
series.setDataCleaning(undefined)
Object itself for fluent interface.
Data cleaning configuration.
Enable automatic data cleaning by minDataPointCount configuration.
Specifying minDataPointCount enables lazy cleaning of data that is outside view as long as the remaining data amount doesn't go below the configured threshold.
// Example syntax for specifying minDataPointCount
series.setDataCleaning({ minDataPointCount: 10000 })
Usage of minDataPointCount is recommended in most common applications that require automatic data cleaning.
The actual value is often not very particular, just setting it above 0 to enable it is usually enough (lazy data cleaning of out of view data).
// Example, enable lazy data cleaning of out of view data.
series.setDataCleaning({ minDataPointCount: 1 })
Object itself for fluent interface.
Data cleaning configuration.
Enable automatic data cleaning by maxDataPointCount configuration.
Specifying maxDataPointCount results in data cleaning always happening exactly when total data amount exceeds the supplied threshold.
// Example syntax for specifying maxDataPointCount
series.setDataCleaning({ maxDataPointCount: 10000 })
maxDataPointCount is usually used in memory limited applications to prevent running out of memory.
maxDataPointCount is currently only supported by only select series:
If the feature receives good support and usage from the user base, it might be expanded to all series types in a future release.
Object itself for fluent interface.
Data cleaning configuration.
Configure draw order of the series.
The drawing order of series inside same chart can be configured by configuring their seriesDrawOrderIndex.
This is a simple number that indicates which series is drawn first, and which last.
The values can be any JS number, even a decimal. Higher number results in series being drawn closer to the top.
By default, each series is assigned a running counter starting from 0 and increasing by 1 for each series.
// Example, create 2 series and configure them to be drawn in reverse order.
const series1 = ChartXY.addLineSeries()
.setDrawOrder({ seriesDrawOrderIndex: 1 })
const series2 = ChartXY.addLineSeries()
.setDrawOrder({ seriesDrawOrderIndex: 0 })
// Example, ensure a series is drawn above other series.
SeriesXY.setDrawOrder({ seriesDrawOrderIndex: 1000 })
Object itself.
Object with seriesDrawOrderIndex property.
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 whether auto-fitting of Figures is enabled. When enabled, figures are automatically split / fused based on distance from each other.
Object itself for fluent interface
Is auto-fitting enabled.
Set width of figures in pixels.
Object itself
Width in pixels
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 style of negative figures. Negative style is applied after common style. NOTE: Because the function is applied for each figure added, it is not advised to create any objects inside the function.
Example usage:
// Explicit style
// The type of figure can be equal to type parameter NegativeFigure
OHLCSeries.setNegativeStyle((figure) => ... )
Object itself
Set resolution of Stock segment packing. Smaller resolution will let user zoom to greater detail. If no resolution has been defined, series will use pixel width of figures as packing resolution.
Object itself
Series will consume more memory if resolution value is lowered.
Optional resolution: numberAxis value interval for resolution of a single Stock segment or undefined to be automatically calculated based on pixelSize.
Set style of positive figures. Positive style is applied after common style. NOTE: Because the function is applied for each figure added, it is not advised to create any objects inside the function. Instead they should be previously cached and later referred to.
Example usage:
// Explicit style
// The type of figure can be equal to type parameter PositiveFigure
OHLCSeries.setPositiveStyle((figure) => ... )
Object itself
Styler function that is applied to all existing and newly added segments
Set common style for both positive and negative figures. NOTE: Because the function is applied for each figure added, it is not advised to create any objects inside the function. Instead they should be previously cached and later referred to.
Example usage:
// Explicit style
// The type of figure can be equal to type parameter PositiveFigure or NegativeFigure
OHLCSeries.setStyle((figure) => ... )
Object itself
Styler function that is applied to all existing and newly added segments
Set element visibility.
Object itself.
true when element should be visible and false when element should be hidden.
Solves the nearest datapoint to a given coordinate on screen.
Undefined or data-structure for positioning of cursors
Location on screen
Type of OHLCSeries that automatically packages progressive (X) Vec2 data.