Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: addPlotLine and addPlotBand methods are missing #17052

Closed
bm64 opened this issue Mar 3, 2022 · 4 comments · Fixed by #20373
Closed

Docs: addPlotLine and addPlotBand methods are missing #17052

bm64 opened this issue Mar 3, 2022 · 4 comments · Fixed by #20373

Comments

@bm64
Copy link
Member

bm64 commented Mar 3, 2022

Expected behaviour

Docs should include information about addPlotLine and addPlotBand methods.

Actual behaviour

Docs are missing information about addPlotLine and addPlotBand methods.
Link: https://api.highcharts.com/highcharts/Axis.addPlotBand,
https://api.highcharts.com/highcharts/Axis.addPlotLine

@ochristensen
Copy link

related: removePlotline and removePlotBand are also undocumented

@cnighswonger
Copy link

This was reported by me over a year ago. See here.

And it still does not appear to be in the docs. Maybe Highcharts needs to hire a document manager? 😄

@TorsteinHonsi
Copy link
Collaborator

I think this is actually more a docs bug than an enhancement. We already have the doclet, probably something in the documentation build is failing:

/**
* Add a plot line after render time.
*
* @sample highcharts/members/axis-addplotline/
* Toggle the plot line from a button
*
* @function Highcharts.Axis#addPlotLine
*
* @param {Highcharts.AxisPlotLinesOptions} options
* A configuration object for the plot line, as defined in
* [xAxis.plotLines](https://api.highcharts.com/highcharts/xAxis.plotLines).
*
* @return {Highcharts.PlotLineOrBand|undefined}
* The added plot line, or `undefined` if the options are not valid.
*/

@cnighswonger
Copy link

Thanks @TorsteinHonsi

You all are awesome! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants