data_frame (DataFrame or array-like or dict) – This argument needs to be passed for column names (and not keywordnames) to be used. Array-like and dict are transformed internally to apandas DataFrame. Optional: if missing, a DataFrame gets constructedunder the hood using the other arguments.
x_start (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. (required) Values from this column or array_like areused to position marks along the x axis in cartesian coordinates.x_end (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. (required) Values from this column or array_like areused to position marks along the x axis in cartesian coordinates.y (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toposition marks along the y axis in cartesian coordinates.color (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toassign color to marks.pattern_shape (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toassign pattern shapes to marks.facet_row (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toassign marks to facetted subplots in the vertical direction.facet_col (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toassign marks to facetted subplots in the horizontal direction.facet_col_wrap (int) – Maximum number of facet columns. Wraps the column variable at thiswidth, so that the column facets span multiple rows. Ignored if 0, andforced to 0 if
facet_rowor amarginalis set.facet_row_spacing (float between 0 and 1) – Spacing between facet rows, in paper units. Default is 0.03 or 0.0.7when facet_col_wrap is used.
facet_col_spacing (float between 0 and 1) – Spacing between facet columns, in paper units Default is 0.02.
hover_name (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like appear in boldin the hover tooltip.hover_data (str, or list of str or int, or Series or array-like, or dict) – Either a name or list of names of columns in
data_frame, or pandasSeries, or array_like objects or a dict with column names as keys, withvalues True (for default formatting) False (in order to remove thiscolumn from hover information), or a formatting string, for example‘:.3f’ or ‘|%a’ or list-like data to appear in the hover tooltip ortuples with a bool or formatting string as first element, and list-likedata to appear in hover as second element Values from these columnsappear as extra data in the hover tooltip.custom_data (str, or list of str or int, or Series or array-like) – Either name or list of names of columns in
data_frame, or pandasSeries, or array_like objects Values from these columns are extra data,to be used in widgets or Dash callbacks for example. This data is notuser-visible but is included in events emitted by the figure (lassoselection etc.)text (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like appear in thefigure as text labels.animation_frame (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toassign marks to animation frames.animation_group (str or int or Series or array-like) – Either a name of a column in
data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toprovide object-constancy across animation frames: rows with matching`animation_group`s will be treated as if they describe the same objectin each frame.category_orders (dict with str keys and list of str values (default
{})) – By default, in Python 3.6+, the order of categorical values in axes,legends and facets depends on the order in which these values are firstencountered indata_frame(and no order is guaranteed by default inPython below 3.6). This parameter is used to force a specific orderingof values per column. The keys of this dict should correspond to columnnames, and the values should be lists of strings corresponding to thespecific display order desired.labels (dict with str keys and str values (default
{})) – By default, column names are used in the figure for axis titles, legendentries and hovers. This parameter allows this to be overridden. Thekeys of this dict should correspond to column names, and the valuesshould correspond to the desired label to be displayed.color_discrete_sequence (list of str) – Strings should define valid CSS-colors. When
coloris set and thevalues in the corresponding column are not numeric, values in thatcolumn are assigned colors by cycling throughcolor_discrete_sequencein the order described incategory_orders, unless the value ofcoloris a key incolor_discrete_map. Various useful colorsequences are available in theplotly.express.colorssubmodules,specificallyplotly.express.colors.qualitative.color_discrete_map (dict with str keys and str values (default
{})) – String values should define valid CSS-colors Used to overridecolor_discrete_sequenceto assign a specific colors to markscorresponding with specific values. Keys incolor_discrete_mapshouldbe values in the column denoted bycolor. Alternatively, if thevalues ofcolorare valid colors, the string'identity'may bepassed to cause them to be used directly.pattern_shape_sequence (list of str) – Strings should define valid plotly.js patterns-shapes. When
pattern_shapeis set, values in that column are assigned patterns-shapes by cycling throughpattern_shape_sequencein the orderdescribed incategory_orders, unless the value ofpattern_shapeisa key inpattern_shape_map.pattern_shape_map (dict with str keys and str values (default
{})) – Strings values define plotly.js patterns-shapes. Used to overridepattern_shape_sequencesto assign a specific patterns-shapes to linescorresponding with specific values. Keys inpattern_shape_mapshouldbe values in the column denoted bypattern_shape. Alternatively, ifthe values ofpattern_shapeare valid patterns-shapes names, thestring'identity'may be passed to cause them to be used directly.color_continuous_scale (list of str) – Strings should define valid CSS-colors This list is used to build acontinuous color scale when the column denoted by
colorcontainsnumeric data. Various useful color scales are available in theplotly.express.colorssubmodules, specificallyplotly.express.colors.sequential,plotly.express.colors.divergingandplotly.express.colors.cyclical.range_color (list of two numbers) – If provided, overrides auto-scaling on the continuous color scale.
color_continuous_midpoint (number (default
None)) – If set, computes the bounds of the continuous color scale to have thedesired midpoint. Setting this value is recommended when usingplotly.express.colors.divergingcolor scales as the inputs tocolor_continuous_scale.opacity (float) – Value between 0 and 1. Sets the opacity for markers.
range_x (list of two numbers) – If provided, overrides auto-scaling on the x-axis in cartesiancoordinates.
range_y (list of two numbers) – If provided, overrides auto-scaling on the y-axis in cartesiancoordinates.
title (str) – The figure title.
template (str or dict or plotly.graph_objects.layout.Template instance) – The figure template name (must be a key in plotly.io.templates) ordefinition.
width (int (default
None)) – The figure width in pixels.height (int (default
None)) – The figure height in pixels.
