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 previously pushed data points from the series.
// Example usage
LineSeries.clear()
Object itself for fluent interface.
Remove everything related to the object from all collections associated with rendering cycle and allows the object to be collected by GC
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.
Whether Cursor is enabled or not
Get ResultTable Formatter.
Function which builds ResultTable content for OHLCSeries.
Get whether auto-fitting of Figures is enabled. When enabled, figures are automatically split / fused based on distance from each other.
Is auto-fitting enabled.
Get width of figures in pixels.
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.
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 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
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 Axis.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:
Function which builds ResultTable content.
Object itself
Disable automatic data cleaning.
// Example syntax, disable data cleaning.
series.setDataCleaning(undefined)
Data cleaning configuration.
Object itself for fluent interface.
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 })
Data cleaning configuration.
Object itself for fluent interface.
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.
Data cleaning configuration.
Object itself for fluent interface.
Set whether auto-fitting of Figures is enabled. When enabled, figures are automatically split / fused based on distance from each other.
Is auto-fitting enabled.
Object itself for fluent interface
Set width of figures in pixels.
Width in pixels
Object itself
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 component
True for enabled and false for disabled
component itself for fluent interface
Configure automatic data cleaning by maxPointCount
.
This allows the cleaning of all excess data points that are outside view, so that after cleaning at least maxPointCount
data points are retained.
Essentially it configures the head length of a series.
// Example, progressive X line series with automatic data cleaning.
const series = ChartXY.addLineSeries({
dataPattern: {
pattern: 'ProgressiveX'
}
})
// Keep at least 1000 data points in series, otherwise excess out of view data can be cleaned for more memory.
.setMaxPointCount(1000)
// Setup automatically scrolling X Axis.
chart.getDefaultAxisX().setScrollStrategy(AxisScrollStrategies.progressive).setInterval(0, 1000)
// Continously stream data into series.
let x = 0
setInterval(() => {
const newDataPoints = []
for (let i = 0; i <= 10; i += 1) {
newDataPoints.push({ x: x + i, y: Math.random() * 100 })
}
x += newDataPoints.length
series.add(newDataPoints)
}, 1000 / 60)
Enabling automatic data cleaning is crucial in applications that run for a long time, or even forever
Configuration for automatic data cleaning by maxPointCount
.
If undefined or 0 is passed, automatic data cleaning by maxPointCount
will be disabled.
Object 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 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 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:
javascript // Explicit style // The type of figure can be equal to type parameter PositiveFigure OHLCSeries.setPositiveStyle((figure) => ... )
* @param styler Styler function that is applied to all existing and newly added segments
Object itself
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
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
Segment to solve from
Undefined or data-structure for positioning of cursors
OHLCSeries class. Takes data in format of OHLC segment interface and renders it using generic StockFigures. Currently only supports progressive X timeline!