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 (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 x axis in cartesian coordinates. Eitherxorycan optionally be a list of column references or array_likes, inwhich case the data will be treated as if it were ‘wide’ rather than‘long’.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. Eitherxorycan optionally be a list of column references or array_likes, inwhich case the data will be treated as if it were ‘wide’ rather than‘long’.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.symbol (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 symbols to marks.size (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 mark sizes.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.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.07when facet_col_wrap is used.
facet_col_spacing (float between 0 and 1) – Spacing between facet columns, in paper units Default is 0.02.
error_x (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 tosize x-axis error bars. Iferror_x_minusisNone, error bars willbe symmetrical, otherwiseerror_xis used for the positive directiononly.error_x_minus (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 tosize x-axis error bars in the negative direction. Ignored iferror_xisNone.error_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 tosize y-axis error bars. Iferror_y_minusisNone, error bars willbe symmetrical, otherwiseerror_yis used for the positive directiononly.error_y_minus (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 tosize y-axis error bars in the negative direction. Ignored iferror_yisNone.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.orientation (str, one of
'h'for horizontal or'v'for vertical.) – (default'v'ifxandyare provided and both continous or bothcategorical, otherwise'v'`(‘h’) if `x`(`y) is categorical andy`(`x) is continuous, otherwise'v'`(‘h’) if only `x`(`y) isprovided)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.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.symbol_sequence (list of str) – Strings should define valid plotly.js symbols. When
symbolis set,values in that column are assigned symbols by cycling throughsymbol_sequencein the order described incategory_orders, unlessthe value ofsymbolis a key insymbol_map.symbol_map (dict with str keys and str values (default
{})) – String values should define plotly.js symbols Used to overridesymbol_sequenceto assign a specific symbols to marks correspondingwith specific values. Keys insymbol_mapshould be values in thecolumn denoted bysymbol. Alternatively, if the values ofsymbolare valid symbol names, the string'identity'may be passed to causethem to be used directly.opacity (float) – Value between 0 and 1. Sets the opacity for markers.
size_max (int (default
20)) – Set the maximum mark size when usingsize.marginal_x (str) – One of
'rug','box','violin', or'histogram'. If set, ahorizontal subplot is drawn above the main plot, visualizing thex-distribution.marginal_y (str) – One of
'rug','box','violin', or'histogram'. If set, avertical subplot is drawn to the right of the main plot, visualizingthe y-distribution.trendline (str) – One of
'ols','lowess','rolling','expanding'or'ewm'. If'ols', an Ordinary Least Squares regression line will be drawn foreach discrete-color/symbol group. If'lowess’, a Locally WeightedScatterplot Smoothing line will be drawn for each discrete-color/symbolgroup. If'rolling’, a Rolling (e.g. rolling average, rolling median)line will be drawn for each discrete-color/symbol group. If'expanding’, an Expanding (e.g. expanding average, expanding sum)line will be drawn for each discrete-color/symbol group. If'ewm’, anExponentially Weighted Moment (e.g. exponentially-weighted movingaverage) line will be drawn for each discrete-color/symbol group. Seethe docstrings for the functions inplotly.express.trendline_functionsfor more details on thesefunctions and how to configure them with thetrendline_optionsargument.trendline_options (dict) – Options passed as the first argument to the function from
plotly.express.trendline_functionsnamed in thetrendlineargument.trendline_color_override (str) – Valid CSS color. If provided, and if
trendlineis set, all trendlineswill be drawn in this color rather than in the same color as the tracesfrom which they draw their inputs.trendline_scope (str (one of
'trace'or'overall', default'trace')) – If'trace', then one trendline is drawn per trace (i.e. per color,symbol, facet, animation frame etc) and if'overall'then onetrendline is computed for the entire dataset, and replicated across allfacets.log_x (boolean (default
False)) – IfTrue, the x-axis is log-scaled in cartesian coordinates.log_y (boolean (default
False)) – IfTrue, the y-axis is log-scaled in cartesian coordinates.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.
render_mode (str) – One of
'auto','svg'or'webgl', default'auto'Controls thebrowser API used to draw marks.'svg'is appropriate for figures ofless than 1000 data points, and will allow for fully-vectorized output.'webgl'is likely necessary for acceptable performance above 1000points but rasterizes part of the output.'auto'uses heuristics tochoose the mode.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.
