Skip to content

Commit

Permalink
Error dictionary: cleaned up messages. See highcharts#9421
Browse files Browse the repository at this point in the history
  • Loading branch information
cvasseng committed Nov 16, 2018
1 parent cbabd9e commit c3e3f3c
Show file tree
Hide file tree
Showing 17 changed files with 73 additions and 51 deletions.
9 changes: 7 additions & 2 deletions errors/10/enduser.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# An error message for cloud users
# Can't plot zero or subzero values on a logarithmic axis

Unfortunately, there is no helpful message yet.
This error occurs in the following situations:
* If a zero or subzero data value is added to a logarithmic axis
* If the minimum of a logarithimic axis is set to 0 or less
* If the threshold is set to 0 or less

As of Highcharts 5.0.8 it is possible to bypass this error message by setting `Axis.prototype.allowNegativeLog` to `true` and add custom conversion functions. [View Live Demo](http://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/samples/highcharts/yaxis/type-log-negative/">).
4 changes: 2 additions & 2 deletions errors/10/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This error occurs in the following situations:

- If the threshold is set to 0 or less

Note: As of Highcharts 5.0.8 it is possible to bypass this error message by
setting Axis.prototype.allowNegativeLog to true and add custom conversion
Note: As of Highcharts 5.0.8 it's possible to bypass this error message by
setting `Axis.prototype.allowNegativeLog` to true, and add custom conversion
functions.
[View live demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/samples/highcharts/yaxis/type-log-negative/).
4 changes: 2 additions & 2 deletions errors/11/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Can't link axes of different type

This error occurs if you are using the linkedTo option to link two axes of
This error occurs when using the `linkedTo` option to link two axes of
different types, for example a logarithmic axis to a linear axis. Highcharts
can't link those because the calculation of ticks, extremes, padding etc. is
can't link these because the calculation of ticks, extremes, padding etc. is
different.
2 changes: 1 addition & 1 deletion errors/12/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This error occurs if the series.data option contains object configurations and
the number of points exceeds the turboThreshold. It can be fixed by either
setting the turboThreshold option to a higher value, or changing your point
setting `turboThreshold` to a higher value, or changing the point
configurations to numbers or arrays.

See
Expand Down
3 changes: 3 additions & 0 deletions errors/13/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ This error occurs if the
[chart.renderTo](https://api.highcharts.com/highcharts#chart.renderTo)
option is misconfigured so that Highcharts is unable to find the HTML element to
render the chart in.

If using a DOM ID when creating the chart, make sure a node with the same ID exists
somewhere in the DOM.
10 changes: 6 additions & 4 deletions errors/14/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# String value sent to series.data, expected Number

This happens if you pass in a string as a data point, for example in a setup
This happens if using a string as a data point, for example in a setup
like this:

```js
Expand All @@ -9,9 +9,11 @@ series: [{
}]
```

Highcharts expects the data values to be numbers. The most common reason for
this is that data is parsed from CSV or from a XML source, and the implementer
forgot to run `parseFloat` on the parsed value.
Highcharts expects numerical data values.

The most common reason for this error this is that data is parsed from CSV or
from a XML source, and the implementer forgot to run `parseFloat`
on the parsed value.

Note: For performance reasons internal type casting is not performed, and only
the first value is checked (since 2.3).
8 changes: 5 additions & 3 deletions errors/15/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Highcharts expects data to be sorted

This happens when you are trying to create a line series or a stock chart where
the data is not sorted in ascending X order. For performance reasons, Highcharts
does not sort the data, instead it is required that the implementer pre-sorts
This happens when creating a line series or a stock chart where
the data is not sorted in ascending X order.

For performance reasons, Highcharts
does not sort the data, instead it requires that the implementer pre-sorts
the data.
13 changes: 8 additions & 5 deletions errors/16/readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Highcharts already defined in the page

This error happens the second time Highcharts or Highstock is loaded in the same
page, so the `Highcharts` namespace is already defined. Keep in mind that the
`Highcharts.Chart` constructor and all features of Highcharts are included in
Highstock, so if you are running `Chart` and `StockChart` in combination, you
only need to load the highstock.js file.
This error happens if the `Highcharts` namespace already exists when loading
Highcharts or Highstock.

This is caused by including Highcharts or Highstock more than once.

Keep in mind that the `Highcharts.Chart` constructor and all features of
Highcharts are included in Highstock, so if using the `Chart` and
`StockChart` constructors in combination, only the `highstock.js` file is required.
11 changes: 6 additions & 5 deletions errors/17/readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# The requested series type does not exist

This error happens when you are setting `chart.type` or `series.type` to a
series type that isn't defined in Highcharts. A typical reason may be that your
are missing the extension file where the series type is defined, for example in
order to run an `arearange` series you need to load the `highcharts-more.js`
file.
This error happens when setting `chart.type` or `series.type` to a
series type that isn't defined in Highcharts. A typical reason may be that the
module or extension where the series type is defined isn't included.

For example in order to create an `arearange` series, the
`highcharts-more.js` file must be loaded.
2 changes: 1 addition & 1 deletion errors/18/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The requested axis does not exist

This error happens when you set a series' `xAxis` or `yAxis` property to point
This error happens when setting a series' `xAxis` or `yAxis` property to point
to an axis that does not exist.
6 changes: 3 additions & 3 deletions errors/19/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Too many ticks

This error happens when you try to apply too many ticks to an axis, specifically
when you add more ticks than the axis pixel length.
This error happens when applying too many ticks to an axis, specifically
when adding more ticks than the axis pixel length.

With default value this will not happen, but there are edge cases, for example
With default value this won't happen, but there are edge cases, for example
when setting axis categories and `xAxis.labels.step` in combination with a long
data range, when the axis is instructed to create a great number of ticks.
4 changes: 2 additions & 2 deletions errors/20/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Can't add object point configuration to a long data series

In Highstock, if you try to add a point using the object literal configuration
syntax, it works only when the number of data points is below the series'
In Highstock, when trying to add a point using the object literal configuration
syntax, it will only work when the number of data points is below the series'
[turboThreshold](https://api.highcharts.com/highstock#plotOptions.series.turboThreshold).
Instead of the object syntax, use the Array syntax.
6 changes: 3 additions & 3 deletions errors/23/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Highcharts supports three color formats primarily: hex (`#FFFFFF`), rgb
(`rgba(255,255,255)`) and rgba (`rgba(255,255,255,1)`). If any other format,
like 3-digit colors (`#FFF`), named colors (`white`) or gradient structures are
used in for example a heatmap, Highcharts will fail to interpolate and just
jumps to the end color.
used in for example a heatmap, Highcharts will fail to interpolate and will
instead use the end-color with no interpolation applied.

We have chosen to preserve this limitation in order to keep the weight of the
We've chosen to preserve this limitation in order to keep the weight of the
implementation at a minimum.
7 changes: 5 additions & 2 deletions errors/24/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Cannot run Point.update on a grouped point

This happens in Highstock when a point is grouped by data grouping, so there is
no reference to the raw points.
Running `Point.update` in Highstock when a point is grouped by data
grouping is not supported.

This is not supported because when data grouping is enabled, there won't be any
references to the raw points, which is required by the `Point.update` function.
11 changes: 7 additions & 4 deletions errors/26/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# WebGL not supported, and no fallback module included

This happens when your browser does not support WebGL, **and** the canvas
fallback module (`boost-canvas.js`) has not been included OR if the fallback
This happens when the browser doesn't support WebGL, **and** the canvas
fallback module (`boost-canvas.js`) hasn't been included OR if the fallback
module was included **after** the boost module.

Make sure you include `boost-canvas.js`, and that it's included before
`boost.js`.
If a fallback is required, make sure to include `boost-canvas.js`, and that
it's included before `boost.js`.

Please note that the fallback module is not intended as a fully-featured one.
Rather, it's a minimal implementation of the WebGL counterpart.
8 changes: 4 additions & 4 deletions errors/27/readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# This browser does not support SVG

This happens in old IE when the `oldie.js` module is not loaded.
This happens in old IE when the `oldie.js` module isn't loaded.

If you need to target IE versions 6, 7 and 8, add the module after loading
`highcharts.js`. In a website context, it is a good idea to load it in a
conditional comment to avoid traffic overhead in modern browsers:
If compatibility with IE versions 6, 7 and 8 is required, add the module after
loading `highcharts.js`. In a website context, it's a good idea to load it in a
conditional comment to avoid traffic overhead and dead code in modern browsers:

```html
<!--[if lt IE 9]>
Expand Down
16 changes: 8 additions & 8 deletions errors/28/readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Fallback to export server disabled

This happens when the offline export module encounters a chart it can not export
successfully, and the fallback to the online export server is disabled. The
offline exporting module will fail for certain browsers, and certain features
(e.g.
This happens when the offline export module encounters a chart that it can't
export successfully, and the fallback to the online export server is disabled.
The offline exporting module will fail for certain browsers, and certain
features (e.g.
[exporting.allowHTML](https://api.highcharts.com/highcharts/exporting.allowHTML)
), depending on the type of image exporting to. For a compatibility overview,
see
[Client Side Export](https://www.highcharts.com/docs/export-module/client-side-export).

For very complex charts, it is possible that export can fail in browsers that
don't support Blob objects, due to data URL length limits. It is always
For very complex charts, it's possible that exporting fail in browsers that
don't support Blob objects, due to data URL length limits. It's always
recommended to define the
[exporting.error](https://api.highcharts.com/highcharts/exporting.error)
callback if you disable fallback, so that you can provide details to your users
if export is not working for them.
callback when disabling the fallback, so that details can be provided to the end-user
if offline export isn't working for them.

0 comments on commit c3e3f3c

Please sign in to comment.