What is boost.seriesThreshold default value?

[Cortez]

Hi community!
I am bit confused with the default value for "boost.seriesThreshold" option. In docs it is said to be "null".
But I remember for sure that it used to be 50. I even can find some reference on this same forum.
And even in latest source code I see this:

Code: Select all

threshold = pick(this.options.boost && this.options.boost.seriesThreshold, 50);

Was the default value changed at some point?

Many thanks!

[dominik.c]

Hello Cortez!

We appreciate you reaching out to us!

You need to remember that there are two different ways of boosting charts - on a series-by-series level (series.boostThreshold), and on the chart as a whole (boost.seriesThreshold). The first one is set by default to 5000 and the second one is set to null by default.

The seriesThreshold property is responsible for boosting the chart when there are more series than e.g 3 when this property is set to 3.

Docs:
https://www.highcharts.com/docs/advance ... ost-module
https://api.highcharts.com/highcharts/p ... tThreshold
https://api.highcharts.com/highstock/bo ... sThreshold

If you have any issues related to this property, please reproduce your issue in an online editor.
Best regards!

[Cortez]

Hi there Dominik, and many thanks for you reply.
So, am I right thinking that default value for boost.seriesThreshold was 50 in the past?
Can you help me to sort out this confusion?
Thanks!

[dominik.c]

Hi again!

I don't think so. You can check it in our changelog. If this value was changed there should be information about it over there. Why do you think that this value was set to 50 by default in the past?

Link: https://www.highcharts.com/blog/changelog/

Best regards!

[Cortez]

Dear Dominik,
You asked why do I think that boost.seriesThreshold value was set to 50 by default in the past. Here is a list of sources, where this info can be found:
1. Official Highcharts blog: https://www.highcharts.com/blog/tutoria ... st-module/
2. Official Highcharts forum: viewtopic.php?t=43029
3. Official Highcharts github: https://github.com/highcharts/highcharts/issues/14789

Also, I can recall that from my memory.

And one last thing - those code snippet from Highcharts source code I quoted in my first message.

[dominik.c]

Hi again!

It seems that indeed this property was set to 50 by default earlier, but right now it's set to null by default. Sorry for misleading you.

Best regards!

[Cortez]

Dear Dominik,
I am still concerned with this.
1. I think this change was important enough to be resembled in some changenotes.
2. It seems that the default value is still 50. Check this: https://jsfiddle.net/Cortez/x2ovgja4/
In this example you will see, that there are 49 series, and chart is NOT in boost mode. If you change series number to 50 - you will notice that chart enters boost mode.
Also those code snippet from Highcharts source code I quoted in my first message also makes me think that the default value is still 50.
Is it possible that there is a mistake in docs?

Thanks!

[dominik.c]

Hi again!

You're right. We've got a mistake in our docs and this property was and still is set to 50. I've already created a ticket on our GitHub, so you can follow it to be up to date. Link: https://github.com/highcharts/highcharts/issues/15543

Thanks for pointing this out.

Best regards!