Thanks to visit codestin.com
Credit goes to github.com

Skip to content

create_gantt missing parameter documentation #1210

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

Jump to bottom
Closed
brylie opened this issue Oct 3, 2018 · 4 comments
Closed

create_gantt missing parameter documentation #1210

brylie opened this issue Oct 3, 2018 · 4 comments

Comments

@brylie
Copy link

brylie commented Oct 3, 2018 •
edited
Loading

The figure_factory create_gantt method takes several arguments. Most of the arguments are documented, but a couple of them have no documentation:

plotly.py/plotly/figure_factory/_gantt.py

Lines 584 to 616 in 2e5bf6e

def create_gantt(df, colors=None, index_col=None, show_colorbar=False,
reverse_colors=False, title='Gantt Chart', bar_width=0.2,
showgrid_x=False, showgrid_y=False, height=600, width=900,
tasks=None, task_names=None, data=None, group_tasks=False):
"""
Returns figure for a gantt chart
:param (array|list) df: input data for gantt chart. Must be either a
a dataframe or a list. If dataframe, the columns must include
'Task', 'Start' and 'Finish'. Other columns can be included and
used for indexing. If a list, its elements must be dictionaries
with the same required column headers: 'Task', 'Start' and
'Finish'.
:param (str|list|dict|tuple) colors: either a plotly scale name, an
rgb or hex color, a color tuple or a list of colors. An rgb color
is of the form 'rgb(x, y, z)' where x, y, z belong to the interval
[0, 255] and a color tuple is a tuple of the form (a, b, c) where
a, b and c belong to [0, 1]. If colors is a list, it must
contain the valid color types aforementioned as its members.
If a dictionary, all values of the indexing column must be keys in
colors.
:param (str|float) index_col: the column header (if df is a data
frame) that will function as the indexing column. If df is a list,
index_col must be one of the keys in all the items of df.
:param (bool) show_colorbar: determines if colorbar will be visible.
Only applies if values in the index column are numeric.
:param (bool) reverse_colors: reverses the order of selected colors
:param (str) title: the title of the chart
:param (float) bar_width: the width of the horizontal bars in the plot
:param (bool) showgrid_x: show/hide the x-axis grid
:param (bool) showgrid_y: show/hide the y-axis grid
:param (float) height: the height of the chart
:param (float) width: the width of the chart

Please add missing documentation to this factory method.
@jonmmease
Copy link
Contributor

Thanks for taking the time to report this @brylie, looks like the undocumented arguments are tasks, task_names, data, and group_tasks.

@astrojuanlu
Copy link
Contributor

And also Description, which was added here #588

@ethanopp
Copy link

Is there a way to define the sort order on the Y-Axis of grouped tasks?

@anuraghuram anuraghuram mentioned this issue Jun 5, 2020
Closed
@gvwilson
Copy link
Contributor

Hi - we are currently trying to tidy up Plotly's public repositories to help us focus our efforts on things that will help users most. Since this issue has been sitting for several years, I'm going to close it. If it's still a concern, we'd be grateful if you could open a new issue (with a short reproducible example if appropriate) so that we can add it to our backlog. Thanks for your help - @gvwilson

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@brylie @astrojuanlu @gvwilson @ethanopp @jonmmease