highcharts / api-docs Goto Github PK

It should be like this:

The inheritance is as follows

Line => Column => Histogram.

The connectNulls property is excluded in the Column series, which works correctly. The Histogram series inherits from column, but the connectNulls property (and others) appear there, which is not correct.

Jamfør ColumnSeries.js. All the properties are still listed in plotOptions.column.

• plotOptions.series is the basics. This is correct.
• plotOptions.line should inherit plotOptions.series, which seems to go wrong.
• plotOptions.area should inherit plotOptions.line, which seems to be correct, but things are missing in the previous step.

http://localhost:8000/highcharts/plotOptions.column.states.hover.html

The column hover state is missing borderColor and color as defined in ColumnSeries.js.

On the other side, halo and lineWidthPlus should be excluded.

They have the @product highstock tag set correctly, still appearing in Highcharts.

It is not clear to users, when an option is marked deprecated.

Example 1, the top level description for xAxis should be different between Highcharts an Highmaps: http://api.highcharts.com/highcharts/xAxis, http://api.highcharts.com/highmaps/xAxis.

Example 2, http://api.highcharts.com/highmaps/xAxis.allowDecimals has a different description in Highmaps.

Example 3, http://api.highcharts.com/highstock/title.text. Highstock has title.text to null by default, while it is Chart title in Highcharts.

While preparing a fix for this, we should print out a list of the corresponding properties that have different values (including different default value).

Edit: The safest approach, at least initially, would be to maintain completely separate doclets for the products in cases where any property differs. Later we can explore the possibility of allowing differences in specific properties, like @defaults, or @sample's that are filtered by product.

http://localhost:8000/highcharts/plotOptions.treemap.html

is not listing borderColor, borderWidth and opacity defined in treemap.src.js

In cases where a doclet is defined as such:

/**
* A custom class name, in addition to the default `highcharts-plot-
* line`, to apply to each individual line.
*/

there's an extra space in the output (highcharts-plot- line). There are also several cases of straight up newlines inside doclet descriptions, which leads to e.g. highcharts-plot-\nband.

Case: http://localhost:8000/highcharts/plotOptions.errorbar.whiskerWidth.html

The errorbar inherits boxplot. Error bar has a default whiskerWidth of null, which has a meaning in Highcharts. This is a common pattern.

See highcharts/highcharts#8713

Strings are correctly parsed, while boolean false as well as numbers seems to not be parsed.

Case: drilldown.drillUpButton.position, where the default value for align is correctly parsed, but not x and y.

http://localhost:9700/highcharts/chart.backgroundColor.html

http://localhost:9005/highcharts/plotOptions.line.html

• allAreas is specific to Highmaps, shouldn't be here.
• dataGrouping is specific to Highstock.

fn is never called. As you can see from lib/index.js#L94

The menu layout doesn't reflect the difference between nested objects and the series array where the type property dictates what options are available.

In the current API it is presented like this to highlight that type is an option:

Products are given in curly brackets:

@default {highcharts} true

Multiple products should be supported:

@default {highcharts|highstock} true

When left out, the default should apply to all products:

@default true

Multiple tags should be supported on each doclet:

@default {highcharts|highstock} true
@default {highmaps} false

The existing API has context information, I think from a simple context property in the document.

The Highcharts.Point link is broken under the pointFormatter option:
https://api.highcharts.com/highcharts/tooltip.pointFormatter

In extended options, existing properties are not overwritten.

For example, the default of plotOptions.scatter.findNearestPointBy should be xy, but the API says x.

Another example, plotOptions.column.cropThreshold should be 50 by default, and marker should be removed.

Properties that don't exist on the parent object are correctly handled.

Use an edit icon for "defined in".

There's the "View as JSON" link in the UI, but the tree.json file is not found in the output.

Marketing-department want Google Analytics on our API - in general and specific on JSFiddle-URL's.

Contact Linda for more detailed information.

They want it asap, as they want to start gathering data as soon as possible.

Every type that starts with Highcharts. should be a link to the corresponding class, interface, or type.

Hi, not sure if this issues is correct in this repo.

In https://api.highcharts.com/highcharts/yAxis.endOnTick yAxis.endOnTick true example send to reflow example https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/chart/reflow-true/

Like this:

Case: http://localhost:8000/highcharts/plotOptions.errorbar.whiskerWidth.html

The samples listed here are inherited from the parent, while the one sample actually defined for the error bar is not listed.

I think the best practice would be to not list samples from the parent, and completely remove then and replace them by samples from the current item.

It looks like I have some problems with jsdoc-api generator. Details:

$ gulp jsdoc --watch
[11:58:08] Using gulpfile ~/projects/projects/highcharts/gulpfile.js
[11:58:08] Starting ‘jsdoc’...
Watching file changes in JS files and templates
Starting API docs server http://localhost:9005
[11:58:11] Documented 24 files!
[11:58:11] Finished ‘jsdoc’ after 3.16 s
Created class-reference
[11:58:12] /Users/pawelfus/projects/projects/highcharts/tools/jsdoc/plugins/highcharts.jsdoc.js:168
s = comment.indexOf(‘@optionparent’);

TypeError: Cannot read property ‘indexOf’ of undefined
at Object.nodeVisitor [as visitNode] (/Users/pawelfus/projects/projects/highcharts/tools/jsdoc/plugins/highcharts.jsdoc.js:168:20)
…

In the highcharts.jsdoc.js file, this is responsible line:

comment = node.leadingComments[0].raw;

Changing to

comment = node.leadingComments[0].raw || ‘’;

generates api docs, however I’m not sure what exactly happens here. @christer ?

Current links to examples on JSFiddle uses http, this should be replaced with the use of https in stead.

Only six series types exist in Highmaps, see http://api.highcharts.com/highmaps/plotOptions

Are product tags missing on the optionparents?

seriesType('area', 'line', 
	/**
	 * @extends {plotOptions.line}
	 * @optionparent plotOptions.area
	 */
	{

Case: http://localhost:8000/highcharts/exporting.menuItemDefinitions.html where all the children should be ignored.

The build script has function for getting the pallette colors (from highcharts.scss) and replacing them in JS files, we can probably reuse those. It's part of the build assembly.

Bing search API responses with 401

Remove these after patching source code

• In Highstock, plotOptions.plotband
• In Highstock, symbols on the top level.

The styling of links that refer to classes should be changed. Now they look just like a regular non-clickable text:

Example: https://api.highcharts.com/highcharts/series.line.dataLabels

For example chart.events.

If I remember correctly this was an issue also with the current API.

Instead space gets catched by suggestion navigation.

1. Click "plotOptions" => Expected to see the plotOptions listing page like http://api.highcharts.com/highcharts/plotOptions

2. Refresh. Click "plotOptions" then "area" then "plotOptions" => Page is scrolling randomly and the expected page is not loaded.

We could simply hide the Global menu item, but first discuss with @cvasseng if we can filter them out earlier.

For example code from Axis is visible in API as-is, no code tags.

Visible in local dev and prod: https://api.highcharts.com/highstock/xAxis.startOnTick

Adding support for product blacklisting in the @products tag would make things less verbose in situations where e.g. an option is enabled for 3/4 products.

The syntax could be:

@products  -highmaps

In order to retain compatibility with other tools, this should be rewritten automatically during the parsing stage to the current whitelisting form.