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

Documentation about barThickness is incomplete and unclear #5853

Closed
jedrekdomanski opened this issue Nov 20, 2018 · 5 comments
Closed

Documentation about barThickness is incomplete and unclear #5853

jedrekdomanski opened this issue Nov 20, 2018 · 5 comments

Comments

@jedrekdomanski
Copy link
Contributor

I have spent around 2 hours reading your documentation looking for a way to configure barThickness option in a Bar chart but I don't see it. You say that "The bar chart defines the following configuration options. These options are merged with the global chart configuration options, Chart.defaults.global, to form the options passed to the chart. so I tried adding this option to the global option attribute, like so:

options: {
  barThickness: 0.5
}

But this doesn't work.
Why is it that I have to end up on StackOverflow looking for an answer to similar question somebody might have asked before? And it turns out that yes, somebody has already asked this question and somebody answered that it has to be placed inside scales -> xAxes property, like so:

options = {
    scales: {
        xAxes: [{
            barThickness : 73
        }]
    }
}

Where in the docs do you specify this? Nowhere does ti say that it needs to be placed inside scales -> xAxes. Could you, please, update your documentation? I find it very frustrating to work with it and very unclear. Thank you.

@benmccann benmccann changed the title Documentation about barThickness is incomplete an unclear Documentation about barThickness is incomplete and unclear Nov 21, 2018
@benmccann
Copy link
Contributor

Pull requests are welcome if you'd like to update the docs so that others don't run into the same issue

@jedrekdomanski
Copy link
Contributor Author

Sure. Do I add that to README for BarChart? I am asking because I am not sure how GitBook works. Will it pick the change automatically?

@benmccann
Copy link
Contributor

I have a pending PR to migrate from gitbook to vuepress #5847. After it's submitted I know you'll be able to see the docs rendered on your local machine. You may be able to do that now as well, but I don't know gitbook as well

Anyway, it looks like the page you were referring to is here: https://github.com/chartjs/Chart.js/blob/master/docs/charts/bar.md

@jedrekdomanski
Copy link
Contributor Author

jedrekdomanski commented Nov 21, 2018 via email

@jedrekdomanski
Copy link
Contributor Author

jedrekdomanski commented Nov 21, 2018 via email

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

No branches or pull requests

3 participants