From fc640797c4177bd1f0a2a70a709a9a4ac9858a4d Mon Sep 17 00:00:00 2001 From: Nicolas Kruchten Date: Wed, 8 Jul 2020 15:28:20 -0400 Subject: [PATCH 1/3] bar base and timeline --- CHANGELOG.md | 4 +- doc/python/gantt.md | 142 +++++++++--------- .../python/plotly/plotly/express/__init__.py | 2 + .../plotly/plotly/express/_chart_types.py | 49 ++++++ .../python/plotly/plotly/express/_core.py | 36 ++++- packages/python/plotly/plotly/express/_doc.py | 15 ++ .../test_core/test_px/test_px_functions.py | 32 +++- test/percy/plotly-express.py | 85 +++-------- 8 files changed, 224 insertions(+), 141 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fdd156f882f..32355ccdb43 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,13 +2,14 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). - ## [4.9.0] - unreleased ### Added - `px.NO_COLOR` constant to override wide-form color assignment in Plotly Express ([#2614](https://github.com/plotly/plotly.py/pull/2614)) - `facet_row_spacing` and `facet_col_spacing` added to Plotly Express cartesian 2d functions ([#2614](https://github.com/plotly/plotly.py/pull/2614)) +- `base` added to Plotly Express `bar` and `bar_polar` functions +- `plotly.express.timeline()` added as an official alternative to `plotly.figure_factories.create_gantt()` ### Fixed @@ -21,6 +22,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). + ## [4.8.2] - 2020-06-26 ### Updated diff --git a/doc/python/gantt.md b/doc/python/gantt.md index dc83b3ba002..33908bf139a 100644 --- a/doc/python/gantt.md +++ b/doc/python/gantt.md @@ -5,8 +5,8 @@ jupyter: text_representation: extension: .md format_name: markdown - format_version: '1.1' - jupytext_version: 1.1.1 + format_version: '1.2' + jupytext_version: 1.4.2 kernelspec: display_name: Python 3 language: python @@ -20,7 +20,7 @@ jupyter: name: python nbconvert_exporter: python pygments_lexer: ipython3 - version: 3.6.7 + version: 3.7.7 plotly: description: How to make Gantt Charts in Python with Plotly. Gantt Charts use horizontal bars to represent the start and end times of tasks. @@ -37,109 +37,100 @@ jupyter: A [Gantt chart](https://en.wikipedia.org/wiki/Gantt_chart) is a type of bar chart that illustrates a project schedule. The chart lists the tasks to be performed on the vertical axis, and time intervals on the horizontal axis. The width of the horizontal bars in the graph shows the duration of each activity. -Gantt charts can be made using a [figure factory](/python/figure-factories/) as detailed in this page. See also the [bar charts examples](https://plotly.com/python/bar-charts/). +### Gantt Charts and Timelines with plotly.express +[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/). With `px.timeline` (*introduced in version 4.9*) each data point is represented as a horizontal bar with a start and end point specified as dates. -#### Simple Gantt Chart +The `px.timeline` function by default sets the X-axis to be of `type=date`, so it can be configured like any [time-series chart](/python/time-series/). + +Plotly Express also supports a [general-purpose `px.bar` function for bar charts](/python/bar-charts/). ```python -import plotly.figure_factory as ff +import plotly.express as px +import pandas as pd -df = [dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28'), - dict(Task="Job B", Start='2009-03-05', Finish='2009-04-15'), - dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30')] +df = pd.DataFrame([ + dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28'), + dict(Task="Job B", Start='2009-03-05', Finish='2009-04-15'), + dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30') +]) -fig = ff.create_gantt(df) +fig = px.timeline(df, x_start="Start", x_end="Finish", y="Task") +fig.update_yaxes(autorange="reversed") # otherwise tasks are listed from the bottom up fig.show() ``` -#### Index by Numeric Variable +`px.timeline` supports [discrete color](/python/discrete-color/) as above, or [continuous color](/python/colorscales/) as follows. ```python -import plotly.figure_factory as ff +import plotly.express as px +import pandas as pd -df = [dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28', Complete=10), - dict(Task="Job B", Start='2008-12-05', Finish='2009-04-15', Complete=60), - dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30', Complete=95)] +df = pd.DataFrame([ + dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28', Resource="Alex"), + dict(Task="Job B", Start='2009-03-05', Finish='2009-04-15', Resource="Alex"), + dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30', Resource="Max") +]) -fig = ff.create_gantt(df, colors='Viridis', index_col='Complete', show_colorbar=True) +fig = px.timeline(df, x_start="Start", x_end="Finish", y="Task", color="Resource") +fig.update_yaxes(autorange="reversed") fig.show() ``` -#### Index by String Variable - ```python -import plotly.figure_factory as ff - -df = [dict(Task="Job A", Start='2009-01-01', Finish='2009-02-01', Resource='Apple'), - dict(Task="Job B", Start='2009-03-05', Finish='2009-04-15', Resource='Grape'), - dict(Task="Job C", Start='2009-04-20', Finish='2009-09-30', Resource='Banana')] +import plotly.express as px +import pandas as pd -colors = ['#7a0504', (0.2, 0.7, 0.3), 'rgb(210, 60, 180)'] +df = pd.DataFrame([ + dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28', Completion_pct=50), + dict(Task="Job B", Start='2009-03-05', Finish='2009-04-15', Completion_pct=25), + dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30', Completion_pct=75) +]) -fig = ff.create_gantt(df, colors=colors, index_col='Resource', reverse_colors=True, - show_colorbar=True) +fig = px.timeline(df, x_start="Start", x_end="Finish", y="Task", color="Completion_pct") +fig.update_yaxes(autorange="reversed") fig.show() ``` -#### Use a Dictionary for Colors +It is also possible to have multiple bars on the same horizontal line, say by resource: -```python -import plotly.figure_factory as ff +*Note*: When setting `color` to the same value as `y`, `autorange` should not be set to `reverse`, so as to list the value of the Y axis in the same order as the legend entries. -df = [dict(Task="Job A", Start='2016-01-01', Finish='2016-01-02', Resource='Apple'), - dict(Task="Job B", Start='2016-01-02', Finish='2016-01-04', Resource='Grape'), - dict(Task="Job C", Start='2016-01-02', Finish='2016-01-03', Resource='Banana')] +```python +import plotly.express as px +import pandas as pd -colors = dict(Apple='rgb(220, 0, 0)', Grape='rgb(170, 14, 200)', Banana=(1, 0.9, 0.16)) +df = pd.DataFrame([ + dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28', Resource="Alex"), + dict(Task="Job B", Start='2009-03-05', Finish='2009-04-15', Resource="Alex"), + dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30', Resource="Max") +]) -fig = ff.create_gantt(df, colors=colors, index_col='Resource', show_colorbar=True) +fig = px.timeline(df, x_start="Start", x_end="Finish", y="Resource", color="Resource") fig.show() ``` -#### Use a Pandas Dataframe +#### Deprecated Figure Factory + +Prior to the introduction of `plotly.express.timeline()` in version 4.9, the recommended way to make Gantt charts was to use the now-deprecated `create_gantt()` [figure factory](/python/figure-factories/), as follows: ```python import plotly.figure_factory as ff -import pandas as pd -df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/gantt_example.csv') +df = [dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28'), + dict(Task="Job B", Start='2009-03-05', Finish='2009-04-15'), + dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30')] -fig = ff.create_gantt(df, colors=['#333F44', '#93e4c1'], index_col='Complete', - show_colorbar=True, bar_width=0.2, showgrid_x=True, showgrid_y=True) +fig = ff.create_gantt(df) fig.show() ``` -#### Using Hours and Minutes in Times - -```python -import plotly.figure_factory as ff + +#### Group Tasks Together -df = [ - dict(Task='Morning Sleep', Start='2016-01-01', Finish='2016-01-01 6:00:00', Resource='Sleep'), - dict(Task='Breakfast', Start='2016-01-01 7:00:00', Finish='2016-01-01 7:30:00', Resource='Food'), - dict(Task='Work', Start='2016-01-01 9:00:00', Finish='2016-01-01 11:25:00', Resource='Brain'), - dict(Task='Break', Start='2016-01-01 11:30:00', Finish='2016-01-01 12:00:00', Resource='Rest'), - dict(Task='Lunch', Start='2016-01-01 12:00:00', Finish='2016-01-01 13:00:00', Resource='Food'), - dict(Task='Work', Start='2016-01-01 13:00:00', Finish='2016-01-01 17:00:00', Resource='Brain'), - dict(Task='Exercise', Start='2016-01-01 17:30:00', Finish='2016-01-01 18:30:00', Resource='Cardio'), - dict(Task='Post Workout Rest', Start='2016-01-01 18:30:00', Finish='2016-01-01 19:00:00', Resource='Rest'), - dict(Task='Dinner', Start='2016-01-01 19:00:00', Finish='2016-01-01 20:00:00', Resource='Food'), - dict(Task='Evening Sleep', Start='2016-01-01 21:00:00', Finish='2016-01-01 23:59:00', Resource='Sleep') -] - -colors = dict(Cardio = 'rgb(46, 137, 205)', - Food = 'rgb(114, 44, 121)', - Sleep = 'rgb(198, 47, 105)', - Brain = 'rgb(58, 149, 136)', - Rest = 'rgb(107, 127, 135)') - -fig = ff.create_gantt(df, colors=colors, index_col='Resource', title='Daily Schedule', - show_colorbar=True, bar_width=0.8, showgrid_x=True, showgrid_y=True) -fig.show() -``` -#### Group Tasks Together +The following example shows how to use the now-deprecated `create_gantt()` [figure factory](/python/figure-factories/) to color tasks by a numeric variable. + ```python import plotly.figure_factory as ff @@ -162,7 +153,22 @@ fig = ff.create_gantt(df, colors=colors, index_col='Resource', show_colorbar=Tru fig.show() ``` +#### Color by Numeric Variable + +The following example shows how to use the now-deprecated `create_gantt()` [figure factory](/python/figure-factories/) to color tasks by a numeric variable. + +```python +import plotly.figure_factory as ff + +df = [dict(Task="Job A", Start='2009-01-01', Finish='2009-02-28', Complete=10), + dict(Task="Job B", Start='2008-12-05', Finish='2009-04-15', Complete=60), + dict(Task="Job C", Start='2009-02-20', Finish='2009-05-30', Complete=95)] + +fig = ff.create_gantt(df, colors='Viridis', index_col='Complete', show_colorbar=True) +fig.show() +``` + #### Reference -For more info on `ff.create_gantt()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_gantt.html) \ No newline at end of file +For more info on `ff.create_gantt()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_gantt.html) diff --git a/packages/python/plotly/plotly/express/__init__.py b/packages/python/plotly/plotly/express/__init__.py index bec7e915cc9..4bffa25d784 100644 --- a/packages/python/plotly/plotly/express/__init__.py +++ b/packages/python/plotly/plotly/express/__init__.py @@ -28,6 +28,7 @@ line_geo, area, bar, + timeline, bar_polar, violin, box, @@ -81,6 +82,7 @@ "parallel_categories", "area", "bar", + "timeline", "bar_polar", "violin", "box", diff --git a/packages/python/plotly/plotly/express/_chart_types.py b/packages/python/plotly/plotly/express/_chart_types.py index cb56f127d0f..3a6d6d5b1aa 100644 --- a/packages/python/plotly/plotly/express/_chart_types.py +++ b/packages/python/plotly/plotly/express/_chart_types.py @@ -317,6 +317,7 @@ def bar( hover_data=None, custom_data=None, text=None, + base=None, error_x=None, error_x_minus=None, error_y=None, @@ -357,6 +358,53 @@ def bar( bar.__doc__ = make_docstring(bar, append_dict=_cartesian_append_dict) +def timeline( + data_frame=None, + x_start=None, + x_end=None, + y=None, + color=None, + facet_row=None, + facet_col=None, + facet_col_wrap=0, + facet_row_spacing=None, + facet_col_spacing=None, + hover_name=None, + hover_data=None, + custom_data=None, + text=None, + animation_frame=None, + animation_group=None, + category_orders={}, + labels={}, + color_discrete_sequence=None, + color_discrete_map={}, + color_continuous_scale=None, + range_color=None, + color_continuous_midpoint=None, + opacity=None, + range_x=None, + range_y=None, + title=None, + template=None, + width=None, + height=None, +): + """ + In a timeline plot, each row of `data_frame` is represented as a rectangular + mark on an x axis of type `date`, spanning from `x_start` to `x_end`. + """ + return make_figure( + args=locals(), + constructor="timeline", + trace_patch=dict(textposition="auto", orientation="h"), + layout_patch=dict(barmode="overlay"), + ) + + +timeline.__doc__ = make_docstring(timeline) + + def histogram( data_frame=None, x=None, @@ -847,6 +895,7 @@ def bar_polar( hover_name=None, hover_data=None, custom_data=None, + base=None, animation_frame=None, animation_group=None, category_orders={}, diff --git a/packages/python/plotly/plotly/express/_core.py b/packages/python/plotly/plotly/express/_core.py index fcbac2202d1..a97d52c21f8 100644 --- a/packages/python/plotly/plotly/express/_core.py +++ b/packages/python/plotly/plotly/express/_core.py @@ -19,7 +19,7 @@ # Declare all supported attributes, across all plot types direct_attrables = ( - ["x", "y", "z", "a", "b", "c", "r", "theta", "size"] + ["base", "x", "y", "z", "a", "b", "c", "r", "theta", "size", "x_start", "x_end"] + ["hover_name", "text", "names", "values", "parents", "wide_cross"] + ["ids", "error_x", "error_x_minus", "error_y", "error_y_minus", "error_z"] + ["error_z_minus", "lat", "lon", "locations", "animation_group"] @@ -610,7 +610,8 @@ def configure_cartesian_axes(args, fig, orders): # Set x-axis titles and axis options in the bottom-most row x_title = get_decorated_label(args, args["x"], "x") for xaxis in fig.select_xaxes(row=1): - xaxis.update(title_text=x_title) + if "is_timeline" not in args: + xaxis.update(title_text=x_title) set_cartesian_axis_opts(args, xaxis, "x", orders) # Configure axis type across all x-axes @@ -621,6 +622,9 @@ def configure_cartesian_axes(args, fig, orders): if "log_y" in args and args["log_y"]: fig.update_yaxes(type="log") + if "is_timeline" in args: + fig.update_xaxes(type="date") + return fig.layout @@ -1599,6 +1603,31 @@ def aggfunc_continuous(x): return args +def process_dataframe_timeline(args): + """ + Massage input for bar traces for px.timeline() + """ + args["is_timeline"] = True + if args["x_start"] is None or args["x_end"] is None: + raise ValueError("Both x_start and x_end are required") + + try: + x_start = pd.to_datetime(args["data_frame"][args["x_start"]]) + x_end = pd.to_datetime(args["data_frame"][args["x_end"]]) + except (ValueError, TypeError): + raise TypeError( + "Both x_start and x_end must refer to data convertible to datetimes." + ) + + # note that we are not adding any columns to the data frame here, so no risk of overwrite + args["data_frame"][args["x_end"]] = (x_end - x_start).astype("timedelta64[ms]") + args["x"] = args["x_end"] + del args["x_end"] + args["base"] = args["x_start"] + del args["x_start"] + return args + + def infer_config(args, constructor, trace_patch, layout_patch): attrs = [k for k in direct_attrables + array_attrables if k in args] grouped_attrs = [] @@ -1801,6 +1830,9 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None): args = build_dataframe(args, constructor) if constructor in [go.Treemap, go.Sunburst] and args["path"] is not None: args = process_dataframe_hierarchy(args) + if constructor == "timeline": + constructor = go.Bar + args = process_dataframe_timeline(args) trace_specs, grouped_mappings, sizeref, show_colorbar = infer_config( args, constructor, trace_patch, layout_patch diff --git a/packages/python/plotly/plotly/express/_doc.py b/packages/python/plotly/plotly/express/_doc.py index ab71d3b1ca9..6cb427fd4cc 100644 --- a/packages/python/plotly/plotly/express/_doc.py +++ b/packages/python/plotly/plotly/express/_doc.py @@ -36,6 +36,16 @@ colref_desc, "Values from this column or array_like are used to position marks along the z axis in cartesian coordinates.", ], + x_start=[ + colref_type, + colref_desc, + "Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.", + ], + x_end=[ + colref_type, + colref_desc, + "Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.", + ], a=[ colref_type, colref_desc, @@ -97,6 +107,11 @@ colref_desc, "Values from this column or array_like are to be interpreted according to `locationmode` and mapped to longitude/latitude.", ], + base=[ + colref_type, + colref_desc, + "Values from this column or array_like are used to position the base of the bar.", + ], dimensions=[ colref_list_type, colref_list_desc, diff --git a/packages/python/plotly/plotly/tests/test_core/test_px/test_px_functions.py b/packages/python/plotly/plotly/tests/test_core/test_px/test_px_functions.py index 8dde6a7be4e..00245db3ab5 100644 --- a/packages/python/plotly/plotly/tests/test_core/test_px/test_px_functions.py +++ b/packages/python/plotly/plotly/tests/test_core/test_px/test_px_functions.py @@ -127,7 +127,7 @@ def test_sunburst_treemap_with_path(): ] regions = ["North", "North", "North", "North", "South", "South", "South", "South"] values = [1, 3, 2, 4, 2, 2, 1, 4] - total = ["total",] * 8 + total = ["total"] * 8 df = pd.DataFrame( dict( vendors=vendors, @@ -206,7 +206,7 @@ def test_sunburst_treemap_with_path_color(): regions = ["North", "North", "North", "North", "South", "South", "South", "South"] values = [1, 3, 2, 4, 2, 2, 1, 4] calls = [8, 2, 1, 3, 2, 2, 4, 1] - total = ["total",] * 8 + total = ["total"] * 8 df = pd.DataFrame( dict( vendors=vendors, @@ -277,7 +277,7 @@ def test_sunburst_treemap_with_path_non_rectangular(): "South", ] values = [1, 3, 2, 4, 1, 2, 2, 1, 4, 1] - total = ["total",] * 10 + total = ["total"] * 10 df = pd.DataFrame( dict( vendors=vendors, @@ -357,3 +357,29 @@ def test_parcats_dimensions_max(): df, dimensions=["sex", "smoker", "day", "size"], dimensions_max_cardinality=4 ) assert [d.label for d in fig.data[0].dimensions] == ["sex", "smoker", "day", "size"] + + +def test_timeline(): + df = pd.DataFrame( + [ + dict(Task="Job A", Start="2009-01-01", Finish="2009-02-28"), + dict(Task="Job B", Start="2009-03-05", Finish="2009-04-15"), + dict(Task="Job C", Start="2009-02-20", Finish="2009-05-30"), + ] + ) + fig = px.timeline(df, x_start="Start", x_end="Finish", y="Task", color="Task") + assert len(fig.data) == 3 + assert fig.layout.xaxis.type == "date" + assert fig.layout.xaxis.title.text is None + fig = px.timeline(df, x_start="Start", x_end="Finish", y="Task", facet_row="Task") + assert len(fig.data) == 3 + assert fig.data[1].xaxis == "x2" + assert fig.layout.xaxis.type == "date" + + msg = "Both x_start and x_end are required" + with pytest.raises(ValueError, match=msg): + px.timeline(df, x_start="Start", y="Task", color="Task") + + msg = "Both x_start and x_end must refer to data convertible to datetimes." + with pytest.raises(TypeError, match=msg): + px.timeline(df, x_start="Start", x_end=["a", "b", "c"], y="Task", color="Task") diff --git a/test/percy/plotly-express.py b/test/percy/plotly-express.py index 0a1b1064c50..3b948f82ea3 100644 --- a/test/percy/plotly-express.py +++ b/test/percy/plotly-express.py @@ -1,31 +1,26 @@ -## This script uses px functions to generate html figures, which will be -## tested with percy. - -# this directory +import plotly.express as px +import numpy as np import os +import pandas as pd -dir_name = os.path.join("test", "percy") +# This script uses px functions to generate html figures, which will be +# tested with percy. -import plotly.express as px - -print(px.data.iris.__doc__) -px.data.iris().head() +# this directory +dir_name = os.path.join("test", "percy") # #### Scatter and Line plots -import plotly.express as px iris = px.data.iris() fig = px.scatter(iris, x="sepal_width", y="sepal_length") fig.write_html(os.path.join(dir_name, "scatter.html")) -import plotly.express as px iris = px.data.iris() fig = px.scatter(iris, x="sepal_width", y="sepal_length", color="species") fig.write_html(os.path.join(dir_name, "scatter_color.html")) -import plotly.express as px iris = px.data.iris() fig = px.scatter( @@ -38,7 +33,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_marginal.html")) -import plotly.express as px iris = px.data.iris() fig = px.scatter( @@ -52,7 +46,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_trendline.html")) -import plotly.express as px iris = px.data.iris() iris["e"] = iris["sepal_width"] / 100 @@ -61,7 +54,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_errorbar.html")) -import plotly.express as px tips = px.data.tips() fig = px.scatter( @@ -76,13 +68,11 @@ ) fig.write_html(os.path.join(dir_name, "scatter_categories.html")) -import plotly.express as px iris = px.data.iris() fig = px.scatter_matrix(iris) fig.write_html(os.path.join(dir_name, "scatter_matrix.html")) -import plotly.express as px iris = px.data.iris() fig = px.scatter_matrix( @@ -92,7 +82,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_matrix_dimensions.html")) -import plotly.express as px iris = px.data.iris() fig = px.parallel_coordinates( @@ -110,7 +99,6 @@ ) fig.write_html(os.path.join(dir_name, "parallel_coordinates.html")) -import plotly.express as px tips = px.data.tips() fig = px.parallel_categories( @@ -118,7 +106,6 @@ ) fig.write_html(os.path.join(dir_name, "parallel_categories.html")) -import plotly.express as px tips = px.data.tips() fig = px.scatter( @@ -132,7 +119,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_webgl.html")) -import plotly.express as px gapminder = px.data.gapminder() fig = px.scatter( @@ -147,7 +133,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_hover.html")) -import plotly.express as px gapminder = px.data.gapminder() fig = px.scatter( @@ -167,7 +152,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_log.html"), auto_play=False) -import plotly.express as px gapminder = px.data.gapminder() fig = px.line( @@ -182,7 +166,6 @@ ) fig.write_html(os.path.join(dir_name, "line.html")) -import plotly.express as px tips = px.data.tips() fig = px.scatter( @@ -195,7 +178,6 @@ ) fig.write_html(os.path.join(dir_name, "facet_wrap_neat.html")) -import plotly.express as px tips = px.data.tips() fig = px.scatter( @@ -209,7 +191,6 @@ ) fig.write_html(os.path.join(dir_name, "facet_wrap_ragged.html")) -import plotly.express as px gapminder = px.data.gapminder() fig = px.area(gapminder, x="year", y="pop", color="continent", line_group="country") @@ -217,13 +198,11 @@ # #### Visualize Distributions -import plotly.express as px iris = px.data.iris() fig = px.density_contour(iris, x="sepal_width", y="sepal_length") fig.write_html(os.path.join(dir_name, "density_contour.html")) -import plotly.express as px iris = px.data.iris() fig = px.density_contour( @@ -236,7 +215,6 @@ ) fig.write_html(os.path.join(dir_name, "density_contour_marginal.html")) -import plotly.express as px iris = px.data.iris() fig = px.density_heatmap( @@ -244,13 +222,11 @@ ) fig.write_html(os.path.join(dir_name, "density_heatmap.html")) -import plotly.express as px tips = px.data.tips() fig = px.bar(tips, x="sex", y="total_bill", color="smoker", barmode="group") fig.write_html(os.path.join(dir_name, "bar.html")) -import plotly.express as px tips = px.data.tips() fig = px.bar( @@ -265,7 +241,6 @@ ) fig.write_html(os.path.join(dir_name, "bar_facet.html")) -import plotly.express as px tips = px.data.tips() fig = px.histogram( @@ -273,7 +248,6 @@ ) fig.write_html(os.path.join(dir_name, "histogram.html")) -import plotly.express as px tips = px.data.tips() fig = px.histogram( @@ -289,19 +263,16 @@ ) fig.write_html(os.path.join(dir_name, "histogram_histfunc.html")) -import plotly.express as px tips = px.data.tips() fig = px.strip(tips, x="total_bill", y="time", orientation="h", color="smoker") fig.write_html(os.path.join(dir_name, "strip.html")) -import plotly.express as px tips = px.data.tips() fig = px.box(tips, x="day", y="total_bill", color="smoker", notched=True) fig.write_html(os.path.join(dir_name, "box.html")) -import plotly.express as px tips = px.data.tips() fig = px.violin( @@ -317,7 +288,6 @@ # #### Ternary Coordinates -import plotly.express as px election = px.data.election() fig = px.scatter_ternary( @@ -333,7 +303,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_ternary.html")) -import plotly.express as px election = px.data.election() fig = px.line_ternary( @@ -341,8 +310,6 @@ ) fig.write_html(os.path.join(dir_name, "line_ternary.html")) -import plotly.express as px -import numpy as np img_rgb = np.array( [[[255, 0, 0], [0, 255, 0], [0, 0, 255]], [[0, 255, 0], [0, 0, 255], [255, 0, 0]]], @@ -353,7 +320,6 @@ # #### 3D Coordinates -import plotly.express as px election = px.data.election() fig = px.scatter_3d( @@ -369,7 +335,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_3d.html")) -import plotly.express as px election = px.data.election() fig = px.line_3d( @@ -379,7 +344,6 @@ # #### Polar Coordinates -import plotly.express as px wind = px.data.wind() fig = px.scatter_polar( @@ -392,7 +356,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_polar.html")) -import plotly.express as px wind = px.data.wind() fig = px.line_polar( @@ -405,7 +368,6 @@ ) fig.write_html(os.path.join(dir_name, "line_polar.html")) -import plotly.express as px wind = px.data.wind() fig = px.bar_polar( @@ -420,7 +382,6 @@ # #### Maps -import plotly.express as px carshare = px.data.carshare() fig = px.scatter_mapbox( @@ -435,7 +396,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_mapbox.html")) -import plotly.express as px carshare = px.data.carshare() fig = px.line_mapbox( @@ -443,7 +403,6 @@ ) fig.write_html(os.path.join(dir_name, "line_mapbox.html")) -import plotly.express as px sample_geojson = { "type": "FeatureCollection", @@ -465,7 +424,6 @@ ) fig.write_html(os.path.join(dir_name, "choropleth_mapbox.html"), auto_play=False) -import plotly.express as px carshare = px.data.carshare() fig = px.density_mapbox( @@ -473,8 +431,6 @@ ) fig.write_html(os.path.join(dir_name, "density_mapbox.html"), auto_play=False) -import plotly.express as px - gapminder = px.data.gapminder() fig = px.scatter_geo( @@ -488,7 +444,6 @@ ) fig.write_html(os.path.join(dir_name, "scatter_geo.html"), auto_play=False) -import plotly.express as px gapminder = px.data.gapminder() fig = px.line_geo( @@ -499,7 +454,6 @@ ) fig.write_html(os.path.join(dir_name, "line_geo.html")) -import plotly.express as px gapminder = px.data.gapminder() fig = px.choropleth( @@ -512,19 +466,16 @@ ) fig.write_html(os.path.join(dir_name, "choropleth.html"), auto_play=False) -import plotly.express as px tips = px.data.tips() fig = px.pie(tips, names="smoker", values="total_bill") fig.write_html(os.path.join(dir_name, "pie.html"), auto_play=False) -import plotly.express as px tips = px.data.tips() fig = px.funnel_area(tips, names="smoker", values="total_bill") fig.write_html(os.path.join(dir_name, "funnel_area.html"), auto_play=False) -import plotly.express as px fig = px.treemap( names=["Eve", "Cain", "Seth", "Enos", "Noam", "Abel", "Awan", "Enoch", "Azura"], @@ -534,8 +485,6 @@ fig.write_html(os.path.join(dir_name, "treemap.html"), auto_play=False) -import plotly.express as px - fig = px.sunburst( names=["Eve", "Cain", "Seth", "Enos", "Noam", "Abel", "Awan", "Enoch", "Azura"], parents=["", "Eve", "Eve", "Seth", "Seth", "Eve", "Eve", "Awan", "Eve"], @@ -544,26 +493,19 @@ fig.write_html(os.path.join(dir_name, "sunburst.html"), auto_play=False) -import plotly.express as px - fig = px.funnel( y=["first", "second", "first", "second"], x=[3, 1, 4, 2], color=["A", "A", "B", "B"] ) fig.write_html(os.path.join(dir_name, "funnel.html"), auto_play=False) -import plotly.express as px fig = px.scatter(x=[1, 2, 1, 2], y=[4, 3, 2, 4], color=[True, True, False, False]) fig.write_html(os.path.join(dir_name, "scatter_bool_color.html"), auto_play=False) -import plotly.express as px - fig = px.pie(values=[1, 2, 3, 4], color=[True, False, True, False]) fig.write_html(os.path.join(dir_name, "pie_bool_color.html"), auto_play=False) -import plotly.express as px -import numpy as np df = px.data.gapminder().query("year == 2007") np.random.seed(0) @@ -571,7 +513,6 @@ fig = px.choropleth(df, locations="iso_alpha", color="color") fig.write_html(os.path.join(dir_name, "choropleth_bool_color.html"), auto_play=False) -import plotly.express as px df = px.data.iris() df["is_setosa"] = df["species"] == "setosa" @@ -580,9 +521,19 @@ os.path.join(dir_name, "density_contour_bool_color.html"), auto_play=False ) -import plotly.express as px fig = px.sunburst( path=[["yes", "no", "no"], ["yes", "no", "a"]], color=[True, False, True] ) fig.write_html(os.path.join(dir_name, "sunburst_bool_color.html"), auto_play=False) + + +df = pd.DataFrame( + [ + dict(Task="Job A", Start="2009-01-01", Finish="2009-02-28"), + dict(Task="Job B", Start="2009-03-05", Finish="2009-04-15"), + dict(Task="Job C", Start="2009-02-20", Finish="2009-05-30"), + ] +) +fig = px.timeline(df, x_start="Start", x_end="Finish", y="Task", color="Task") +fig.write_html(os.path.join(dir_name, "timeline.html"), auto_play=False) From 43493cb565354ca6c6f790ed53f5fa695cca9835 Mon Sep 17 00:00:00 2001 From: Nicolas Kruchten Date: Thu, 9 Jul 2020 13:38:58 -0400 Subject: [PATCH 2/3] ff docs --- doc/python/figure-factories.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/python/figure-factories.md b/doc/python/figure-factories.md index aee4ddd5adc..c35dff1513d 100644 --- a/doc/python/figure-factories.md +++ b/doc/python/figure-factories.md @@ -35,13 +35,12 @@ jupyter: #### `plotly.figure_factory` -The `plotly.figure_factory` module contains dedicated functions for creating very specific types of plots that were at the time of their creation difficult to create with `plotly.graph_objects` and prior to the existence of [Plotly Express](/python/plotly-express/). As new functionality gets added to [Plotly.js](https://plotly.com/javascript/) and to Plotly Express, certain Figure Factories become unecessary and are therefore deprecated as "legacy", but remain in the module for backwards-compatibility reasons. +The `plotly.figure_factory` module contains dedicated functions for creating very specific types of plots that were at the time of their creation difficult to create with [graph objects](/python/graph-objects/) and prior to the existence of [Plotly Express](/python/plotly-express/). As new functionality gets added to [Plotly.js](https://plotly.com/javascript/) and to Plotly Express, certain Figure Factories become unecessary and are therefore deprecated as "legacy", but remain in the module for backwards-compatibility reasons. The following types of plots are still difficult to create with Graph Objects or Plotly Express and therefore the corresponding Figure Factories are *not* deprecated: * [Annotated Heatmaps](/python/annotated-heatmap/) * [Dendrograms](/python/dendrogram/) - * [Gantt Charts](/python/gantt/) * [Quiver Plots](/python/quiver-plots/) * [Streamline Plots](/python/streamline-plots/) * [Tables](/python/figure-factory-table/) @@ -52,7 +51,8 @@ Deprecated "legacy" Figure Factories include: * [County Choropleth Maps](/python/county-choropleth/), deprecated by regular [Choropleth maps with GeoJSON input](/python/choropleth-maps/) * [Distplots](/python/distplot/), mostly deprecated by [`px.histogram`](/python/histograms/) + * [Gantt Charts](/python/gantt/), deprecated by [`px.timeline`](/python/gantt/) #### Reference -For more information about the contents of `plotly.figure_factory`, including deprecated methods, please refer to our [API Reference documentation](https://plotly.com/python-api-reference/plotly.figure_factory.html). \ No newline at end of file +For more information about the contents of `plotly.figure_factory`, including deprecated methods, please refer to our [API Reference documentation](https://plotly.com/python-api-reference/plotly.figure_factory.html). From 19a0544be6d02668d369ccf854537c8b3a49b621 Mon Sep 17 00:00:00 2001 From: Nicolas Kruchten Date: Tue, 14 Jul 2020 09:57:12 -0400 Subject: [PATCH 3/3] clarify docstring --- packages/python/plotly/plotly/express/_doc.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/python/plotly/plotly/express/_doc.py b/packages/python/plotly/plotly/express/_doc.py index 6cb427fd4cc..3d4c5d21468 100644 --- a/packages/python/plotly/plotly/express/_doc.py +++ b/packages/python/plotly/plotly/express/_doc.py @@ -39,11 +39,13 @@ x_start=[ colref_type, colref_desc, + "(required)", "Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.", ], x_end=[ colref_type, colref_desc, + "(required)", "Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.", ], a=[