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

controlsUseVisibility documentation is incorrect in Getting Started guide #1474

Closed
ialarmedalien opened this issue Aug 19, 2018 · 2 comments
Closed

Comments

@ialarmedalien
Copy link
Contributor

An easy documentation fix I spotted...

According to the dc.js Getting Started guide:

dc.js >=2.1 uses visibility: hidden to hide/show controls without disrupting the layout. To return the old display: none behavior, set chart.controlsUseVisibility(false) and use that style instead.

However, the API docs and the dc behaviour is the opposite: the default is to use display: none and chart.controlsUseVisibility has to be set to true to trigger the behaviour. Suggest changing the docs to

By default, dc.js uses display: none to control whether or not chart controls are displayed. To use visibility: hidden to hide/show controls without disrupting the layout, set chart.controlsUseVisibility(true).

@gordonwoodhull
Copy link
Contributor

Thanks! I think I originally thought I would just change the behavior, then went back and made it backward-compatible instead. But I forgot I had documented it in the Getting Started guide.

@gordonwoodhull
Copy link
Contributor

Thanks @ialarmedalien! fixed via #1475 in 3.0.7.

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

No branches or pull requests

2 participants