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.

Sign up for GitHub

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

Supply docs for barThickness #5854

Merged
merged 5 commits into from
Nov 28, 2018
Merged

Supply docs for barThickness #5854

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f4a0a4
Supply docs for barThickness
jedrekdomanski Nov 21, 2018
3295468
Update description and indentation
jedrekdomanski Nov 22, 2018
52e1028
Reword parent section and description
jedrekdomanski Nov 26, 2018
2efce11
Remove redundant text and code snippet
jedrekdomanski Nov 27, 2018
c806568
Update anchor link to point to new heading name
jedrekdomanski Nov 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/charts/bar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,16 @@ The bar chart defines the following configuration options. These options are mer
| `gridLines.offsetGridLines` | `Boolean` | `true` | If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval. If false, the grid line will go right down the middle of the bars. [more...](#offsetgridlines)

### barThickness
This option needs to be configured on x axis in scales property.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to make this align with the docs for offsetGridLines. That means both that we should match the language (i.e. "This setting applies to the axis configuration.") and indentation (i.e. use 4-space indenting for the code sample)

```javascript
options: {
scales: {
xAxes: [{
barThickness: 6
}]
}
}
```
If this value is a number, it is applied to the width of each bar, in pixels. When this is enforced, `barPercentage` and `categoryPercentage` are ignored.

If set to `'flex'`, the base sample widths are calculated automatically based on the previous and following samples so that they take the full available widths without overlap. Then, bars are sized using `barPercentage` and `categoryPercentage`. There is no gap when the percentage options are 1. This mode generates bars with different widths when data are not evenly spaced.
Expand Down