B
    eJd0w              {   @   s`  d dl Z d dlmZ y
e jZW n ek
r8   e jZY nX dZdZdZdZ	e
ddd	d
geedgeedgeedgeeddgeeddgeedgeedgeedgeedgeedgeedgeedgeedgee	ddgeedgeedgeedgeedgee	dgddd geed!d"geed#d$geed%d&geed'd(geed)d*geed+d,geed-gd.d/geed0geed1geed2geed3geed4gd5d6geed7gd8d9d:d;d<d=d>d?d@dAg
dBdCdDgeedEgeedFgdGdHdIgeedJgeedKgdLdMdNdOgdPdQgdPdRgeedSgeedTgdUdVdWgdXdYdZd[d\gdXd]d^d_d`gdUdadbgdXdcdddedfgdUdgdhgdUdidjdkgdXdldmdndogdUdpdqdrgdsdtdugdvdwgdxdygdzd{gdxd|gdxd}gdxd~gdxdgddgddgddgddgddgddgdGdgddgddgddgdXdddgddddgdGddgdGddgdGddgdGddddddddg	dddgdGddgddgdGdddddgdGddgddgddgdddddddgdddddgdddddgdddddgddddgddddgddddgdddgddddgdxdgddgddgddgddgddgdddgddddgdddddddgdxdgdxdgddgddgdxdgdLddgdLddgdLddgdGddgdLddgdddddgdddd dgdddgdwZdddZdS (	      N)TextWrapperz"str or int or Series or array-likezSEither a name of a column in `data_frame`, or a pandas Series or array_like object.z+list of str or int, or Series or array-likezPEither names of columns in `data_frame`, or pandas Series, or array_like objectszDataFrame or array-like or dictzUThis argument needs to be passed for column names (and not keyword names) to be used.zEArray-like and dict are transformed internally to a pandas DataFrame.z\Optional: if missing, a DataFrame gets constructed under the hood using the other arguments.zkValues from this column or array_like are used to position marks along the x axis in cartesian coordinates.zkValues from this column or array_like are used to position marks along the y axis in cartesian coordinates.zkValues from this column or array_like are used to position marks along the z axis in cartesian coordinates.z
(required)ziValues from this column or array_like are used to position marks along the a axis in ternary coordinates.ziValues from this column or array_like are used to position marks along the b axis in ternary coordinates.ziValues from this column or array_like are used to position marks along the c axis in ternary coordinates.zlValues from this column or array_like are used to position marks along the radial axis in polar coordinates.zmValues from this column or array_like are used to position marks along the angular axis in polar coordinates.zSValues from this column or array_like are used to set values associated to sectors.zYValues from this column or array_like are used as parents in sunburst and treemap charts.zDValues from this column or array_like are used to set ids of sectorszsList of columns names or columns of a rectangular dataframe defining the hierarchy of sectors, from root to leaves.z7An error is raised if path AND ids or parents is passedz`Values from this column or array_like are used to position marks according to latitude on a map.zaValues from this column or array_like are used to position marks according to longitude on a map.zyValues from this column or array_like are to be interpreted according to `locationmode` and mapped to longitude/latitude.zOValues from this column or array_like are used to position the base of the bar.zFValues from these columns are used for multidimensional visualization.zint (default 50)zWhen `dimensions` is `None` and `data_frame` is provided, columns with more than this number of unique values are excluded from the output.z%Not used when `dimensions` is passed.zIValues from this column or array_like are used to size x-axis error bars.zzIf `error_x_minus` is `None`, error bars will be symmetrical, otherwise `error_x` is used for the positive direction only.zcValues from this column or array_like are used to size x-axis error bars in the negative direction.zIgnored if `error_x` is `None`.zIValues from this column or array_like are used to size y-axis error bars.zzIf `error_y_minus` is `None`, error bars will be symmetrical, otherwise `error_y` is used for the positive direction only.zcValues from this column or array_like are used to size y-axis error bars in the negative direction.zIgnored if `error_y` is `None`.zIValues from this column or array_like are used to size z-axis error bars.zzIf `error_z_minus` is `None`, error bars will be symmetrical, otherwise `error_z` is used for the positive direction only.zcValues from this column or array_like are used to size z-axis error bars in the negative direction.zIgnored if `error_z` is `None`.zHValues from this column or array_like are used to assign color to marks.floatz4Value between 0 and 1. Sets the opacity for markers.zPValues from this column or array_like are used to assign dash-patterns to lines.zXValues from this column or array_like are used to group rows of `data_frame` into lines.zJValues from this column or array_like are used to assign symbols to marks.zQValues from this column or array_like are used to assign pattern shapes to marks.zDValues from this column or array_like are used to assign mark sizes.zint (default is 30)z+Sets the radius of influence of each point.zJValues from this column or array_like appear in bold in the hover tooltip.z<str, or list of str or int, or Series or array-like, or dictzLEither a name or list of names of columns in `data_frame`, or pandas Series,zor array_like objectszNor a dict with column names as keys, with values True (for default formatting)z>False (in order to remove this column from hover information),z3or a formatting string, for example ':.3f' or '|%a'z0or list-like data to appear in the hover tooltipz<or tuples with a bool or formatting string as first element,z7and list-like data to appear in hover as second elementzDValues from these columns appear as extra data in the hover tooltip.z3str, or list of str or int, or Series or array-likez`Either name or list of names of columns in `data_frame`, or pandas Series, or array_like objectszValues from these columns are extra data, to be used in widgets or Dash callbacks for example. This data is not user-visible but is included in events emitted by the figure (lasso selection etc.)zJValues from this column or array_like appear in the figure as text labels.zEValues from this column or array_like are used as labels for sectors.strz0One of 'ISO-3', 'USA-states', or 'country names'z[Determines the set of locations used to match entries in `locations` to regions on the map.znValues from this column or array_like are used to assign marks to facetted subplots in the vertical direction.zpValues from this column or array_like are used to assign marks to facetted subplots in the horizontal direction.intz Maximum number of facet columns.zVWraps the column variable at this width, so that the column facets span multiple rows.zDIgnored if 0, and forced to 0 if `facet_row` or a `marginal` is set.zfloat between 0 and 1zaSpacing between facet rows, in paper units. Default is 0.03 or 0.0.7 when facet_col_wrap is used.z>Spacing between facet columns, in paper units Default is 0.02.zSValues from this column or array_like are used to assign marks to animation frames.zValues from this column or array_like are used to provide object-constancy across animation frames: rows with matching `animation_group`s will be treated as if they describe the same object in each frame.zlist of strz.Strings should define valid plotly.js symbols.zWhen `symbol` is set, values in that column are assigned symbols by cycling through `symbol_sequence` in the order described in `category_orders`, unless the value of `symbol` is a key in `symbol_map`.z0dict with str keys and str values (default `{}`)z-String values should define plotly.js symbolszlUsed to override `symbol_sequence` to assign a specific symbols to marks corresponding with specific values.zHKeys in `symbol_map` should be values in the column denoted by `symbol`.zAlternatively, if the values of `symbol` are valid symbol names, the string `'identity'` may be passed to cause them to be used directly.z.Strings values define plotly.js dash-patterns.zvUsed to override `line_dash_sequences` to assign a specific dash-patterns to lines corresponding with specific values.zNKeys in `line_dash_map` should be values in the column denoted by `line_dash`.zAlternatively, if the values of `line_dash` are valid line-dash names, the string `'identity'` may be passed to cause them to be used directly.z4Strings should define valid plotly.js dash-patterns.zWhen `line_dash` is set, values in that column are assigned dash-patterns by cycling through `line_dash_sequence` in the order described in `category_orders`, unless the value of `line_dash` is a key in `line_dash_map`.z0Strings values define plotly.js patterns-shapes.z|Used to override `pattern_shape_sequences` to assign a specific patterns-shapes to lines corresponding with specific values.zVKeys in `pattern_shape_map` should be values in the column denoted by `pattern_shape`.zAlternatively, if the values of `pattern_shape` are valid patterns-shapes names, the string `'identity'` may be passed to cause them to be used directly.z6Strings should define valid plotly.js patterns-shapes.zWhen `pattern_shape` is set, values in that column are assigned patterns-shapes by cycling through `pattern_shape_sequence` in the order described in `category_orders`, unless the value of `pattern_shape` is a key in `pattern_shape_map`.z'Strings should define valid CSS-colors.a  When `color` is set and the values in the corresponding column are not numeric, values in that column are assigned colors by cycling through `color_discrete_sequence` in the order described in `category_orders`, unless the value of `color` is a key in `color_discrete_map`.zVarious useful color sequences are available in the `plotly.express.colors` submodules, specifically `plotly.express.colors.qualitative`.z,String values should define valid CSS-colorszsUsed to override `color_discrete_sequence` to assign a specific colors to marks corresponding with specific values.zOKeys in `color_discrete_map` should be values in the column denoted by `color`.zAlternatively, if the values of `color` are valid colors, the string `'identity'` may be passed to cause them to be used directly.z&Strings should define valid CSS-colorszmThis list is used to build a continuous color scale when the column denoted by `color` contains numeric data.zVarious useful color scales are available in the `plotly.express.colors` submodules, specifically `plotly.express.colors.sequential`, `plotly.express.colors.diverging` and `plotly.express.colors.cyclical`.znumber (default `None`)zWIf set, computes the bounds of the continuous color scale to have the desired midpoint.zSetting this value is recommended when using `plotly.express.colors.diverging` color scales as the inputs to `color_continuous_scale`.zint (default `20`)z,Set the maximum mark size when using `size`.zboolean (default `False`)z&If `True`, markers are shown on lines.zboolean (default `True`)zKIf `False`, lines are not drawn (forced to `True` if `markers` is `False`).z=If `True`, the x-axis is log-scaled in cartesian coordinates.z=If `True`, the y-axis is log-scaled in cartesian coordinates.z=If `True`, the z-axis is log-scaled in cartesian coordinates.z>If `True`, the radial axis is log-scaled in polar coordinates.zlist of two numberszKIf provided, overrides auto-scaling on the x-axis in cartesian coordinates.zKIf provided, overrides auto-scaling on the y-axis in cartesian coordinates.zKIf provided, overrides auto-scaling on the z-axis in cartesian coordinates.zBIf provided, overrides auto-scaling on the continuous color scale.zLIf provided, overrides auto-scaling on the radial axis in polar coordinates.zMIf provided, overrides auto-scaling on the angular axis in polar coordinates.zThe figure title.z<str or dict or plotly.graph_objects.layout.Template instancezNThe figure template name (must be a key in plotly.io.templates) or definition.zint (default `None`)zThe figure width in pixels.zThe figure height in pixels.z[By default, column names are used in the figure for axis titles, legend entries and hovers.z,This parameter allows this to be overridden.zThe keys of this dict should correspond to column names, and the values should correspond to the desired label to be displayed.z8dict with str keys and list of str values (default `{}`)zBy default, in Python 3.6+, the order of categorical values in axes, legends and facets depends on the order in which these values are first encountered in `data_frame` (and no order is guaranteed by default in Python below 3.6).zIThis parameter is used to force a specific ordering of values per column.zThe keys of this dict should correspond to column names, and the values should be lists of strings corresponding to the specific display order desired.z6One of `'rug'`, `'box'`, `'violin'`, or `'histogram'`.zQIf set, a subplot is drawn alongside the main plot, visualizing the distribution.zZIf set, a horizontal subplot is drawn above the main plot, visualizing the x-distribution.zbIf set, a vertical subplot is drawn to the right of the main plot, visualizing the y-distribution.zBOne of `'ols'`, `'lowess'`, `'rolling'`, `'expanding'` or `'ewm'`.ziIf `'ols'`, an Ordinary Least Squares regression line will be drawn for each discrete-color/symbol group.zpIf `'lowess`', a Locally Weighted Scatterplot Smoothing line will be drawn for each discrete-color/symbol group.zyIf `'rolling`', a Rolling (e.g. rolling average, rolling median) line will be drawn for each discrete-color/symbol group.zIf `'expanding`', an Expanding (e.g. expanding average, expanding sum) line will be drawn for each discrete-color/symbol group.zIf `'ewm`', an Exponentially Weighted Moment (e.g. exponentially-weighted moving average) line will be drawn for each discrete-color/symbol group.zxSee the docstrings for the functions in `plotly.express.trendline_functions` for more details on these functions and howz8to configure them with the `trendline_options` argument.dictz_Options passed as the first argument to the function from `plotly.express.trendline_functions` z"named in the `trendline` argument.zValid CSS color.zIf provided, and if `trendline` is set, all trendlines will be drawn in this color rather than in the same color as the traces from which they draw their inputs.z8str (one of `'trace'` or `'overall'`, default `'trace'`)zIf `'trace'`, then one trendline is drawn per trace (i.e. per color, symbol, facet, animation frame etc) and if `'overall'` then one trendline is computed for the entire dataset, and replicated across all facets.z7One of `'auto'`, `'svg'` or `'webgl'`, default `'auto'`z,Controls the browser API used to draw marks.zm`'svg`' is appropriate for figures of less than 1000 data points, and will allow for fully-vectorized output.zn`'webgl'` is likely necessary for acceptable performance above 1000 points but rasterizes part of the output. z,`'auto'` uses heuristics to choose the mode.zFOne of '`counterclockwise'` or `'clockwise'`. Default is `'clockwise'`zLSets the direction in which increasing values of the angular axis are drawn.zint (default `90`)zTSets start angle for the angular axis, with 0 being due east and 90 being due north.zBstr (default `'count'` if no arguments are provided, else `'sum'`)zOne of `'count'`, `'sum'`, `'avg'`, `'min'`, or `'max'`.Function used to aggregate values for summarization (note: can be normalized with `histnorm`).zstr (default `None`)zLOne of `'percent'`, `'probability'`, `'density'`, or `'probability density'`z2If `None`, the output of `histfunc` is used as is.z|If `'probability'`, the output of `histfunc` for a given bin is divided by the sum of the output of `histfunc` for all bins.zIf `'percent'`, the output of `histfunc` for a given bin is divided by the sum of the output of `histfunc` for all bins and multiplied by 100.z[If `'density'`, the output of `histfunc` for a given bin is divided by the size of the bin.zIf `'probability density'`, the output of `histfunc` for a given bin is normalized such that it corresponds to the probability that a random event whose distribution is described by the output of `histfunc` will fall into that bin.z#One of `'fraction'` or `'percent'`.zgIf `'fraction'`, the value of each bar is divided by the sum of all values at that location coordinate.zB`'percent'` is the same but multiplied by 100 to show percentages.z<`None` will stack up all values at each location coordinate.ziIf `'fraction'`, the value of each point is divided by the sum of all values at that location coordinate.zstr (default `'relative'`)z-One of `'group'`, `'overlay'` or `'relative'`ziIn `'relative'` mode, bars are stacked above zero for positive values and below zero for negative values.z:In `'overlay'` mode, bars are drawn on top of one another.z5In `'group'` mode, bars are placed beside each other.zstr (default `'group'`)zOne of `'group'` or `'overlay'`z;In `'overlay'` mode, boxes are on drawn top of one another.z6In `'group'` mode, boxes are placed beside each other.z=In `'overlay'` mode, violins are on drawn top of one another.z8In `'group'` mode, violins are placed beside each other.z<In `'overlay'` mode, strips are on drawn top of one another.z7In `'group'` mode, strips are placed beside each other.zint (default `8`)zBetween 0 and 20.zSets map zoom level.z8str, one of `'h'` for horizontal or `'v'` for vertical. zS(default `'v'` if `x` and `y` are provided and both continous or both categorical, zNotherwise `'v'`(`'h'`) if `x`(`y`) is categorical and `y`(`x`) is continuous, z5otherwise `'v'`(`'h'`) if only `x`(`y`) is provided) zKIf `True`, an extra line segment is drawn between the first and last point.zstr (default `'linear'`)z One of `'linear'` or `'spline'`.zstr (default `False`).z)One of `False`, `locations` or `geojson`.boolzForce the basemap visibility.zstr (default `'world'`).zOne of `'world'`, `'usa'`, `'europe'`, `'asia'`, `'africa'`, `'north america'`, or `'south america'`Default is `'world'` unless `projection` is set to `'albers usa'`, which forces `'usa'`.zstr a  One of `'equirectangular'`, `'mercator'`, `'orthographic'`, `'natural earth'`, `'kavrayskiy7'`, `'miller'`, `'robinson'`, `'eckert4'`, `'azimuthal equal area'`, `'azimuthal equidistant'`, `'conic equal area'`, `'conic conformal'`, `'conic equidistant'`, `'gnomonic'`, `'stereographic'`, `'mollweide'`, `'hammer'`, `'transverse mercator'`, `'albers usa'`, `'winkel tripel'`, `'aitoff'`, or `'sinusoidal'`Default depends on `scope`.z!Dict keys are `'lat'` and `'lon'`z!Sets the center point of the map.z/str (default `'basic'`, needs Mapbox API token)zIdentifier of base map style, some of which require a Mapbox API token to be set using `plotly.express.set_mapbox_access_token()`.zAllowed values which do not require a Mapbox API token are `'open-street-map'`, `'white-bg'`, `'carto-positron'`, `'carto-darkmatter'`, `'stamen-terrain'`, `'stamen-toner'`, `'stamen-watercolor'`.zAllowed values which do require a Mapbox API token are `'basic'`, `'streets'`, `'outdoors'`, `'light'`, `'dark'`, `'satellite'`, `'satellite-streets'`.z%str or boolean (default `'outliers'`)z@One of `'outliers'`, `'suspectedoutliers'`, `'all'`, or `False`.zMIf `'outliers'`, only the sample points lying outside the whiskers are shown.zIf `'suspectedoutliers'`, all outlier points are shown and those less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted with the marker's `'outliercolor'`.z(If `'all'`, all sample points are shown.z_If `False`, no sample points are shown and the whiskers extend to the full range of the sample.z.If `True`, boxes are drawn inside the violins.z(If `True`, boxes are drawn with notches.zGeoJSON-formatted dictz[Must contain a Polygon feature collection, with IDs, which are references from `locations`.zstr (default: `'id'`)zPath to field in GeoJSON feature object with which to match the values passed in to `locations`.The most common alternative to the default is of the form `'properties.<key>`.z+If `True`, histogram values are cumulative.zPositive integer.zSets the number of bins.z)Sets the number of bins along the x axis.z)Sets the number of bins along the y axis.z'total' or 'remainder'a1  Determines how the items in `values` are summed. Whenset to 'total', items in `values` are taken to be valueof all its descendants. When set to 'remainder', itemsin `values` corresponding to the root and the branches:sectors are taken to be the extra part not part of thesum of the values at their leaves.zPositive integerzzSets the number of rendered sectors from any given `level`. Set `maxdepth` to -1 to render all thelevels in the hierarchy.z*string or `None` (default `'probability'`)z%One of `'probability'` or `'percent'`z-If `None`, values will be raw counts or sums.zGIf `'probability', values will be probabilities normalized from 0 to 1.zCIf `'percent', values will be percentages normalized from 0 to 100.zstring (default `'standard'`)z6One of `'standard'`, `'complementary'` or `'reversed'`z[If `'standard'`, the ECDF is plotted such that values represent data at or below the point.zZIf `'complementary'`, the CCDF is plotted such that values represent data above the point.zhIf `'reversed'`, a variant of the CCDF is plotted such that values represent data at or above the point.z bool or string (default `False`)zeIf `True` or a string, the x or y or z values will be displayed as text, depending on the orientationz[A string like `'.2f'` will be interpreted as a `texttemplate` numeric formatting directive.)wZ
data_framexyzZx_startZx_endabcrthetavaluesparentsZidspathZlatZlon	locationsbase
dimensionsZdimensions_max_cardinalityZerror_xZerror_x_minusZerror_yZerror_y_minusZerror_zZerror_z_minuscolorZopacityZ	line_dashZ
line_groupsymbolZpattern_shapesizeZradiusZ
hover_nameZ
hover_dataZcustom_datatextnamesZlocationmodeZ	facet_rowZ	facet_colZfacet_col_wrapZfacet_row_spacingZfacet_col_spacingZanimation_frameZanimation_groupZsymbol_sequence
symbol_mapZline_dash_mapZline_dash_sequenceZpattern_shape_mapZpattern_shape_sequenceZcolor_discrete_sequenceZcolor_discrete_mapZcolor_continuous_scaleZcolor_continuous_midpointZsize_maxmarkerslinesZlog_xZlog_yZlog_zZlog_rZrange_xZrange_yZrange_zZrange_colorZrange_rZrange_thetatitletemplatewidthheightlabelsZcategory_ordersZmarginalZ
marginal_xZ
marginal_yZ	trendlineZtrendline_optionsZtrendline_color_overrideZtrendline_scopeZrender_mode	directionZstart_angleZhistfuncZhistnormZbarnormZ	groupnormZbarmodeZboxmodeZ
violinmodeZ	stripmodeZzoomZorientationZ
line_closeZ
line_shapeZ	fitboundsZbasemap_visiblescopeZ
projectioncenterZmapbox_styleZpointsboxZnotchedZgeojsonZfeatureidkeyZ
cumulativeZnbinsZnbinsxZnbinsyZbranchvaluesZmaxdepthZecdfnormZecdfmodeZ	text_autoc       
      C   s   |d kri n|}|d kri n|}t dddd}| jp6dd }xt| d D ]}||rft|| }n"tt| }||r||| 7 }|dd  }|tks||kr|d|pdnd	}|d }	|d
||	|f 7 }qJW |d7 }|d7 }|S )NK   z    )r    initial_indentsubsequent_indent z
Parameters
----------
r       z (documentation missing from map)z
%s: %s
%s
z
Returns
-------
z    plotly.graph_objects.Figure)r   __doc__getfullargspecgetlistdocsfilljoin)
fnZoverride_dictZappend_dictZtwresultparamZ	param_docZparam_desc_listZ
param_descZ
param_type r7   E/var/www/html/venv/lib/python3.7/site-packages/plotly/express/_doc.pymake_docstringZ  s$    

$r9   )NN)inspecttextwrapr   r.   AttributeError
getargspecZcolref_typeZcolref_descZcolref_list_typeZcolref_list_descr   r1   r9   r7   r7   r7   r8   <module>   s  
