B =cq8{@s ddlmZddlZGdddeZddlmZddlZGdddeZddlmZddlZGdddeZddlmZddlZGd d d eZddlmZddlZGd d d eZ ddlmZddlZGd ddeZ ddlmZddlZGdddeZ ddlmZddlZGdddeZ ddlmZddlZGdddeZ ddlmZddlZGdddeZddlmZddlZGdddeZddlmZddlZGdddeZddlmZddlZGdddeZddlmZddlZGdddeZddlmZddlZGdd d eZddlmZddlZGd!d"d"eZddlmZddlZGd#d$d$eZddlmZddlZGd%d&d&eZddlmZddlZGd'd(d(eZddlmZddlZGd)d*d*eZddlmZddlZGd+d,d,eZddlmZddlZGd-d.d.eZddlmZddlZGd/d0d0eZddlmZddlZGd1d2d2eZddlmZddlZGd3d4d4eZddlmZddlZGd5d6d6eZddlmZddlZGd7d8d8eZddlmZddlZGd9d:d:eZ ddlmZddlZGd;d<dd>eZ"ddlmZddlZGd?d@d@eZ#ddlmZddlZGdAdBdBeZ$ddlmZddlZGdCdDdDeZ%ddlmZddlZGdEdFdFeZ&ddlmZddlZGdGdHdHeZ'ddlmZddlZGdIdJdJeZ(ddlmZddlZGdKdLdLeZ)ddlmZddlZGdMdNdNeZ*ddlmZddlZGdOdPdPeZ+ddlmZddlZGdQdRdReZ,ddlmZddlZGdSdTdTeZ-ddlmZddlZGdUdVdVeZ.ddlmZddlZGdWdXdXeZ/ddlmZddlZGdYdZdZeZ0ddlmZddlZGd[d\d\eZ1ddlmZddlZGd]d^d^eZ2ddlmZddlZGd_d`d`eZ3ddalm4Z5ddlZGdbdcdce5Z6dddlm7Z8ddlZGdedfdfe8Z9ddgl:m;Z;ddhl:mZ>ddkl:m?Z?ddll:m@Z@ddml:mAZAddnl:mBZBddol:mCZCddpl:mDZDddql:mEZEddrl:mFZFddsl:mGZGddtl:mHZHddul:mIZIddvl:mJZJddwl:mKZKddxl:mLZLddyl:mMZMddzl:mNZNdd{l:mOZOdd|l:mPZPdd}l:mQZQdd~l:mRZRddl:mSZSddl:mTZTddl:mUZUddl:mVZVddl:mWZWddl:mXZXddl:mYZYddl:mZZZddl:m[Z[ddl:m\Z\ddl:m]Z]ddl:m^Z^ddl:m_Z_ddl:m`Z`ddl:maZaddl:mbZbddl:mcZcddl:mdZdddl:meZeddl:mfZfddl:mgZgddl:mhZhddl:miZiddl:mjZjddlkmlZlddlmmnZnmoZompZpmqZqmrZrmsZsmtZtmuZumvZvmwZwmxZxmyZymzZzm{Z{m|Z|m}Z}m~Z~mZmZmZmZmZmZmZmZdddd`d^d\dZdXdVdTdRddPdNdLdddJddddddfddHdFdDdBd@d>dZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZe>jddZ>eddZ?e?jddZ?eddZ@e@jddZ@eddZAeddZBeddZCdfdd ZDZES) WaterfallcCs|dS)a Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. The 'alignmentgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str alignmentgroup)selfrrK/var/www/cleansys/lib/python3.7/site-packages/plotly/graph_objs/__init__.pyr szWaterfall.alignmentgroupcCs ||d<dS)Nrr)rvalrrrrscCs|dS)z Sets where the bar base is drawn (in position axis units). The 'base' property is a number and may be specified as: - An int or float Returns ------- int|float baser)rrrrr s zWaterfall.basecCs ||d<dS)Nr r)rrrrrr .scCs|dS)a} Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. The 'cliponaxis' property must be specified as a bool (either True, or False) Returns ------- bool cliponaxisr)rrrrr 4szWaterfall.cliponaxiscCs ||d<dS)Nr r)rrrrrr EscCs|dS)a The 'connector' property is an instance of Connector that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Connector` - A dict of string/value properties that will be passed to the Connector constructor Supported dict properties: line :class:`plotly.graph_objects.waterfall.connecto r.Line` instance or dict with compatible properties mode Sets the shape of connector lines. visible Determines if connector lines are drawn. Returns ------- plotly.graph_objs.waterfall.Connector connectorr)rrrrr KszWaterfall.connectorcCs ||d<dS)Nr r)rrrrrr escCs|dS)a_ Constrain the size of text inside or outside a bar to be no larger than the bar itself. The 'constraintext' property is an enumeration that may be specified as: - One of the following enumeration values: ['inside', 'outside', 'both', 'none'] Returns ------- Any constraintextr)rrrrr kszWaterfall.constraintextcCs ||d<dS)Nr r)rrrrrr {scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray customdatar)rrrrr szWaterfall.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str customdatasrcr)rrrrrs zWaterfall.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ah The 'decreasing' property is an instance of Decreasing that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Decreasing` - A dict of string/value properties that will be passed to the Decreasing constructor Supported dict properties: marker :class:`plotly.graph_objects.waterfall.decreasi ng.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.waterfall.Decreasing decreasingr)rrrrrszWaterfall.decreasingcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float dxr)rrrrrs z Waterfall.dxcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float dyr)rrrrrs z Waterfall.dycCs ||d<dS)Nrr)rrrrrrscCs|dS)a{ Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['name', 'x', 'y', 'text', 'initial', 'delta', 'final'] joined with '+' characters (e.g. 'name+x') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray hoverinfor)rrrrrszWaterfall.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str hoverinfosrcr)rrrrr s zWaterfall.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.waterfall.Hoverlabel hoverlabelr)rrrrrs3zWaterfall.hoverlabelcCs ||d<dS)Nrr)rrrrrrSscCs|dS)aG Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta` and `final`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray hovertemplater)rrrrrYs!zWaterfall.hovertemplatecCs ||d<dS)Nrr)rrrrrr|scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str hovertemplatesrcr)rrrrrs zWaterfall.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ab Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray hovertextr)rrrrrszWaterfall.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str hovertextsrcr)rrrrrs zWaterfall.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray idsr)rrrrrsz Waterfall.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str idssrcr)rrrrrs zWaterfall.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ah The 'increasing' property is an instance of Increasing that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Increasing` - A dict of string/value properties that will be passed to the Increasing constructor Supported dict properties: marker :class:`plotly.graph_objects.waterfall.increasi ng.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.waterfall.Increasing increasingr)rrrrrszWaterfall.increasingcCs ||d<dS)Nrr)rrrrrrscCs|dS)a[ Determines if texts are kept at center or start/end points in `textposition` "inside" mode. The 'insidetextanchor' property is an enumeration that may be specified as: - One of the following enumeration values: ['end', 'middle', 'start'] Returns ------- Any insidetextanchorr)rrrrr szWaterfall.insidetextanchorcCs ||d<dS)Nrr)rrrrrrscCs|dS)as Sets the font used for `text` lying inside the bar. The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.waterfall.Insidetextfont insidetextfontr)rrrrr s/zWaterfall.insidetextfontcCs ||d<dS)Nrr)rrrrrrQscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str legendgroupr)rrrrrWszWaterfall.legendgroupcCs ||d<dS)Nrr)rrrrrrhscCs|dS)a An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed. The 'measure' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray measurer)rrrrrnszWaterfall.measurecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for measure . The 'measuresrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str measuresrcr)rrrrr s zWaterfall.measuresrccCs ||d<dS)Nr r)rrrrrr scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray metar)rrrrr!szWaterfall.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str metasrcr)rrrrr"s zWaterfall.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str namer)rrrrr#szWaterfall.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)a Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. The 'offset' property is a number and may be specified as: - An int or float - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray offsetr)rrrrr$szWaterfall.offsetcCs ||d<dS)Nr$r)rrrrrr$scCs|dS)a Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. The 'offsetgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str offsetgroupr)rrrrr%szWaterfall.offsetgroupcCs ||d<dS)Nr%r)rrrrrr%scCs|dS)z Sets the source reference on plot.ly for offset . The 'offsetsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str offsetsrcr)rrrrr&s zWaterfall.offsetsrccCs ||d<dS)Nr&r)rrrrrr&scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float opacityr)rrrrr'"s zWaterfall.opacitycCs ||d<dS)Nr'r)rrrrrr'0scCs|dS)a] Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). The 'orientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['v', 'h'] Returns ------- Any orientationr)rrrrr(6szWaterfall.orientationcCs ||d<dS)Nr(r)rrrrrr(FscCs|dS)ay Sets the font used for `text` lying outside the bar. The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.waterfall.Outsidetextfont outsidetextfontr)rrrrr)Ls/zWaterfall.outsidetextfontcCs ||d<dS)Nr)r)rrrrrr)}scCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any selectedpointsr)rrrrr*szWaterfall.selectedpointscCs ||d<dS)Nr*r)rrrrrr*scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool showlegendr)rrrrr+s zWaterfall.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)al The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.waterfall.Stream streamr)rrrrr,szWaterfall.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray textr)rrrrr-szWaterfall.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)a* Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. The 'textangle' property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90). Returns ------- int|float textangler)rrrrr.szWaterfall.textanglecCs ||d<dS)Nr.r)rrrrrr.scCs|dS)a@ Sets the font used for `text`. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.waterfall.Textfont textfontr)rrrrr/s/zWaterfall.textfontcCs ||d<dS)Nr/r)rrrrrr/6scCs|dS)a Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace). The 'textinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'initial', 'delta', 'final'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any textinfor)rrrrr0<szWaterfall.textinfocCs ||d<dS)Nr0r)rrrrrr0OscCs|dS)a' Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['inside', 'outside', 'auto', 'none'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray textpositionr)rrrrr1UszWaterfall.textpositioncCs ||d<dS)Nr1r)rrrrrr1kscCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str textpositionsrcr)rrrrr2qs zWaterfall.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str textsrcr)rrrrr3s zWaterfall.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta`, `final` and `label`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray texttemplater)rrrrr4szWaterfall.texttemplatecCs ||d<dS)Nr4r)rrrrrr4scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str texttemplatesrcr)rrrrr5s zWaterfall.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5scCs|dS)aP The 'totals' property is an instance of Totals that may be specified as: - An instance of :class:`plotly.graph_objs.waterfall.Totals` - A dict of string/value properties that will be passed to the Totals constructor Supported dict properties: marker :class:`plotly.graph_objects.waterfall.totals.M arker` instance or dict with compatible properties Returns ------- plotly.graph_objs.waterfall.Totals totalsr)rrrrr6szWaterfall.totalscCs ||d<dS)Nr6r)rrrrrr6scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str uidr)rrrrr7sz Waterfall.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any uirevisionr)rrrrr8szWaterfall.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any visibler)rrrrr9#szWaterfall.visiblecCs ||d<dS)Nr9r)rrrrrr94scCs|dS)aB Sets the bar width (in position axis units). The 'width' property is a number and may be specified as: - An int or float in the interval [0, inf] - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray widthr)rrrrr::s zWaterfall.widthcCs ||d<dS)Nr:r)rrrrrr:IscCs|dS)z Sets the source reference on plot.ly for width . The 'widthsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str widthsrcr)rrrrr;Os zWaterfall.widthsrccCs ||d<dS)Nr;r)rrrrrr;]scCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray xr)rrrrr<cs z Waterfall.xcCs ||d<dS)Nr<r)rrrrrr<qscCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'x0' property accepts values of any type Returns ------- Any x0r)rrrrr=ws z Waterfall.x0cCs ||d<dS)Nr=r)rrrrrr=scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str xaxisr)rrrrr>szWaterfall.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str xsrcr)rrrrr?s zWaterfall.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray yr)rrrrr@s z Waterfall.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any y0r)rrrrrAs z Waterfall.y0cCs ||d<dS)NrAr)rrrrrrAscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str yaxisr)rrrrrBszWaterfall.yaxiscCs ||d<dS)NrBr)rrrrrrBscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str ysrcr)rrrrrCs zWaterfall.ysrccCs ||d<dS)NrCr)rrrrrrC scCs |jdS)Ntype)_props)rrrrrDszWaterfall.typecCsdS)Nr)rrrr_parent_path_strszWaterfall._parent_path_strcCsdS)Nah4 alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. base Sets where the bar base is drawn (in position axis units). cliponaxis Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector :class:`plotly.graph_objects.waterfall.Connector` instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . decreasing :class:`plotly.graph_objects.waterfall.Decreasing` instance or dict with compatible properties dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.waterfall.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta` and `final`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . increasing :class:`plotly.graph_objects.waterfall.Increasing` instance or dict with compatible properties insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. insidetextfont Sets the font used for `text` lying inside the bar. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. measure An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed. measuresrc Sets the source reference on plot.ly for measure . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. offsetsrc Sets the source reference on plot.ly for offset . opacity Sets the opacity of the trace. orientation Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). outsidetextfont Sets the font used for `text` lying outside the bar. selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.waterfall.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textangle Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. textfont Sets the font used for `text`. textinfo Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace). textposition Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta`, `final` and `label`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . totals :class:`plotly.graph_objects.waterfall.Totals` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar width (in position axis units). widthsrc Sets the source reference on plot.ly for width . x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . r)rrrr_prop_descriptionsszWaterfall._prop_descriptionsNc>B s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|> dd|_ ddl m }?|?|jd<|?|jd <|?|jd <|?|jd <|?|jd <|?|jd <|?|jd<|?|jd<|?|jd<|?|jd<|?|jd<|?|jd<|?|jd<|?|jd<|?|jd<|?|jd<|?|jd<|? |jd<|?!|jd<|?"|jd<|?#|jd<|?$|jd<|?%|jd<|?&|jd<|?'|jd <|?(|jd!<|?)|jd"<|?*|jd#<|?+|jd$<|?,|jd%<|?-|jd&<|?.|jd'<|?/|jd(<|?0|jd)<|?1|jd*<|?2|jd+<|?3|jd,<|?4|jd-<|?5|jd.<|?6|jd/<|?7|jd0<|?8|jd1<|?9|jd2<|?:|jd3<|?;|jd4<|?<|jd5<|?=|jd6<|?>|jd7<|??|jd8<|?@|jd9<|?A|jd:<|?B|jd;<|?C|jd<<|?D|jd=<|?E|jd><|?F|jd?<|?G|jd@<|?H|jdA<|?I|jdB<|?J|jdC<| dd}@|dk r|n|@|d<| d d}@|dk r|n|@|d <| d d}@|dk r|n|@|d <| d d}@|dk r4|n|@|d <| d d}@|dk rV|n|@|d <| d d}@|dk rx|n|@|d <| dd}@|dk r|n|@|d<| dd}@| dk r| n|@|d<| dd}@| dk r| n|@|d<| dd}@| dk r| n|@|d<| dd}@| dk r"| n|@|d<| dd}@| dk rD| n|@|d<| dd}@|dk rf|n|@|d<| dd}@|dk r|n|@|d<| dd}@|dk r|n|@|d<| dd}@|dk r|n|@|d<| dd}@|dk r|n|@|d<| dd}@|dk r|n|@|d<| dd}@|dk r2|n|@|d<| dd}@|dk rT|n|@|d<| dd}@|dk rv|n|@|d<| dd}@|dk r|n|@|d<| dd}@|dk r|n|@|d<| dd}@|dk r|n|@|d<| d d}@|dk r|n|@|d <| d!d}@|dk r |n|@|d!<| d"d}@|dk rB|n|@|d"<| d#d}@|dk rd|n|@|d#<| d$d}@|dk r|n|@|d$<| d%d}@|dk r|n|@|d%<| d&d}@| dk r| n|@|d&<| d'd}@|!dk r|!n|@|d'<| d(d}@|"dk r|"n|@|d(<| d)d}@|#dk r0|#n|@|d)<| d*d}@|$dk rR|$n|@|d*<| d+d}@|%dk rt|%n|@|d+<| d,d}@|&dk r|&n|@|d,<| d-d}@|'dk r|'n|@|d-<| d.d}@|(dk r|(n|@|d.<| d/d}@|)dk r|)n|@|d/<| d0d}@|*dk r|*n|@|d0<| d1d}@|+dk r@|+n|@|d1<| d2d}@|,dk rb|,n|@|d2<| d3d}@|-dk r|-n|@|d3<| d4d}@|.dk r|.n|@|d4<| d5d}@|/dk r|/n|@|d5<| d6d}@|0dk r|0n|@|d6<| d7d}@|1dk r |1n|@|d7<| d8d}@|2dk r.|2n|@|d8<| d9d}@|3dk rP|3n|@|d9<| d:d}@|4dk rr|4n|@|d:<| d;d}@|5dk r|5n|@|d;<| dd}@|8dk r|8n|@|d><| d?d}@|9dk r|9n|@|d?<| d@d}@|:dk r>|:n|@|d@<| dAd}@|;dk r`|;n|@|dA<| dBd}@|d|_ dS)Ga7 Construct a new Waterfall object Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in `y` if `orientation` is set th "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Waterfall` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. base Sets where the bar base is drawn (in position axis units). cliponaxis Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector :class:`plotly.graph_objects.waterfall.Connector` instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . decreasing :class:`plotly.graph_objects.waterfall.Decreasing` instance or dict with compatible properties dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.waterfall.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta` and `final`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . increasing :class:`plotly.graph_objects.waterfall.Increasing` instance or dict with compatible properties insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. insidetextfont Sets the font used for `text` lying inside the bar. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. measure An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed. measuresrc Sets the source reference on plot.ly for measure . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. offsetsrc Sets the source reference on plot.ly for offset . opacity Sets the opacity of the trace. orientation Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). outsidetextfont Sets the font used for `text` lying outside the bar. selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.waterfall.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textangle Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. textfont Sets the font used for `text`. textinfo Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace). textposition Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta`, `final` and `label`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . totals :class:`plotly.graph_objects.waterfall.Totals` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar width (in position axis units). widthsrc Sets the source reference on plot.ly for width . x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . Returns ------- Waterfall waterfallNzThe first argument to the plotly.graph_objs.Waterfall constructor must be a dict or an instance of :class:`plotly.graph_objs.Waterfall` skip_invalidFr)rIrr r r r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrC)LiteralValidatorrD) plotly_name parent_namer)Osuperr__init__ isinstance __class__to_plotly_jsondict_copycopy ValueErrorpop _skip_invalidplotly.validatorsrIAlignmentgroupValidator _validators BaseValidatorCliponaxisValidatorConnectorValidatorConstraintextValidatorCustomdataValidatorCustomdatasrcValidatorDecreasingValidator DxValidator DyValidatorHoverinfoValidatorHoverinfosrcValidatorHoverlabelValidatorHovertemplateValidatorHovertemplatesrcValidatorHovertextValidatorHovertextsrcValidator IdsValidatorIdssrcValidatorIncreasingValidatorInsidetextanchorValidatorInsidetextfontValidatorLegendgroupValidatorZMeasureValidatorZMeasuresrcValidator MetaValidatorMetasrcValidator NameValidatorOffsetValidatorOffsetgroupValidatorOffsetsrcValidatorOpacityValidatorOrientationValidatorOutsidetextfontValidatorSelectedpointsValidatorShowlegendValidatorStreamValidator TextValidatorTextangleValidatorTextfontValidatorTextinfoValidatorTextpositionValidatorTextpositionsrcValidatorTextsrcValidatorTexttemplateValidatorTexttemplatesrcValidatorZTotalsValidator UidValidatorUirevisionValidatorVisibleValidatorWidthValidatorWidthsrcValidator XValidator X0ValidatorXAxisValidator XsrcValidator YValidator Y0ValidatorYAxisValidator YsrcValidator_plotly_utils.basevalidatorsrKrE_process_kwargs)Brargrr r r r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrCkwargsZ v_waterfall_vrK)rQrrrO-sd                                                                    zWaterfall.__init__)=NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)F__name__ __module__ __qualname__propertyrsetterr r r r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrCrDrGrHrO __classcell__rr)rQrrst             5 #        1            1      1                       rc6seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:eddZ;eddZS)VolumecCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool autocolorscaler)rrrrr szVolume.autocolorscalecCs ||d<dS)Nrr)rrrrrr scCs|dS)a@ The 'caps' property is an instance of Caps that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Caps` - A dict of string/value properties that will be passed to the Caps constructor Supported dict properties: x :class:`plotly.graph_objects.volume.caps.X` instance or dict with compatible properties y :class:`plotly.graph_objects.volume.caps.Y` instance or dict with compatible properties z :class:`plotly.graph_objects.volume.caps.Z` instance or dict with compatible properties Returns ------- plotly.graph_objs.volume.Caps capsr)rrrrr sz Volume.capscCs ||d<dS)Nrr)rrrrrr scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. The 'cauto' property must be specified as a bool (either True, or False) Returns ------- bool cautor)rrrrr sz Volume.cautocCs ||d<dS)Nrr)rrrrrr scCs|dS)a, Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well. The 'cmax' property is a number and may be specified as: - An int or float Returns ------- int|float cmaxr)rrrrr s z Volume.cmaxcCs ||d<dS)Nrr)rrrrrr scCs|dS)ar Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`. The 'cmid' property is a number and may be specified as: - An int or float Returns ------- int|float cmidr)rrrrr sz Volume.cmidcCs ||d<dS)Nrr)rrrrrr scCs|dS)a, Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well. The 'cmin' property is a number and may be specified as: - An int or float Returns ------- int|float cminr)rrrrr s z Volume.cmincCs ||d<dS)Nrr)rrrrrr scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str coloraxisr)rrrrr szVolume.coloraxiscCs ||d<dS)Nrr)rrrrrr( scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.volume.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.volume. colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.volume.colorbar.tickformatstopdefaults), sets the default property values to use for elements of volume.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.volume.colorbar.Ti tle` instance or dict with compatible properties titlefont Deprecated: Please use volume.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use volume.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.volume.ColorBar colorbarr)rrrrr. sdzVolume.colorbarcCs ||d<dS)Nrr)rrrrrr scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str colorscaler)rrrrr s,zVolume.colorscalecCs ||d<dS)Nrr)rrrrrrG scCs|dS)a The 'contour' property is an instance of Contour that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Contour` - A dict of string/value properties that will be passed to the Contour constructor Supported dict properties: color Sets the color of the contour lines. show Sets whether or not dynamic contours are shown on hover width Sets the width of the contour lines. Returns ------- plotly.graph_objs.volume.Contour contourr)rrrrrM szVolume.contourcCs ||d<dS)Nrr)rrrrrrf scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr l szVolume.customdatacCs ||d<dS)Nr r)rrrrrr } scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr s zVolume.customdatasrccCs ||d<dS)Nrr)rrrrrr scCs|dS)a= Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections. The 'flatshading' property must be specified as a bool (either True, or False) Returns ------- bool flatshadingr)rrrrr szVolume.flatshadingcCs ||d<dS)Nrr)rrrrrr scCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr szVolume.hoverinfocCs ||d<dS)Nrr)rrrrrr scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr s zVolume.hoverinfosrccCs ||d<dS)Nrr)rrrrrr scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.volume.Hoverlabel rr)rrrrr s3zVolume.hoverlabelcCs ||d<dS)Nrr)rrrrrr scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr s!zVolume.hovertemplatecCs ||d<dS)Nrr)rrrrrr9 scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr? s zVolume.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrM scCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrS szVolume.hovertextcCs ||d<dS)Nrr)rrrrrrc scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrri s zVolume.hovertextsrccCs ||d<dS)Nrr)rrrrrrw scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr} sz Volume.idscCs ||d<dS)Nrr)rrrrrr scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr s z Volume.idssrccCs ||d<dS)Nrr)rrrrrr scCs|dS)z Sets the maximum boundary for iso-surface plot. The 'isomax' property is a number and may be specified as: - An int or float Returns ------- int|float isomaxr)rrrrr s z Volume.isomaxcCs ||d<dS)Nrr)rrrrrr scCs|dS)z Sets the minimum boundary for iso-surface plot. The 'isomin' property is a number and may be specified as: - An int or float Returns ------- int|float isominr)rrrrr s z Volume.isomincCs ||d<dS)Nrr)rrrrrr scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr szVolume.legendgroupcCs ||d<dS)Nrr)rrrrrr scCs|dS)ag The 'lighting' property is an instance of Lighting that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor Supported dict properties: ambient Ambient light increases overall color visibility but can wash out the image. diffuse Represents the extent that incident rays are reflected in a range of angles. facenormalsepsilon Epsilon for face normals calculation avoids math issues arising from degenerate geometry. fresnel Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine. roughness Alters specular reflection; the rougher the surface, the wider and less contrasty the shine. specular Represents the level that incident rays are reflected in a single direction, causing shine. vertexnormalsepsilon Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry. Returns ------- plotly.graph_objs.volume.Lighting lightingr)rrrrr s(zVolume.lightingcCs ||d<dS)Nrr)rrrrrr scCs|dS)a" The 'lightposition' property is an instance of Lightposition that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor Supported dict properties: x Numeric vector, representing the X coordinate for each vertex. y Numeric vector, representing the Y coordinate for each vertex. z Numeric vector, representing the Z coordinate for each vertex. Returns ------- plotly.graph_objs.volume.Lightposition lightpositionr)rrrrr szVolume.lightpositioncCs ||d<dS)Nrr)rrrrrr1 scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!7 sz Volume.metacCs ||d<dS)Nr!r)rrrrrr!M scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"S s zVolume.metasrccCs ||d<dS)Nr"r)rrrrrr"a scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#g sz Volume.namecCs ||d<dS)Nr#r)rrrrrr#w scCs|dS)aS Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'} szVolume.opacitycCs ||d<dS)Nr'r)rrrrrr' scCs|dS)a Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'. The 'opacityscale' property accepts values of any type Returns ------- Any opacityscaler)rrrrr szVolume.opacityscalecCs ||d<dS)Nrr)rrrrrr scCs|dS)aF Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool reversescaler)rrrrr szVolume.reversescalecCs ||d<dS)Nrr)rrrrrr scCs|dS)a7 Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular subplot, of type 'scene', that may be specified as the string 'scene' optionally followed by an integer >= 1 (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- str scener)rrrrr sz Volume.scenecCs ||d<dS)Nrr)rrrrrr scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+ s zVolume.showlegendcCs ||d<dS)Nr+r)rrrrrr+ scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool showscaler)rrrrr s zVolume.showscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)aP The 'slices' property is an instance of Slices that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Slices` - A dict of string/value properties that will be passed to the Slices constructor Supported dict properties: x :class:`plotly.graph_objects.volume.slices.X` instance or dict with compatible properties y :class:`plotly.graph_objects.volume.slices.Y` instance or dict with compatible properties z :class:`plotly.graph_objects.volume.slices.Z` instance or dict with compatible properties Returns ------- plotly.graph_objs.volume.Slices slicesr)rrrrr sz Volume.slicescCs ||d<dS)Nrr)rrrrrr%scCs|dS)a The 'spaceframe' property is an instance of Spaceframe that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Spaceframe` - A dict of string/value properties that will be passed to the Spaceframe constructor Supported dict properties: fill Sets the fill ratio of the `spaceframe` elements. The default fill value is 1 meaning that they are entirely shaded. Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. show Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1. Returns ------- plotly.graph_objs.volume.Spaceframe spaceframer)rrrrr+szVolume.spaceframecCs ||d<dS)Nrr)rrrrrrHscCs|dS)af The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.volume.Stream r,r)rrrrr,Nsz Volume.streamcCs ||d<dS)Nr,r)rrrrrr,iscCs|dS)a' The 'surface' property is an instance of Surface that may be specified as: - An instance of :class:`plotly.graph_objs.volume.Surface` - A dict of string/value properties that will be passed to the Surface constructor Supported dict properties: count Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn. fill Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. pattern Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest. show Hides/displays surfaces between minimum and maximum iso-values. Returns ------- plotly.graph_objs.volume.Surface surfacer)rrrrros*zVolume.surfacecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-sz Volume.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zVolume.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7sz Volume.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szVolume.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)z Sets the 4th dimension (value) of the vertices. The 'value' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray valuer)rrrrrs z Volume.valuecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for value . The 'valuesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str valuesrcr)rrrrrs zVolume.valuesrccCs ||d<dS)Nrr)rrrrrr&scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9,szVolume.visiblecCs ||d<dS)Nr9r)rrrrrr9=scCs|dS)z Sets the X coordinates of the vertices on X axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<Cs zVolume.xcCs ||d<dS)Nr<r)rrrrrr<QscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?Ws z Volume.xsrccCs ||d<dS)Nr?r)rrrrrr?escCs|dS)z Sets the Y coordinates of the vertices on Y axis. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@ks zVolume.ycCs ||d<dS)Nr@r)rrrrrr@yscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs z Volume.ysrccCs ||d<dS)NrCr)rrrrrrCscCs|dS)z Sets the Z coordinates of the vertices on Z axis. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray zr)rrrrrs zVolume.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str zsrcr)rrrrrs z Volume.zsrccCs ||d<dS)Nrr)rrrrrrscCs |jdS)NrD)rE)rrrrrDsz Volume.typecCsdS)NrFr)rrrrrGszVolume._parent_path_strcCsdS)Na. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps :class:`plotly.graph_objects.volume.Caps` instance or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.volume.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour :class:`plotly.graph_objects.volume.Contour` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . flatshading Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.volume.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . isomax Sets the maximum boundary for iso-surface plot. isomin Sets the minimum boundary for iso-surface plot. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.volume.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.volume.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. opacityscale Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. slices :class:`plotly.graph_objects.volume.Slices` instance or dict with compatible properties spaceframe :class:`plotly.graph_objects.volume.Spaceframe` instance or dict with compatible properties stream :class:`plotly.graph_objects.volume.Stream` instance or dict with compatible properties surface :class:`plotly.graph_objects.volume.Surface` instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. value Sets the 4th dimension (value) of the vertices. valuesrc Sets the source reference on plot.ly for value . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the X coordinates of the vertices on X axis. xsrc Sets the source reference on plot.ly for x . y Sets the Y coordinates of the vertices on Y axis. ysrc Sets the source reference on plot.ly for y . z Sets the Z coordinates of the vertices on Z axis. zsrc Sets the source reference on plot.ly for z . r)rrrrrHsszVolume._prop_descriptionsNc7; s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|7 dd|_ ddl m }8|8|jd<|8|jd <|8|jd <|8|jd <|8|jd <|8|jd <|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8 |jd<|8!|jd<|8"|jd<|8#|jd<|8$|jd<|8%|jd<|8&|jd<|8'|jd <|8(|jd!<|8)|jd"<|8*|jd#<|8+|jd$<|8,|jd%<|8-|jd&<|8.|jd'<|8/|jd(<|80|jd)<|81|jd*<|82|jd+<|83|jd,<|84|jd-<|85|jd.<|86|jd/<|87|jd0<|88|jd1<|89|jd2<|8:|jd3<|8;|jd4<|8<|jd5<|8=|jd6<|8>|jd7<|8?|jd8<|8@|jd9<|8A|jd:<|8B|jd;<|8C|jd<<| dd}9|dk rl|n|9|d<| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| dd}9|dk r8|n|9|d<| dd}9| dk rZ| n|9|d<| dd}9| dk r|| n|9|d<| dd}9| dk r| n|9|d<| dd}9| dk r| n|9|d<| dd}9| dk r| n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r&|n|9|d<| dd}9|dk rH|n|9|d<| dd}9|dk rj|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r6|n|9|d<| dd}9|dk rX|n|9|d<| dd}9|dk rz|n|9|d<| d d}9|dk r|n|9|d <| d!d}9|dk r|n|9|d!<| d"d}9|dk r|n|9|d"<| d#d}9|dk r|n|9|d#<| d$d}9|dk r$|n|9|d$<| d%d}9|dk rF|n|9|d%<| d&d}9| dk rh| n|9|d&<| d'd}9|!dk r|!n|9|d'<| d(d}9|"dk r|"n|9|d(<| d)d}9|#dk r|#n|9|d)<| d*d}9|$dk r|$n|9|d*<| d+d}9|%dk r|%n|9|d+<| d,d}9|&dk r4|&n|9|d,<| d-d}9|'dk rV|'n|9|d-<| d.d}9|(dk rx|(n|9|d.<| d/d}9|)dk r|)n|9|d/<| d0d}9|*dk r|*n|9|d0<| d1d}9|+dk r|+n|9|d1<| d2d}9|,dk r|,n|9|d2<| d3d}9|-dk r"|-n|9|d3<| d4d}9|.dk rD|.n|9|d4<| d5d}9|/dk rf|/n|9|d5<| d6d}9|0dk r|0n|9|d6<| d7d}9|1dk r|1n|9|d7<| d8d}9|2dk r|2n|9|d8<| d9d}9|3dk r|3n|9|d9<| d:d}9|4dk r|4n|9|d:<| d;d}9|5dk r2|5n|9|d;<| d<|:d>ddd?|jd><| d>d|jGft|f|7d|_ dS)@ap1 Construct a new Volume object Draws volume trace between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non- uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Volume` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps :class:`plotly.graph_objects.volume.Caps` instance or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.volume.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour :class:`plotly.graph_objects.volume.Contour` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . flatshading Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.volume.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . isomax Sets the maximum boundary for iso-surface plot. isomin Sets the minimum boundary for iso-surface plot. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.volume.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.volume.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. opacityscale Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. slices :class:`plotly.graph_objects.volume.Slices` instance or dict with compatible properties spaceframe :class:`plotly.graph_objects.volume.Spaceframe` instance or dict with compatible properties stream :class:`plotly.graph_objects.volume.Stream` instance or dict with compatible properties surface :class:`plotly.graph_objects.volume.Surface` instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. value Sets the 4th dimension (value) of the vertices. valuesrc Sets the source reference on plot.ly for value . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the X coordinates of the vertices on X axis. xsrc Sets the source reference on plot.ly for x . y Sets the Y coordinates of the vertices on Y axis. ysrc Sets the source reference on plot.ly for y . z Sets the Z coordinates of the vertices on Z axis. zsrc Sets the source reference on plot.ly for z . Returns ------- Volume volumeNzThe first argument to the plotly.graph_objs.Volume constructor must be a dict or an instance of :class:`plotly.graph_objs.Volume`rJFr)rrrrrrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrrr+rrrr,rr-r3r7r8rrr9r<r?r@rCrr)rKrD)rLrMr)HrNrrOrPrQrRrSrTrUrVrWrXrYrAutocolorscaleValidatorr[ CapsValidatorCautoValidator CmaxValidator CmidValidator CminValidatorColoraxisValidatorColorBarValidatorColorscaleValidatorContourValidatorr`raFlatshadingValidatorrerfrgrhrirjrkrlrmIsomaxValidatorIsominValidatorrqLightingValidatorLightpositionValidatorrrrsrtrxZOpacityscaleValidatorReversescaleValidatorSceneValidatorr|ShowscaleValidatorSlicesValidatorSpaceframeValidatorr}SurfaceValidatorr~rrrValueValidatorValuesrcValidatorrrrrr ZValidator ZsrcValidatorrrKrEr);rrrrrrrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrrr+rrrr,rr-r3r7r8rrr9r<r?r@rCrrrZv_volumerrK)rQrrrOsf?                                                             zVolume.__init__)6NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)?rrrrrrrrrrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrrr+rrrr,rr-r3r7r8rrr9r<r?r@rCrrrDrGrHrOrrr)rQrr~ sJ        f .       5 #         *              ,                wrc6seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:eddZ;eddZS)ViolincCs|dS)a Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. The 'alignmentgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszViolin.alignmentgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)aZ Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb. The 'bandwidth' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float bandwidthr)rrrrrszViolin.bandwidthcCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'box' property is an instance of Box that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Box` - A dict of string/value properties that will be passed to the Box constructor Supported dict properties: fillcolor Sets the inner box plot fill color. line :class:`plotly.graph_objects.violin.box.Line` instance or dict with compatible properties visible Determines if an miniature box plot is drawn inside the violins. width Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins. Returns ------- plotly.graph_objs.violin.Box boxr)rrrrrsz Violin.boxcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr %szViolin.customdatacCs ||d<dS)Nr r)rrrrrr 6scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr<s zViolin.customdatasrccCs ||d<dS)Nrr)rrrrrrJscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str fillcolorr)rrrrrPs5zViolin.fillcolorcCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszViolin.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zViolin.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.violin.Hoverlabel rr)rrrrrs3zViolin.hoverlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them? The 'hoveron' property is a flaglist and may be specified as a string containing: - Any combination of ['violins', 'points', 'kde'] joined with '+' characters (e.g. 'violins+points') OR exactly one of ['all'] (e.g. 'all') Returns ------- Any hoveronr)rrrrrszViolin.hoveroncCs ||d<dS)Nrr)rrrrrr scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrs!zViolin.hovertemplatecCs ||d<dS)Nrr)rrrrrr2scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr8s zViolin.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrFscCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrLszViolin.hovertextcCs ||d<dS)Nrr)rrrrrr\scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrbs zViolin.hovertextsrccCs ||d<dS)Nrr)rrrrrrpscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrvsz Violin.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Violin.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins. The 'jitter' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float jitterr)rrrrrsz Violin.jittercCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszViolin.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)aX The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the color of line bounding the violin(s). width Sets the width (in px) of line bounding the violin(s). Returns ------- plotly.graph_objs.violin.Line liner)rrrrrsz Violin.linecCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. line :class:`plotly.graph_objects.violin.marker.Line ` instance or dict with compatible properties opacity Sets the marker opacity. outliercolor Sets the color of the outlier sample points. size Sets the marker size (in px). symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. Returns ------- plotly.graph_objs.violin.Marker markerr)rrrrrs&z Violin.markercCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'meanline' property is an instance of Meanline that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Meanline` - A dict of string/value properties that will be passed to the Meanline constructor Supported dict properties: color Sets the mean line color. visible Determines if a line corresponding to the sample's mean is shown inside the violins. If `box.visible` is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other. width Sets the mean line width. Returns ------- plotly.graph_objs.violin.Meanline meanliner)rrrrrszViolin.meanlinecCs ||d<dS)Nrr)rrrrrr6scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!<sz Violin.metacCs ||d<dS)Nr!r)rrrrrr!RscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Xs zViolin.metasrccCs ||d<dS)Nr"r)rrrrrr"fscCs|dS)av Sets the trace name. The trace name appear as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details). The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#lsz Violin.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)a Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. The 'offsetgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r%r)rrrrr%szViolin.offsetgroupcCs ||d<dS)Nr%r)rrrrrr%scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr's zViolin.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)a_ Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal). The 'orientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['v', 'h'] Returns ------- Any r(r)rrrrr(szViolin.orientationcCs ||d<dS)Nr(r)rrrrrr(scCs|dS)a Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins. The 'pointpos' property is a number and may be specified as: - An int or float in the interval [-2, 2] Returns ------- int|float pointposr)rrrrrszViolin.pointposcCs ||d<dS)Nrr)rrrrrrscCs|dS)a If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If False, only the violins are shown with no sample points. Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to "outliers". The 'points' property is an enumeration that may be specified as: - One of the following enumeration values: ['all', 'outliers', 'suspectedoutliers', False] Returns ------- Any pointsr)rrrrrsz Violin.pointscCs ||d<dS)Nrr)rrrrrrscCs|dS)aR If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non- empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together The 'scalegroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str scalegroupr)rrrrrszViolin.scalegroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the metric by which the width of each violin is determined."width" means each violin has the same (max) width*count* means the violins are scaled by the number of sample points makingup each violin. The 'scalemode' property is an enumeration that may be specified as: - One of the following enumeration values: ['width', 'count'] Returns ------- Any scalemoder)rrrrrszViolin.scalemodecCs ||d<dS)Nrr)rrrrrr(scCs|dS)aS The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.violin.selected.Ma rker` instance or dict with compatible properties Returns ------- plotly.graph_objs.violin.Selected selectedr)rrrrr.szViolin.selectedcCs ||d<dS)Nrr)rrrrrrDscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*JszViolin.selectedpointscCs ||d<dS)Nr*r)rrrrrr*\scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+bs zViolin.showlegendcCs ||d<dS)Nr+r)rrrrrr+qscCs|dS)a Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under "overlay" mode, where one trace has `side` set to "positive" and the other to "negative". The 'side' property is an enumeration that may be specified as: - One of the following enumeration values: ['both', 'positive', 'negative'] Returns ------- Any sider)rrrrrwsz Violin.sidecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual". The 'span' property is an info array that may be specified as: * a list or tuple of 2 elements where: (0) The 'span[0]' property accepts values of any type (1) The 'span[1]' property accepts values of any type Returns ------- list spanr)rrrrrsz Violin.spancCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the `span` attribute. The 'spanmode' property is an enumeration that may be specified as: - One of the following enumeration values: ['soft', 'hard', 'manual'] Returns ------- Any spanmoder)rrrrrszViolin.spanmodecCs ||d<dS)Nrr)rrrrrrscCs|dS)af The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.violin.Stream r,r)rrrrr,sz Violin.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a] Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-sz Violin.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zViolin.textsrccCs ||d<dS)Nr3r)rrrrrr3 scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7sz Violin.uidcCs ||d<dS)Nr7r)rrrrrr7"scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8(szViolin.uirevisioncCs ||d<dS)Nr8r)rrrrrr8CscCs|dS)a_ The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.violin.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.violin.unselected. Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.violin.Unselected unselectedr)rrrrrIszViolin.unselectedcCs ||d<dS)Nrr)rrrrrr_scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9eszViolin.visiblecCs ||d<dS)Nr9r)rrrrrr9vscCs|dS)a~ Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot. The 'width' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float r:r)rrrrr:|sz Violin.widthcCs ||d<dS)Nr:r)rrrrrr:scCs|dS)a  Sets the x sample data or coordinates. See overview for more info. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<s zViolin.xcCs ||d<dS)Nr<r)rrrrrr<scCs|dS)a Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr=s z Violin.x0cCs ||d<dS)Nr=r)rrrrrr=scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>sz Violin.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s z Violin.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)a  Sets the y sample data or coordinates. See overview for more info. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@s zViolin.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAs z Violin.y0cCs ||d<dS)NrAr)rrrrrrA scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBsz Violin.yaxiscCs ||d<dS)NrBr)rrrrrrB&scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC,s z Violin.ysrccCs ||d<dS)NrCr)rrrrrrC:scCs |jdS)NrD)rE)rrrrrD@sz Violin.typecCsdS)NrFr)rrrrrGFszViolin._parent_path_strcCsdS)Na3 alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. bandwidth Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb. box :class:`plotly.graph_objects.violin.Box` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.violin.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them? hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . jitter Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.violin.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.violin.Marker` instance or dict with compatible properties meanline :class:`plotly.graph_objects.violin.Meanline` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details). offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal). pointpos Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins. points If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If False, only the violins are shown with no sample points. Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to "outliers". scalegroup If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together scalemode Sets the metric by which the width of each violin is determined."width" means each violin has the same (max) width*count* means the violins are scaled by the number of sample points makingup each violin. selected :class:`plotly.graph_objects.violin.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. side Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under "overlay" mode, where one trace has `side` set to "positive" and the other to "negative". span Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual". spanmode Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the `span` attribute. stream :class:`plotly.graph_objects.violin.Stream` instance or dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.violin.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot. x Sets the x sample data or coordinates. See overview for more info. x0 Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y Sets the y sample data or coordinates. See overview for more info. y0 Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . r)rrrrrHLs zViolin._prop_descriptionsNc7; s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|7 dd|_ ddl m }8|8|jd<|8|jd <|8|jd <|8|jd <|8|jd <|8|jd <|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8 |jd<|8!|jd<|8"|jd<|8#|jd<|8$|jd<|8%|jd<|8&|jd<|8'|jd <|8(|jd!<|8)|jd"<|8*|jd#<|8+|jd$<|8,|jd%<|8-|jd&<|8.|jd'<|8/|jd(<|80|jd)<|81|jd*<|82|jd+<|83|jd,<|84|jd-<|85|jd.<|86|jd/<|87|jd0<|88|jd1<|89|jd2<|8:|jd3<|8;|jd4<|8<|jd5<|8=|jd6<|8>|jd7<|8?|jd8<|8@|jd9<|8A|jd:<|8B|jd;<|8C|jd<<| dd}9|dk rl|n|9|d<| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| dd}9|dk r8|n|9|d<| dd}9| dk rZ| n|9|d<| dd}9| dk r|| n|9|d<| dd}9| dk r| n|9|d<| dd}9| dk r| n|9|d<| dd}9| dk r| n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r&|n|9|d<| dd}9|dk rH|n|9|d<| dd}9|dk rj|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r6|n|9|d<| dd}9|dk rX|n|9|d<| dd}9|dk rz|n|9|d<| d d}9|dk r|n|9|d <| d!d}9|dk r|n|9|d!<| d"d}9|dk r|n|9|d"<| d#d}9|dk r|n|9|d#<| d$d}9|dk r$|n|9|d$<| d%d}9|dk rF|n|9|d%<| d&d}9| dk rh| n|9|d&<| d'd}9|!dk r|!n|9|d'<| d(d}9|"dk r|"n|9|d(<| d)d}9|#dk r|#n|9|d)<| d*d}9|$dk r|$n|9|d*<| d+d}9|%dk r|%n|9|d+<| d,d}9|&dk r4|&n|9|d,<| d-d}9|'dk rV|'n|9|d-<| d.d}9|(dk rx|(n|9|d.<| d/d}9|)dk r|)n|9|d/<| d0d}9|*dk r|*n|9|d0<| d1d}9|+dk r|+n|9|d1<| d2d}9|,dk r|,n|9|d2<| d3d}9|-dk r"|-n|9|d3<| d4d}9|.dk rD|.n|9|d4<| d5d}9|/dk rf|/n|9|d5<| d6d}9|0dk r|0n|9|d6<| d7d}9|1dk r|1n|9|d7<| d8d}9|2dk r|2n|9|d8<| d9d}9|3dk r|3n|9|d9<| d:d}9|4dk r|4n|9|d:<| d;d}9|5dk r2|5n|9|d;<| d<|:d>ddd?|jd><| d>d|jGft|f|7d|_ dS)@aE6 Construct a new Violin object In vertical (horizontal) violin plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one violin per distinct x (y) value is drawn If no `x` (`y`) list is provided, a single violin is drawn. That violin position is then positioned with with `name` or with `x0` (`y0`) if provided. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Violin` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. bandwidth Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb. box :class:`plotly.graph_objects.violin.Box` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.violin.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them? hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . jitter Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.violin.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.violin.Marker` instance or dict with compatible properties meanline :class:`plotly.graph_objects.violin.Meanline` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details). offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal). pointpos Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins. points If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If False, only the violins are shown with no sample points. Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to "outliers". scalegroup If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together scalemode Sets the metric by which the width of each violin is determined."width" means each violin has the same (max) width*count* means the violins are scaled by the number of sample points makingup each violin. selected :class:`plotly.graph_objects.violin.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. side Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under "overlay" mode, where one trace has `side` set to "positive" and the other to "negative". span Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual". spanmode Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the `span` attribute. stream :class:`plotly.graph_objects.violin.Stream` instance or dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.violin.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot. x Sets the x sample data or coordinates. See overview for more info. x0 Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y Sets the y sample data or coordinates. See overview for more info. y0 Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . Returns ------- Violin violinNzThe first argument to the plotly.graph_objs.Violin constructor must be a dict or an instance of :class:`plotly.graph_objs.Violin`rJFr)rrrrr rrrrrrrrrrrrrrrrrr!r"r#r%r'r(rrrrrr*r+rrrr,r-r3r7r8rr9r:r<r=r>r?r@rArBrC)rKrD)rLrMr)HrNrrOrPrQrRrSrTrUrVrWrXrYrrZr[ZBandwidthValidatorZ BoxValidatorr`raFillcolorValidatorrerfrgHoveronValidatorrhrirjrkrlrmJitterValidatorrq LineValidatorMarkerValidatorZMeanlineValidatorrrrsrtrvrxryPointposValidatorZPointsValidatorScalegroupValidatorZScalemodeValidatorSelectedValidatorr{r|Z SideValidatorZ SpanValidatorZSpanmodeValidatorr}r~rrrUnselectedValidatorrrrrrrrrrrrrKrEr);rrrrrr rrrrrrrrrrrrrrrrrr!r"r#r%r'r(rrrrrr*r+rrrr,r-r3r7r8rr9r:r<r=r>r?r@rArBrCrZv_violinrrK)rQrrrOVsfU                                                             zViolin.__init__)6NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)?rrrrrrrrr rrrrrrrrrrrrrrrrrr!r"r#r%r'r(rrrrrr*r+rrrr,r-r3r7r8rr9r:r<r=r>r?r@rArBrCrDrGrHrOrrr)rQrrsJ      7   5  #         (                                    rc+seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/eddZ0eddZ1dfdd Z2Z3S)TreemapcCs|dS)aM Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves. The 'branchvalues' property is an enumeration that may be specified as: - One of the following enumeration values: ['remainder', 'total'] Returns ------- Any branchvaluesr)rrrrrszTreemap.branchvaluescCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0. The 'count' property is a flaglist and may be specified as a string containing: - Any combination of ['branches', 'leaves'] joined with '+' characters (e.g. 'branches+leaves') Returns ------- Any countr)rrrrrsz Treemap.countcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szTreemap.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zTreemap.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this treemap trace . row If there is a layout grid, use the domain for this row in the grid for this treemap trace . x Sets the horizontal domain of this treemap trace (in plot fraction). y Sets the vertical domain of this treemap trace (in plot fraction). Returns ------- plotly.graph_objs.treemap.Domain domainr)rrrrrszTreemap.domaincCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszTreemap.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr!s zTreemap.hoverinfosrccCs ||d<dS)Nrr)rrrrrr/scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.treemap.Hoverlabel rr)rrrrr5s3zTreemap.hoverlabelcCs ||d<dS)Nrr)rrrrrrjscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrps"zTreemap.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zTreemap.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aK Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrszTreemap.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zTreemap.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Treemap.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zTreemap.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)av Sets the font used for `textinfo` lying inside the sector. The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.treemap.Insidetextfont rr)rrrrrs/zTreemap.insidetextfontcCs ||d<dS)Nrr)rrrrrr7scCs|dS)z Sets the labels of each of the sectors. The 'labels' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray labelsr)rrrrr=s zTreemap.labelscCs ||d<dS)Nrr)rrrrrrKscCs|dS)z Sets the source reference on plot.ly for labels . The 'labelssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str labelssrcr)rrrrrQs zTreemap.labelssrccCs ||d<dS)Nrr)rrrrrr_scCs|dS)aw Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. The 'level' property accepts values of any type Returns ------- Any levelr)rrrrresz Treemap.levelcCs ||d<dS)Nrr)rrrrrruscCs|dS)al The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if colorsis set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if colorsis set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.treemap.marker.Col orBar` instance or dict with compatible properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors. colorscale Sets the colorscale. Has an effect only if colorsis set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorssrc Sets the source reference on plot.ly for colors . depthfade Determines if the sector colors are faded towards the background from the leaves up to the headers. This option is unavailable when a `colorscale` is present, defaults to false when `marker.colors` is set, but otherwise defaults to true. When set to "reversed", the fading direction is inverted, that is the top elements within hierarchy are drawn with fully saturated colors while the leaves are faded towards the background color. line :class:`plotly.graph_objects.treemap.marker.Lin e` instance or dict with compatible properties pad :class:`plotly.graph_objects.treemap.marker.Pad ` instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if colorsis set to a numerical array. Returns ------- plotly.graph_objs.treemap.Marker rr)rrrrr{suzTreemap.markercCs ||d<dS)Nrr)rrrrrrscCs|dS)aI Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy. The 'maxdepth' property is a integer and may be specified as: - An int (or float that will be cast to an int) Returns ------- int maxdepthr)rrrrrs zTreemap.maxdepthcCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr! sz Treemap.metacCs ||d<dS)Nr!r)rrrrrr!#scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr")s zTreemap.metasrccCs ||d<dS)Nr"r)rrrrrr"7scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#=sz Treemap.namecCs ||d<dS)Nr#r)rrrrrr#MscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'Ss zTreemap.opacitycCs ||d<dS)Nr'r)rrrrrr'ascCs|dS)a| Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used. The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.treemap.Outsidetextfont r)r)rrrrr)gs3zTreemap.outsidetextfontcCs ||d<dS)Nr)r)rrrrrr)scCs|dS)a' Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique. The 'parents' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray parentsr)rrrrrszTreemap.parentscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for parents . The 'parentssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str parentssrcr)rrrrrs zTreemap.parentssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'pathbar' property is an instance of Pathbar that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Pathbar` - A dict of string/value properties that will be passed to the Pathbar constructor Supported dict properties: edgeshape Determines which shape is used for edges between `barpath` labels. side Determines on which side of the the treemap the `pathbar` should be presented. textfont Sets the font used inside `pathbar`. thickness Sets the thickness of `pathbar` (in px). If not specified the `pathbar.textfont.size` is used with 3 pixles extra padding on each side. visible Determines if the path bar is drawn i.e. outside the trace `domain` and with one pixel gap. Returns ------- plotly.graph_objs.treemap.Pathbar pathbarr)rrrrrs zTreemap.pathbarcCs ||d<dS)Nrr)rrrrrrscCs|dS)ah The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.treemap.Stream r,r)rrrrr,szTreemap.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-sz Treemap.textcCs ||d<dS)Nr-r)rrrrrr-*scCs|dS)a@ Sets the font used for `textinfo`. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.treemap.Textfont r/r)rrrrr/0s/zTreemap.textfontcCs ||d<dS)Nr/r)rrrrrr/ascCs|dS)a Determines which trace information appear on the graph. The 'textinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any r0r)rrrrr0gszTreemap.textinfocCs ||d<dS)Nr0r)rrrrrr0xscCs|dS)a Sets the positions of the `text` elements. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] Returns ------- Any r1r)rrrrr1~szTreemap.textpositioncCs ||d<dS)Nr1r)rrrrrr1scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zTreemap.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4szTreemap.texttemplatecCs ||d<dS)Nr4r)rrrrrr4scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5s zTreemap.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5scCs|dS)a The 'tiling' property is an instance of Tiling that may be specified as: - An instance of :class:`plotly.graph_objs.treemap.Tiling` - A dict of string/value properties that will be passed to the Tiling constructor Supported dict properties: flip Determines if the positions obtained from solver are flipped on each axis. packing Determines d3 treemap solver. For more info please refer to https://github.com/d3/d3-hierarchy#treemap- tiling pad Sets the inner padding (in px). squarifyratio When using "squarify" `packing` algorithm, according to https://github.com/d3/d3-hierarchy /blob/master/README.md#squarify_ratio this option specifies the desired aspect ratio of the generated rectangles. The ratio must be specified as a number greater than or equal to one. Note that the orientation of the generated rectangles (tall or wide) is not implied by the ratio; for example, a ratio of two will attempt to produce a mixture of rectangles whose width:height ratio is either 2:1 or 1:2. When using "squarify", unlike d3 which uses the Golden Ratio i.e. 1.618034, Plotly applies 1 to increase squares in treemap layouts. Returns ------- plotly.graph_objs.treemap.Tiling tilingr)rrrrrs)zTreemap.tilingcCs ||d<dS)Nrr)rrrrrr scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7 sz Treemap.uidcCs ||d<dS)Nr7r)rrrrrr7# scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8) szTreemap.uirevisioncCs ||d<dS)Nr8r)rrrrrr8D scCs|dS)aB Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed. The 'values' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray valuesr)rrrrrJ s zTreemap.valuescCs ||d<dS)Nrr)rrrrrrY scCs|dS)z Sets the source reference on plot.ly for values . The 'valuessrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str valuessrcr)rrrrr_ s zTreemap.valuessrccCs ||d<dS)Nrr)rrrrrrm scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9s szTreemap.visiblecCs ||d<dS)Nr9r)rrrrrr9 scCs |jdS)NrD)rE)rrrrrD sz Treemap.typecCsdS)NrFr)rrrrrG szTreemap._parent_path_strcCsdS)Na) branchvalues Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves. count Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . domain :class:`plotly.graph_objects.treemap.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.treemap.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. labels Sets the labels of each of the sectors. labelssrc Sets the source reference on plot.ly for labels . level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. marker :class:`plotly.graph_objects.treemap.Marker` instance or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. outsidetextfont Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used. parents Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique. parentssrc Sets the source reference on plot.ly for parents . pathbar :class:`plotly.graph_objects.treemap.Pathbar` instance or dict with compatible properties stream :class:`plotly.graph_objects.treemap.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textposition Sets the positions of the `text` elements. textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . tiling :class:`plotly.graph_objects.treemap.Tiling` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrH sRzTreemap._prop_descriptionsNc,0 stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|, dd|_ ddl m }-|-|jd<|-|jd <|-|jd <|-|jd <|-|jd <|-|jd <|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|- |jd<|-!|jd<|-"|jd<|-#|jd<|-$|jd<|-%|jd<|-&|jd<|-'|jd <|-(|jd!<|-)|jd"<|-*|jd#<|-+|jd$<|-,|jd%<|--|jd&<|-.|jd'<|-/|jd(<|-0|jd)<|-1|jd*<|-2|jd+<|-3|jd,<|-4|jd-<|-5|jd.<|-6|jd/<|-7|jd0<|-8|jd1<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d d}.|dk r|n|.|d <| d d}.|dk r8|n|.|d <| d d}.|dk rZ|n|.|d <| d d}.|dk r||n|.|d <| dd}.|dk r|n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r&| n|.|d<| dd}.| dk rH| n|.|d<| dd}.|dk rj|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r6|n|.|d<| dd}.|dk rX|n|.|d<| dd}.|dk rz|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d!d}.|dk r$|n|.|d!<| d"d}.|dk rF|n|.|d"<| d#d}.|dk rh|n|.|d#<| d$d}.|dk r|n|.|d$<| d%d}.|dk r|n|.|d%<| d&d}.| dk r| n|.|d&<| d'd}.|!dk r|!n|.|d'<| d(d}.|"dk r|"n|.|d(<| d)d}.|#dk r4|#n|.|d)<| d*d}.|$dk rV|$n|.|d*<| d+d}.|%dk rx|%n|.|d+<| d,d}.|&dk r|&n|.|d,<| d-d}.|'dk r|'n|.|d-<| d.d}.|(dk r|(n|.|d.<| d/d}.|)dk r|)n|.|d/<| d0d}.|*dk r"|*n|.|d0<| d1d}.|+dk rD|+n|.|d1<dd2l9m:}/d|j;d3<|/d3ddd4|jd3<| d3d|j` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. labels Sets the labels of each of the sectors. labelssrc Sets the source reference on plot.ly for labels . level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. marker :class:`plotly.graph_objects.treemap.Marker` instance or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. outsidetextfont Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used. parents Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique. parentssrc Sets the source reference on plot.ly for parents . pathbar :class:`plotly.graph_objects.treemap.Pathbar` instance or dict with compatible properties stream :class:`plotly.graph_objects.treemap.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textposition Sets the positions of the `text` elements. textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . tiling :class:`plotly.graph_objects.treemap.Tiling` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Treemap treemapNzThe first argument to the plotly.graph_objs.Treemap constructor must be a dict or an instance of :class:`plotly.graph_objs.Treemap`rJFr)rrrr rrrrrrrrrrrrrrrrrr!r"r#r'r)rrrr,r-r/r0r1r3r4r5rr7r8rrr9)rKrD)rLrMr)=rNrrOrPrQrRrSrTrUrVrWrXrYrBranchvaluesValidatorr[CountValidatorr`raDomainValidatorrerfrgrhrirjrkrlrmrpLabelsValidatorLabelssrcValidatorLevelValidatorrMaxdepthValidatorrrrsrtrxrzParentsValidatorParentssrcValidatorZPathbarValidatorr}r~rrrrrrZTilingValidatorrrValuesValidatorValuessrcValidatorrrrKrEr)0rrrrr rrrrrrrrrrrrrrrrrr!r"r#r'r)rrrr,r-r/r0r1r3r4r5rr7r8rrr9rZ v_treemaprrK)rQrrrOi!s$                                                  zTreemap.__init__)+NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)4rrrrrrrr rrrrrrrrrrrrrrrrrr!r"r#r'r)rrrr,r-r/r0r1r3r4r5rr7r8rrr9rDrGrHrOrrr)rQrrs        5 $      1    w      5   "   1      +        VrcsdeZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZedBdCZedDdEZdIfdGdH ZZS)JTablecCs|dS)ao The 'cells' property is an instance of Cells that may be specified as: - An instance of :class:`plotly.graph_objs.table.Cells` - A dict of string/value properties that will be passed to the Cells constructor Supported dict properties: align Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more
HTML tags) or if an explicit width is set to override the text width. alignsrc Sets the source reference on plot.ly for align . fill :class:`plotly.graph_objects.table.cells.Fill` instance or dict with compatible properties font :class:`plotly.graph_objects.table.cells.Font` instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format formatsrc Sets the source reference on plot.ly for format . height The height of cells. line :class:`plotly.graph_objects.table.cells.Line` instance or dict with compatible properties prefix Prefix for cell values. prefixsrc Sets the source reference on plot.ly for prefix . suffix Suffix for cell values. suffixsrc Sets the source reference on plot.ly for suffix . values Cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string. valuessrc Sets the source reference on plot.ly for values . Returns ------- plotly.graph_objs.table.Cells cellsr)rrrrr 3#sAz Table.cellscCs ||d<dS)Nr r)rrrrrr v#scCs|dS)a Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero. The 'columnorder' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray columnorderr)rrrrr |#szTable.columnordercCs ||d<dS)Nr r)rrrrrr #scCs|dS)z Sets the source reference on plot.ly for columnorder . The 'columnordersrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str columnordersrcr)rrrrr #s zTable.columnordersrccCs ||d<dS)Nr r)rrrrrr #scCs|dS)a The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths. The 'columnwidth' property is a number and may be specified as: - An int or float - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray columnwidthr)rrrrr#szTable.columnwidthcCs ||d<dS)Nrr)rrrrrr#scCs|dS)z Sets the source reference on plot.ly for columnwidth . The 'columnwidthsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str columnwidthsrcr)rrrrr#s zTable.columnwidthsrccCs ||d<dS)Nrr)rrrrrr#scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr #szTable.customdatacCs ||d<dS)Nr r)rrrrrr #scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr#s zTable.customdatasrccCs ||d<dS)Nrr)rrrrrr#scCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.table.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this table trace . row If there is a layout grid, use the domain for this row in the grid for this table trace . x Sets the horizontal domain of this table trace (in plot fraction). y Sets the vertical domain of this table trace (in plot fraction). Returns ------- plotly.graph_objs.table.Domain rr)rrrrr#sz Table.domaincCs ||d<dS)Nrr)rrrrrr$scCs|dS)a~ The 'header' property is an instance of Header that may be specified as: - An instance of :class:`plotly.graph_objs.table.Header` - A dict of string/value properties that will be passed to the Header constructor Supported dict properties: align Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more
HTML tags) or if an explicit width is set to override the text width. alignsrc Sets the source reference on plot.ly for align . fill :class:`plotly.graph_objects.table.header.Fill` instance or dict with compatible properties font :class:`plotly.graph_objects.table.header.Font` instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format formatsrc Sets the source reference on plot.ly for format . height The height of cells. line :class:`plotly.graph_objects.table.header.Line` instance or dict with compatible properties prefix Prefix for cell values. prefixsrc Sets the source reference on plot.ly for prefix . suffix Suffix for cell values. suffixsrc Sets the source reference on plot.ly for suffix . values Header cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string. valuessrc Sets the source reference on plot.ly for values . Returns ------- plotly.graph_objs.table.Header headerr)rrrrr $sAz Table.headercCs ||d<dS)Nrr)rrrrrrc$scCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrri$szTable.hoverinfocCs ||d<dS)Nrr)rrrrrr}$scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr$s zTable.hoverinfosrccCs ||d<dS)Nrr)rrrrrr$scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.table.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.table.Hoverlabel rr)rrrrr$s3zTable.hoverlabelcCs ||d<dS)Nrr)rrrrrr$scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr$sz Table.idscCs ||d<dS)Nrr)rrrrrr$scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr$s z Table.idssrccCs ||d<dS)Nrr)rrrrrr$scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!$sz Table.metacCs ||d<dS)Nr!r)rrrrrr!%scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"%s z Table.metasrccCs ||d<dS)Nr"r)rrrrrr"&%scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#,%sz Table.namecCs ||d<dS)Nr#r)rrrrrr#<%scCs|dS)ad The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.table.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.table.Stream r,r)rrrrr,B%sz Table.streamcCs ||d<dS)Nr,r)rrrrrr,]%scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7c%sz Table.uidcCs ||d<dS)Nr7r)rrrrrr7s%scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8y%szTable.uirevisioncCs ||d<dS)Nr8r)rrrrrr8%scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9%sz Table.visiblecCs ||d<dS)Nr9r)rrrrrr9%scCs |jdS)NrD)rE)rrrrrD%sz Table.typecCsdS)NrFr)rrrrrG%szTable._parent_path_strcCsdS)Na) cells :class:`plotly.graph_objects.table.Cells` instance or dict with compatible properties columnorder Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero. columnordersrc Sets the source reference on plot.ly for columnorder . columnwidth The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths. columnwidthsrc Sets the source reference on plot.ly for columnwidth . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . domain :class:`plotly.graph_objects.table.Domain` instance or dict with compatible properties header :class:`plotly.graph_objects.table.Header` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.table.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. stream :class:`plotly.graph_objects.table.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrH%s`zTable._prop_descriptionsNc stt|d|dkri}n4t||jr4|}nt|trJt|}nt d| dd|_ ddl m }||jd<||jd <||jd <||jd <||jd <||jd <||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<| |jd<|!|jd<|"|jd<|#|jd<| dd}|dk r|n||d<| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r4|n||d <| d d}|dk rV|n||d <| dd}|dk rx|n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r"| n||d<| dd}|dk rD|n||d<| dd}|dk rf|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r2|n||d<| dd}|dk rT|n||d<ddl$m%}d|j&d<|dddd|jd<| dd|j'ft|f|d|_ dS) ab Construct a new Table object Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column- major order, ie. the grid is represented as a vector of column vectors. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Table` cells :class:`plotly.graph_objects.table.Cells` instance or dict with compatible properties columnorder Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero. columnordersrc Sets the source reference on plot.ly for columnorder . columnwidth The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths. columnwidthsrc Sets the source reference on plot.ly for columnwidth . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . domain :class:`plotly.graph_objects.table.Domain` instance or dict with compatible properties header :class:`plotly.graph_objects.table.Header` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.table.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. stream :class:`plotly.graph_objects.table.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Table tableNzThe first argument to the plotly.graph_objs.Table constructor must be a dict or an instance of :class:`plotly.graph_objs.Table`rJFr)rr r r rrr rrrrrrrrr!r"r#r,r7r8r9)rKrD)rLrMr)(rNr rOrPrQrRrSrTrUrVrWrXrYrZCellsValidatorr[ZColumnorderValidatorZColumnordersrcValidatorZColumnwidthValidatorZColumnwidthsrcValidatorr`rarZHeaderValidatorrerfrgrlrmrrrsrtr}rrrrrKrEr)rrr r r rrr rrrrrrrrr!r"r#r,r7r8r9rZv_tablerrK)rQrrrO&s                              zTable.__init__)NNNNNNNNNNNNNNNNNNNNNN)rrrrr rr r rrr rrrrrrrrr!r"r#r,r7r8r9rDrGrHrOrrr)rQrr /#s C        C   5            dr c3sVeZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7eddZ8eddZ9dfdd Z:Z;S)SurfacecCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr#'szSurface.autocolorscalecCs ||d<dS)Nrr)rrrrrr6'scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. The 'cauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr<'sz Surface.cautocCs ||d<dS)Nrr)rrrrrrM'scCs|dS)a> Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well. The 'cmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrS'sz Surface.cmaxcCs ||d<dS)Nrr)rrrrrrc'scCs|dS)a Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when `cauto` is `false`. The 'cmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrri'sz Surface.cmidcCs ||d<dS)Nrr)rrrrrrz'scCs|dS)a> Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well. The 'cmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr'sz Surface.cmincCs ||d<dS)Nrr)rrrrrr'scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrr'szSurface.coloraxiscCs ||d<dS)Nrr)rrrrrr'scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.surface.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.surface .colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.surface.colorbar.tickformatstopdefaults), sets the default property values to use for elements of surface.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.surface.colorbar.T itle` instance or dict with compatible properties titlefont Deprecated: Please use surface.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use surface.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.surface.ColorBar rr)rrrrr'sdzSurface.colorbarcCs ||d<dS)Nrr)rrrrrr(scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrr(s,zSurface.colorscalecCs ||d<dS)Nrr)rrrrrr(scCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool connectgapsr)rrrrr(s zSurface.connectgapscCs ||d<dS)Nrr)rrrrrr(scCs|dS)ah The 'contours' property is an instance of Contours that may be specified as: - An instance of :class:`plotly.graph_objs.surface.Contours` - A dict of string/value properties that will be passed to the Contours constructor Supported dict properties: x :class:`plotly.graph_objects.surface.contours.X ` instance or dict with compatible properties y :class:`plotly.graph_objects.surface.contours.Y ` instance or dict with compatible properties z :class:`plotly.graph_objects.surface.contours.Z ` instance or dict with compatible properties Returns ------- plotly.graph_objs.surface.Contours contoursr)rrrrr(szSurface.contourscCs ||d<dS)Nrr)rrrrrr)scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr )szSurface.customdatacCs ||d<dS)Nr r)rrrrrr )scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr)s zSurface.customdatasrccCs ||d<dS)Nrr)rrrrrr+)scCs|dS)a\ Determines whether or not a surface is drawn. For example, set `hidesurface` to False `contours.x.show` to True and `contours.y.show` to True to draw a wire frame plot. The 'hidesurface' property must be specified as a bool (either True, or False) Returns ------- bool hidesurfacer)rrrrr1)szSurface.hidesurfacecCs ||d<dS)Nrr)rrrrrrA)scCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrG)szSurface.hoverinfocCs ||d<dS)Nrr)rrrrrr[)scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrra)s zSurface.hoverinfosrccCs ||d<dS)Nrr)rrrrrro)scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.surface.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.surface.Hoverlabel rr)rrrrru)s3zSurface.hoverlabelcCs ||d<dS)Nrr)rrrrrr)scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr)s!zSurface.hovertemplatecCs ||d<dS)Nrr)rrrrrr)scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr)s zSurface.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr)scCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr)szSurface.hovertextcCs ||d<dS)Nrr)rrrrrr)scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr*s zSurface.hovertextsrccCs ||d<dS)Nrr)rrrrrr*scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr*sz Surface.idscCs ||d<dS)Nrr)rrrrrr'*scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr-*s zSurface.idssrccCs ||d<dS)Nrr)rrrrrr;*scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrA*szSurface.legendgroupcCs ||d<dS)Nrr)rrrrrrR*scCs|dS)a The 'lighting' property is an instance of Lighting that may be specified as: - An instance of :class:`plotly.graph_objs.surface.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor Supported dict properties: ambient Ambient light increases overall color visibility but can wash out the image. diffuse Represents the extent that incident rays are reflected in a range of angles. fresnel Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine. roughness Alters specular reflection; the rougher the surface, the wider and less contrasty the shine. specular Represents the level that incident rays are reflected in a single direction, causing shine. Returns ------- plotly.graph_objs.surface.Lighting rr)rrrrrX*s"zSurface.lightingcCs ||d<dS)Nrr)rrrrrr|*scCs|dS)a$ The 'lightposition' property is an instance of Lightposition that may be specified as: - An instance of :class:`plotly.graph_objs.surface.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor Supported dict properties: x Numeric vector, representing the X coordinate for each vertex. y Numeric vector, representing the Y coordinate for each vertex. z Numeric vector, representing the Z coordinate for each vertex. Returns ------- plotly.graph_objs.surface.Lightposition rr)rrrrr*szSurface.lightpositioncCs ||d<dS)Nrr)rrrrrr*scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!*sz Surface.metacCs ||d<dS)Nr!r)rrrrrr!*scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"*s zSurface.metasrccCs ||d<dS)Nr"r)rrrrrr"*scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#*sz Surface.namecCs ||d<dS)Nr#r)rrrrrr#*scCs|dS)aS Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'*szSurface.opacitycCs ||d<dS)Nr'r)rrrrrr'*scCs|dS)aF Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr+szSurface.reversescalecCs ||d<dS)Nrr)rrrrrr+scCs|dS)a7 Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular subplot, of type 'scene', that may be specified as the string 'scene' optionally followed by an integer >= 1 (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- str rr)rrrrr+sz Surface.scenecCs ||d<dS)Nrr)rrrrrr++scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+1+s zSurface.showlegendcCs ||d<dS)Nr+r)rrrrrr+@+scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrF+s zSurface.showscalecCs ||d<dS)Nrr)rrrrrrU+scCs|dS)ah The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.surface.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.surface.Stream r,r)rrrrr,[+szSurface.streamcCs ||d<dS)Nr,r)rrrrrr,v+scCs|dS)a% Sets the surface color values, used for setting a color scale independent of `z`. The 'surfacecolor' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray surfacecolorr)rrrrr|+s zSurface.surfacecolorcCs ||d<dS)Nrr)rrrrrr+scCs|dS)z Sets the source reference on plot.ly for surfacecolor . The 'surfacecolorsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str surfacecolorsrcr)rrrrr+s zSurface.surfacecolorsrccCs ||d<dS)Nrr)rrrrrr+scCs|dS)a Sets the text elements associated with each z value. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-+sz Surface.textcCs ||d<dS)Nr-r)rrrrrr-+scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3+s zSurface.textsrccCs ||d<dS)Nr3r)rrrrrr3+scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7+sz Surface.uidcCs ||d<dS)Nr7r)rrrrrr7+scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8+szSurface.uirevisioncCs ||d<dS)Nr8r)rrrrrr8,scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9,szSurface.visiblecCs ||d<dS)Nr9r)rrrrrr9,scCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<,s z Surface.xcCs ||d<dS)Nr<r)rrrrrr<-,scCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any xcalendarr)rrrrr3,szSurface.xcalendarcCs ||d<dS)Nrr)rrrrrrE,scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?K,s z Surface.xsrccCs ||d<dS)Nr?r)rrrrrr?Y,scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@_,s z Surface.ycCs ||d<dS)Nr@r)rrrrrr@m,scCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any ycalendarr)rrrrrs,szSurface.ycalendarcCs ||d<dS)Nrr)rrrrrr,scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC,s z Surface.ysrccCs ||d<dS)NrCr)rrrrrrC,scCs|dS)z Sets the z coordinates. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr,s z Surface.zcCs ||d<dS)Nrr)rrrrrr,scCs|dS)a Sets the calendar system to use with `z` date data. The 'zcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any zcalendarr)rrrrr,szSurface.zcalendarcCs ||d<dS)Nrr)rrrrrr,scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr,s z Surface.zsrccCs ||d<dS)Nrr)rrrrrr,scCs |jdS)NrD)rE)rrrrrD,sz Surface.typecCsdS)NrFr)rrrrrG,szSurface._parent_path_strcCsdS)Na+ autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.surface.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. contours :class:`plotly.graph_objects.surface.Contours` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hidesurface Determines whether or not a surface is drawn. For example, set `hidesurface` to False `contours.x.show` to True and `contours.y.show` to True to draw a wire frame plot. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.surface.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.surface.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.surface.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.surface.Stream` instance or dict with compatible properties surfacecolor Sets the surface color values, used for setting a color scale independent of `z`. surfacecolorsrc Sets the source reference on plot.ly for surfacecolor . text Sets the text elements associated with each z value. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates. zcalendar Sets the calendar system to use with `z` date data. zsrc Sets the source reference on plot.ly for z . r)rrrrrH,sdzSurface._prop_descriptionsNc48 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|4 dd|_ ddl m }5|5|jd<|5|jd <|5|jd <|5|jd <|5|jd <|5|jd <|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5 |jd<|5!|jd<|5"|jd<|5#|jd<|5$|jd<|5%|jd<|5&|jd<|5'|jd <|5(|jd!<|5)|jd"<|5*|jd#<|5+|jd$<|5,|jd%<|5-|jd&<|5.|jd'<|5/|jd(<|50|jd)<|51|jd*<|52|jd+<|53|jd,<|54|jd-<|55|jd.<|56|jd/<|57|jd0<|58|jd1<|59|jd2<|5:|jd3<|5;|jd4<|5<|jd5<|5=|jd6<|5>|jd7<|5?|jd8<|5@|jd9<| dd}6|dk rB|n|6|d<| d d}6|dk rd|n|6|d <| d d}6|dk r|n|6|d <| d d}6|dk r|n|6|d <| d d}6|dk r|n|6|d <| d d}6|dk r|n|6|d <| dd}6|dk r|n|6|d<| dd}6| dk r0| n|6|d<| dd}6| dk rR| n|6|d<| dd}6| dk rt| n|6|d<| dd}6| dk r| n|6|d<| dd}6| dk r| n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r@|n|6|d<| dd}6|dk rb|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r |n|6|d<| dd}6|dk r.|n|6|d<| dd}6|dk rP|n|6|d<| d d}6|dk rr|n|6|d <| d!d}6|dk r|n|6|d!<| d"d}6|dk r|n|6|d"<| d#d}6|dk r|n|6|d#<| d$d}6|dk r|n|6|d$<| d%d}6|dk r|n|6|d%<| d&d}6| dk r>| n|6|d&<| d'd}6|!dk r`|!n|6|d'<| d(d}6|"dk r|"n|6|d(<| d)d}6|#dk r|#n|6|d)<| d*d}6|$dk r|$n|6|d*<| d+d}6|%dk r|%n|6|d+<| d,d}6|&dk r |&n|6|d,<| d-d}6|'dk r,|'n|6|d-<| d.d}6|(dk rN|(n|6|d.<| d/d}6|)dk rp|)n|6|d/<| d0d}6|*dk r|*n|6|d0<| d1d}6|+dk r|+n|6|d1<| d2d}6|,dk r|,n|6|d2<| d3d}6|-dk r|-n|6|d3<| d4d}6|.dk r|.n|6|d4<| d5d}6|/dk r<|/n|6|d5<| d6d}6|0dk r^|0n|6|d6<| d7d}6|1dk r|1n|6|d7<| d8d}6|2dk r|2n|6|d8<| d9d}6|3dk r|3n|6|d9<dd:lAmB}7d|jCd;<|7d;ddd<|jd;<| d;d|jDft|f|4d|_ dS)=a. Construct a new Surface object The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a 2D list. Coordinates in `x` and `y` can either be 1D lists or 2D lists (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the `z` values by default. For custom color scales, use `surfacecolor` which should be a 2D list, where its bounds can be controlled using `cmin` and `cmax`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Surface` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.surface.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. contours :class:`plotly.graph_objects.surface.Contours` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hidesurface Determines whether or not a surface is drawn. For example, set `hidesurface` to False `contours.x.show` to True and `contours.y.show` to True to draw a wire frame plot. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.surface.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.surface.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.surface.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.surface.Stream` instance or dict with compatible properties surfacecolor Sets the surface color values, used for setting a color scale independent of `z`. surfacecolorsrc Sets the source reference on plot.ly for surfacecolor . text Sets the text elements associated with each z value. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates. zcalendar Sets the calendar system to use with `z` date data. zsrc Sets the source reference on plot.ly for z . Returns ------- Surface rNzThe first argument to the plotly.graph_objs.Surface constructor must be a dict or an instance of :class:`plotly.graph_objs.Surface`rJFr)rrrrrrrrrrrr rrrrrrrrrrrrrrr!r"r#r'rrr+rr,rrr-r3r7r8r9r<rr?r@rrCrrr)rKrD)rLrMr)ErNrrOrPrQrRrSrTrUrVrWrXrYrrr[rrrrrrrConnectgapsValidatorContoursValidatorr`raZHidesurfaceValidatorrerfrgrhrirjrkrlrmrqrrrrrsrtrxrrr|rr}SurfacecolorValidatorZSurfacecolorsrcValidatorr~rrrrrXcalendarValidatorrrYcalendarValidatorrrZcalendarValidatorrrrKrEr)8rrrrrrrrrrrrr rrrrrrrrrrrrrrr!r"r#r'rrr+rr,rrr-r3r7r8r9r<rr?r@rrCrrrrZ v_surfacerrK)rQrrrO-sT0                                                          zSurface.__init__)3NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Zejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.ed~dZ/eddZ0dfdd Z1Z2S)SunburstcCs|dS)aM Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves. The 'branchvalues' property is an enumeration that may be specified as: - One of the following enumeration values: ['remainder', 'total'] Returns ------- Any rr)rrrrr/szSunburst.branchvaluescCs ||d<dS)Nrr)rrrrrr/scCs|dS)a Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0. The 'count' property is a flaglist and may be specified as a string containing: - Any combination of ['branches', 'leaves'] joined with '+' characters (e.g. 'branches+leaves') Returns ------- Any rr)rrrrr/szSunburst.countcCs ||d<dS)Nrr)rrrrrr/scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr 0szSunburst.customdatacCs ||d<dS)Nr r)rrrrrr 0scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr0s zSunburst.customdatasrccCs ||d<dS)Nrr)rrrrrr(0scCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this sunburst trace . row If there is a layout grid, use the domain for this row in the grid for this sunburst trace . x Sets the horizontal domain of this sunburst trace (in plot fraction). y Sets the vertical domain of this sunburst trace (in plot fraction). Returns ------- plotly.graph_objs.sunburst.Domain rr)rrrrr.0szSunburst.domaincCs ||d<dS)Nrr)rrrrrrM0scCs|dS)a Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrS0szSunburst.hoverinfocCs ||d<dS)Nrr)rrrrrrg0scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrm0s zSunburst.hoverinfosrccCs ||d<dS)Nrr)rrrrrr{0scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.sunburst.Hoverlabel rr)rrrrr0s3zSunburst.hoverlabelcCs ||d<dS)Nrr)rrrrrr0scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr0s"zSunburst.hovertemplatecCs ||d<dS)Nrr)rrrrrr0scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr0s zSunburst.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr0scCs|dS)aK Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr0szSunburst.hovertextcCs ||d<dS)Nrr)rrrrrr1scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr1s zSunburst.hovertextsrccCs ||d<dS)Nrr)rrrrrr"1scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr(1sz Sunburst.idscCs ||d<dS)Nrr)rrrrrr81scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr>1s zSunburst.idssrccCs ||d<dS)Nrr)rrrrrrL1scCs|dS)ax Sets the font used for `textinfo` lying inside the sector. The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.sunburst.Insidetextfont rr)rrrrrR1s/zSunburst.insidetextfontcCs ||d<dS)Nrr)rrrrrr1scCs|dS)a Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector. The 'insidetextorientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['horizontal', 'radial', 'tangential', 'auto'] Returns ------- Any insidetextorientationr)rrrrr"1szSunburst.insidetextorientationcCs ||d<dS)Nr"r)rrrrrr"1scCs|dS)z Sets the labels of each of the sectors. The 'labels' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr1s zSunburst.labelscCs ||d<dS)Nrr)rrrrrr1scCs|dS)z Sets the source reference on plot.ly for labels . The 'labelssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr1s zSunburst.labelssrccCs ||d<dS)Nrr)rrrrrr1scCs|dS)aI The 'leaf' property is an instance of Leaf that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Leaf` - A dict of string/value properties that will be passed to the Leaf constructor Supported dict properties: opacity Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7 Returns ------- plotly.graph_objs.sunburst.Leaf leafr)rrrrr#1sz Sunburst.leafcCs ||d<dS)Nr#r)rrrrrr#1scCs|dS)aw Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. The 'level' property accepts values of any type Returns ------- Any rr)rrrrr1szSunburst.levelcCs ||d<dS)Nrr)rrrrrr1scCs|dS)aC The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if colorsis set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if colorsis set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.sunburst.marker.Co lorBar` instance or dict with compatible properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors. colorscale Sets the colorscale. Has an effect only if colorsis set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorssrc Sets the source reference on plot.ly for colors . line :class:`plotly.graph_objects.sunburst.marker.Li ne` instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if colorsis set to a numerical array. Returns ------- plotly.graph_objs.sunburst.Marker rr)rrrrr1sgzSunburst.markercCs ||d<dS)Nrr)rrrrrrh2scCs|dS)aI Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy. The 'maxdepth' property is a integer and may be specified as: - An int (or float that will be cast to an int) Returns ------- int rr)rrrrrn2s zSunburst.maxdepthcCs ||d<dS)Nrr)rrrrrr}2scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!2sz Sunburst.metacCs ||d<dS)Nr!r)rrrrrr!2scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"2s zSunburst.metasrccCs ||d<dS)Nr"r)rrrrrr"2scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#2sz Sunburst.namecCs ||d<dS)Nr#r)rrrrrr#2scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'2s zSunburst.opacitycCs ||d<dS)Nr'r)rrrrrr'2scCs|dS)az Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used. The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.sunburst.Outsidetextfont r)r)rrrrr)2s3zSunburst.outsidetextfontcCs ||d<dS)Nr)r)rrrrrr)3scCs|dS)a' Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique. The 'parents' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr3szSunburst.parentscCs ||d<dS)Nrr)rrrrrr+3scCs|dS)z Sets the source reference on plot.ly for parents . The 'parentssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr13s zSunburst.parentssrccCs ||d<dS)Nrr)rrrrrr?3scCs|dS)aj The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.sunburst.Stream r,r)rrrrr,E3szSunburst.streamcCs ||d<dS)Nr,r)rrrrrr,`3scCs|dS)a Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-f3sz Sunburst.textcCs ||d<dS)Nr-r)rrrrrr-x3scCs|dS)aB Sets the font used for `textinfo`. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.sunburst.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.sunburst.Textfont r/r)rrrrr/~3s/zSunburst.textfontcCs ||d<dS)Nr/r)rrrrrr/3scCs|dS)a Determines which trace information appear on the graph. The 'textinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any r0r)rrrrr03szSunburst.textinfocCs ||d<dS)Nr0r)rrrrrr03scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr33s zSunburst.textsrccCs ||d<dS)Nr3r)rrrrrr33scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr43szSunburst.texttemplatecCs ||d<dS)Nr4r)rrrrrr43scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr54s zSunburst.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr54scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr74sz Sunburst.uidcCs ||d<dS)Nr7r)rrrrrr7)4scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8/4szSunburst.uirevisioncCs ||d<dS)Nr8r)rrrrrr8J4scCs|dS)aB Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed. The 'values' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrP4s zSunburst.valuescCs ||d<dS)Nrr)rrrrrr_4scCs|dS)z Sets the source reference on plot.ly for values . The 'valuessrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrre4s zSunburst.valuessrccCs ||d<dS)Nrr)rrrrrrs4scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9y4szSunburst.visiblecCs ||d<dS)Nr9r)rrrrrr94scCs |jdS)NrD)rE)rrrrrD4sz Sunburst.typecCsdS)NrFr)rrrrrG4szSunburst._parent_path_strcCsdS)Na* branchvalues Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves. count Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . domain :class:`plotly.graph_objects.sunburst.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.sunburst.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. insidetextorientation Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector. labels Sets the labels of each of the sectors. labelssrc Sets the source reference on plot.ly for labels . leaf :class:`plotly.graph_objects.sunburst.Leaf` instance or dict with compatible properties level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. marker :class:`plotly.graph_objects.sunburst.Marker` instance or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. outsidetextfont Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used. parents Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique. parentssrc Sets the source reference on plot.ly for parents . stream :class:`plotly.graph_objects.sunburst.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrH4sWzSunburst._prop_descriptionsNc+/ sptt|d|dkri}n4t||jr4|}nt|trJt|}nt d|+ dd|_ ddl m },|,|jd<|,|jd <|,|jd <|,|jd <|,|jd <|,|jd <|,|jd<|,|jd<|,|jd<|,|jd<|,|jd<|,|jd<|,|jd<|,|jd<|,|jd<|,|jd<|,|jd<|, |jd<|,!|jd<|,"|jd<|,#|jd<|,$|jd<|,%|jd<|,&|jd<|,'|jd <|,(|jd!<|,)|jd"<|,*|jd#<|,+|jd$<|,,|jd%<|,-|jd&<|,.|jd'<|,/|jd(<|,0|jd)<|,1|jd*<|,2|jd+<|,3|jd,<|,4|jd-<|,5|jd.<|,6|jd/<|,7|jd0<| dd}-|dk r|n|-|d<| d d}-|dk r|n|-|d <| d d}-|dk r|n|-|d <| d d}-|dk r*|n|-|d <| d d}-|dk rL|n|-|d <| d d}-|dk rn|n|-|d <| dd}-|dk r|n|-|d<| dd}-| dk r| n|-|d<| dd}-| dk r| n|-|d<| dd}-| dk r| n|-|d<| dd}-| dk r| n|-|d<| dd}-| dk r:| n|-|d<| dd}-|dk r\|n|-|d<| dd}-|dk r~|n|-|d<| dd}-|dk r|n|-|d<| dd}-|dk r|n|-|d<| dd}-|dk r|n|-|d<| dd}-|dk r|n|-|d<| dd}-|dk r(|n|-|d<| dd}-|dk rJ|n|-|d<| dd}-|dk rl|n|-|d<| dd}-|dk r|n|-|d<| dd}-|dk r|n|-|d<| dd}-|dk r|n|-|d<| d d}-|dk r|n|-|d <| d!d}-|dk r|n|-|d!<| d"d}-|dk r8|n|-|d"<| d#d}-|dk rZ|n|-|d#<| d$d}-|dk r||n|-|d$<| d%d}-|dk r|n|-|d%<| d&d}-| dk r| n|-|d&<| d'd}-|!dk r|!n|-|d'<| d(d}-|"dk r|"n|-|d(<| d)d}-|#dk r&|#n|-|d)<| d*d}-|$dk rH|$n|-|d*<| d+d}-|%dk rj|%n|-|d+<| d,d}-|&dk r|&n|-|d,<| d-d}-|'dk r|'n|-|d-<| d.d}-|(dk r|(n|-|d.<| d/d}-|)dk r|)n|-|d/<| d0d}-|*dk r|*n|-|d0<dd1l8m9}.d|j:d2<|.d2ddd3|jd2<| d2d|j;ft|f|+d|_ dS)4a], Construct a new Sunburst object Visualize hierarchal data spanning outward radially from root to leaves. The sunburst sectors are determined by the entries in "labels" or "ids" and in "parents". Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Sunburst` branchvalues Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves. count Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . domain :class:`plotly.graph_objects.sunburst.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.sunburst.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. insidetextorientation Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector. labels Sets the labels of each of the sectors. labelssrc Sets the source reference on plot.ly for labels . leaf :class:`plotly.graph_objects.sunburst.Leaf` instance or dict with compatible properties level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. marker :class:`plotly.graph_objects.sunburst.Marker` instance or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. outsidetextfont Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used. parents Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique. parentssrc Sets the source reference on plot.ly for parents . stream :class:`plotly.graph_objects.sunburst.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Sunburst sunburstNzThe first argument to the plotly.graph_objs.Sunburst constructor must be a dict or an instance of :class:`plotly.graph_objs.Sunburst`rJFr)r$rrr rrrrrrrrrrrrr"rrr#rrrr!r"r#r'r)rrr,r-r/r0r3r4r5r7r8rrr9)rKrD)rLrMr)Zejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6eddZ7eddZ8dfdd Z9Z:S) StreamtubecCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrB7szStreamtube.autocolorscalecCs ||d<dS)Nrr)rrrrrrU7scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. The 'cauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr[7szStreamtube.cautocCs ||d<dS)Nrr)rrrrrrl7scCs|dS)a7 Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well. The 'cmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrr7szStreamtube.cmaxcCs ||d<dS)Nrr)rrrrrr7scCs|dS)a} Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`. The 'cmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr7szStreamtube.cmidcCs ||d<dS)Nrr)rrrrrr7scCs|dS)a7 Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well. The 'cmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr7szStreamtube.cmincCs ||d<dS)Nrr)rrrrrr7scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrr7szStreamtube.coloraxiscCs ||d<dS)Nrr)rrrrrr7scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.streamtube.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.streamt ube.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.streamtube.colorbar.tickformatstopdefaults), sets the default property values to use for elements of streamtube.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.streamtube.colorba r.Title` instance or dict with compatible properties titlefont Deprecated: Please use streamtube.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use streamtube.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.streamtube.ColorBar rr)rrrrr7sdzStreamtube.colorbarcCs ||d<dS)Nrr)rrrrrr8scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrr8s,zStreamtube.colorscalecCs ||d<dS)Nrr)rrrrrr8scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr 8szStreamtube.customdatacCs ||d<dS)Nr r)rrrrrr 9scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr9s zStreamtube.customdatasrccCs ||d<dS)Nrr)rrrrrr9scCs|dS)a Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'divergence', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr9szStreamtube.hoverinfocCs ||d<dS)Nrr)rrrrrr.9scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr49s zStreamtube.hoverinfosrccCs ||d<dS)Nrr)rrrrrrB9scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.streamtube.Hoverlabel rr)rrrrrH9s3zStreamtube.hoverlabelcCs ||d<dS)Nrr)rrrrrr}9scCs|dS)a~ Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr9s"zStreamtube.hovertemplatecCs ||d<dS)Nrr)rrrrrr9scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr9s zStreamtube.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr9scCs|dS)z Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr9s zStreamtube.hovertextcCs ||d<dS)Nrr)rrrrrr9scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr9szStreamtube.idscCs ||d<dS)Nrr)rrrrrr9scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr9s zStreamtube.idssrccCs ||d<dS)Nrr)rrrrrr9scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr:szStreamtube.legendgroupcCs ||d<dS)Nrr)rrrrrr:scCs|dS)ao The 'lighting' property is an instance of Lighting that may be specified as: - An instance of :class:`plotly.graph_objs.streamtube.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor Supported dict properties: ambient Ambient light increases overall color visibility but can wash out the image. diffuse Represents the extent that incident rays are reflected in a range of angles. facenormalsepsilon Epsilon for face normals calculation avoids math issues arising from degenerate geometry. fresnel Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine. roughness Alters specular reflection; the rougher the surface, the wider and less contrasty the shine. specular Represents the level that incident rays are reflected in a single direction, causing shine. vertexnormalsepsilon Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry. Returns ------- plotly.graph_objs.streamtube.Lighting rr)rrrrr:s(zStreamtube.lightingcCs ||d<dS)Nrr)rrrrrrA:scCs|dS)a* The 'lightposition' property is an instance of Lightposition that may be specified as: - An instance of :class:`plotly.graph_objs.streamtube.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor Supported dict properties: x Numeric vector, representing the X coordinate for each vertex. y Numeric vector, representing the Y coordinate for each vertex. z Numeric vector, representing the Z coordinate for each vertex. Returns ------- plotly.graph_objs.streamtube.Lightposition rr)rrrrrG:szStreamtube.lightpositioncCs ||d<dS)Nrr)rrrrrrb:scCs|dS)a6 The maximum number of displayed segments in a streamtube. The 'maxdisplayed' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns ------- int maxdisplayedr)rrrrr'h:s zStreamtube.maxdisplayedcCs ||d<dS)Nr'r)rrrrrr'w:scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!}:szStreamtube.metacCs ||d<dS)Nr!r)rrrrrr!:scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr":s zStreamtube.metasrccCs ||d<dS)Nr"r)rrrrrr":scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#:szStreamtube.namecCs ||d<dS)Nr#r)rrrrrr#:scCs|dS)aS Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr':szStreamtube.opacitycCs ||d<dS)Nr'r)rrrrrr':scCs|dS)aF Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr:szStreamtube.reversescalecCs ||d<dS)Nrr)rrrrrr:scCs|dS)a7 Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular subplot, of type 'scene', that may be specified as the string 'scene' optionally followed by an integer >= 1 (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- str rr)rrrrr:szStreamtube.scenecCs ||d<dS)Nrr)rrrrrr;scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+ ;s zStreamtube.showlegendcCs ||d<dS)Nr+r)rrrrrr+;scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr ;s zStreamtube.showscalecCs ||d<dS)Nrr)rrrrrr/;scCs|dS)a` The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions. The 'sizeref' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float sizerefr)rrrrr(5;szStreamtube.sizerefcCs ||d<dS)Nr(r)rrrrrr(E;scCs|dS)a The 'starts' property is an instance of Starts that may be specified as: - An instance of :class:`plotly.graph_objs.streamtube.Starts` - A dict of string/value properties that will be passed to the Starts constructor Supported dict properties: x Sets the x components of the starting position of the streamtubes xsrc Sets the source reference on plot.ly for x . y Sets the y components of the starting position of the streamtubes ysrc Sets the source reference on plot.ly for y . z Sets the z components of the starting position of the streamtubes zsrc Sets the source reference on plot.ly for z . Returns ------- plotly.graph_objs.streamtube.Starts startsr)rrrrr)K;szStreamtube.startscCs ||d<dS)Nr)r)rrrrrr)l;scCs|dS)an The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.streamtube.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.streamtube.Stream r,r)rrrrr,r;szStreamtube.streamcCs ||d<dS)Nr,r)rrrrrr,;scCs|dS)a Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r-r)rrrrr-;szStreamtube.textcCs ||d<dS)Nr-r)rrrrrr-;scCs|dS)z Sets the x components of the vector field. The 'u' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray ur)rrrrr*;s z Streamtube.ucCs ||d<dS)Nr*r)rrrrrr*;scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7;szStreamtube.uidcCs ||d<dS)Nr7r)rrrrrr7;scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8;szStreamtube.uirevisioncCs ||d<dS)Nr8r)rrrrrr8;scCs|dS)z Sets the source reference on plot.ly for u . The 'usrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str usrcr)rrrrr+;s zStreamtube.usrccCs ||d<dS)Nr+r)rrrrrr+<scCs|dS)z Sets the y components of the vector field. The 'v' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray vr)rrrrr, <s z Streamtube.vcCs ||d<dS)Nr,r)rrrrrr,<scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9<szStreamtube.visiblecCs ||d<dS)Nr9r)rrrrrr9/<scCs|dS)z Sets the source reference on plot.ly for v . The 'vsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str vsrcr)rrrrr-5<s zStreamtube.vsrccCs ||d<dS)Nr-r)rrrrrr-C<scCs|dS)z Sets the z components of the vector field. The 'w' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray wr)rrrrr.I<s z Streamtube.wcCs ||d<dS)Nr.r)rrrrrr.W<scCs|dS)z Sets the source reference on plot.ly for w . The 'wsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str wsrcr)rrrrr/]<s zStreamtube.wsrccCs ||d<dS)Nr/r)rrrrrr/k<scCs|dS)z Sets the x coordinates of the vector field. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<q<s z Streamtube.xcCs ||d<dS)Nr<r)rrrrrr<<scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?<s zStreamtube.xsrccCs ||d<dS)Nr?r)rrrrrr?<scCs|dS)z Sets the y coordinates of the vector field. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@<s z Streamtube.ycCs ||d<dS)Nr@r)rrrrrr@<scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC<s zStreamtube.ysrccCs ||d<dS)NrCr)rrrrrrC<scCs|dS)z Sets the z coordinates of the vector field. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr<s z Streamtube.zcCs ||d<dS)Nrr)rrrrrr<scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr<s zStreamtube.zsrccCs ||d<dS)Nrr)rrrrrr<scCs |jdS)NrD)rE)rrrrrD<szStreamtube.typecCsdS)NrFr)rrrrrG<szStreamtube._parent_path_strcCsdS)Na$+ autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.streamtube.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.streamtube.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.streamtube.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.streamtube.Lightposition` instance or dict with compatible properties maxdisplayed The maximum number of displayed segments in a streamtube. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. sizeref The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions. starts :class:`plotly.graph_objects.streamtube.Starts` instance or dict with compatible properties stream :class:`plotly.graph_objects.streamtube.Stream` instance or dict with compatible properties text Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values. u Sets the x components of the vector field. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. usrc Sets the source reference on plot.ly for u . v Sets the y components of the vector field. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). vsrc Sets the source reference on plot.ly for v . w Sets the z components of the vector field. wsrc Sets the source reference on plot.ly for w . x Sets the x coordinates of the vector field. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates of the vector field. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates of the vector field. zsrc Sets the source reference on plot.ly for z . r)rrrrrH<sazStreamtube._prop_descriptionsNc37 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|3 dd|_ ddl m }4|4|jd<|4|jd <|4|jd <|4|jd <|4|jd <|4|jd <|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4 |jd<|4!|jd<|4"|jd<|4#|jd<|4$|jd<|4%|jd<|4&|jd<|4'|jd <|4(|jd!<|4)|jd"<|4*|jd#<|4+|jd$<|4,|jd%<|4-|jd&<|4.|jd'<|4/|jd(<|40|jd)<|41|jd*<|42|jd+<|43|jd,<|44|jd-<|45|jd.<|46|jd/<|47|jd0<|48|jd1<|49|jd2<|4:|jd3<|4;|jd4<|4<|jd5<|4=|jd6<|4>|jd7<|4?|jd8<| dd}5|dk r4|n|5|d<| d d}5|dk rV|n|5|d <| d d}5|dk rx|n|5|d <| d d}5|dk r|n|5|d <| d d}5|dk r|n|5|d <| d d}5|dk r|n|5|d <| dd}5|dk r|n|5|d<| dd}5| dk r"| n|5|d<| dd}5| dk rD| n|5|d<| dd}5| dk rf| n|5|d<| dd}5| dk r| n|5|d<| dd}5| dk r| n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r2|n|5|d<| dd}5|dk rT|n|5|d<| dd}5|dk rv|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r |n|5|d<| dd}5|dk rB|n|5|d<| d d}5|dk rd|n|5|d <| d!d}5|dk r|n|5|d!<| d"d}5|dk r|n|5|d"<| d#d}5|dk r|n|5|d#<| d$d}5|dk r|n|5|d$<| d%d}5|dk r|n|5|d%<| d&d}5| dk r0| n|5|d&<| d'd}5|!dk rR|!n|5|d'<| d(d}5|"dk rt|"n|5|d(<| d)d}5|#dk r|#n|5|d)<| d*d}5|$dk r|$n|5|d*<| d+d}5|%dk r|%n|5|d+<| d,d}5|&dk r|&n|5|d,<| d-d}5|'dk r|'n|5|d-<| d.d}5|(dk r@|(n|5|d.<| d/d}5|)dk rb|)n|5|d/<| d0d}5|*dk r|*n|5|d0<| d1d}5|+dk r|+n|5|d1<| d2d}5|,dk r|,n|5|d2<| d3d}5|-dk r|-n|5|d3<| d4d}5|.dk r |.n|5|d4<| d5d}5|/dk r.|/n|5|d5<| d6d}5|0dk rP|0n|5|d6<| d7d}5|1dk rr|1n|5|d7<| d8d}5|2dk r|2n|5|d8<dd9l@mA}6d|jBd:<|6d:ddd;|jd:<| d:d|jCft|f|3d|_ dS)` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.streamtube.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.streamtube.Lightposition` instance or dict with compatible properties maxdisplayed The maximum number of displayed segments in a streamtube. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. sizeref The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions. starts :class:`plotly.graph_objects.streamtube.Starts` instance or dict with compatible properties stream :class:`plotly.graph_objects.streamtube.Stream` instance or dict with compatible properties text Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values. u Sets the x components of the vector field. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. usrc Sets the source reference on plot.ly for u . v Sets the y components of the vector field. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). vsrc Sets the source reference on plot.ly for v . w Sets the z components of the vector field. wsrc Sets the source reference on plot.ly for w . x Sets the x coordinates of the vector field. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates of the vector field. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates of the vector field. zsrc Sets the source reference on plot.ly for z . Returns ------- Streamtube streamtubeNzThe first argument to the plotly.graph_objs.Streamtube constructor must be a dict or an instance of :class:`plotly.graph_objs.Streamtube`rJFr)r0rrrrrrrrr rrrrrrrrrrrrr'r!r"r#r'rrr+rr(r)r,r-r*r7r8r+r,r9r-r.r/r<r?r@rCrr)rKrD)rLrMr)DrNr&rOrPrQrRrSrTrUrVrWrXrYr0rr[rrrrrrrr`rarerfrgrhrirjrlrmrqrrZMaxdisplayedValidatorrrrsrtrxrrr|rSizerefValidatorZStartsValidatorr}r~ UValidatorrr UsrcValidator VValidatorr VsrcValidator WValidator WsrcValidatorrrrrrrrrKrEr)7rrrrrrrrrrr rrrrrrrrrrrrr'r!r"r#r'rrr+rr(r)r,r-r*r7r8r+r,r9r-r.r/r<r?r@rCrrrZ v_streamtuberrK)rQrrrO=sN,                                                         zStreamtube.__init__)2NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN);rrrrrrrrrrrrrr rrrrrrrrrrrrr'r!r"r#r'rrr+rr(r)r,r-r*r7r8r+r,r9r-r.r/r<r?r@rCrrrDrGrHrOrrr)rQrr&>7s2       f .     5 $      *            !                    er&c#seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'edidjZ(edkdlZ)dpfdndo Z*Z+S)qSplomcCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr ?szSplom.customdatacCs ||d<dS)Nr r)rrrrrr ?scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr?s zSplom.customdatasrccCs ||d<dS)Nrr)rrrrrr?scCs|dS)a The 'diagonal' property is an instance of Diagonal that may be specified as: - An instance of :class:`plotly.graph_objs.splom.Diagonal` - A dict of string/value properties that will be passed to the Diagonal constructor Supported dict properties: visible Determines whether or not subplots on the diagonal are displayed. Returns ------- plotly.graph_objs.splom.Diagonal diagonalr)rrrrr9?szSplom.diagonalcCs ||d<dS)Nr9r)rrrrrr9@scCs|dS)a The 'dimensions' property is a tuple of instances of Dimension that may be specified as: - A list or tuple of instances of plotly.graph_objs.splom.Dimension - A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor Supported dict properties: axis :class:`plotly.graph_objects.splom.dimension.Ax is` instance or dict with compatible properties label Sets the label corresponding to this splom dimension. name When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. values Sets the dimension values to be plotted. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this dimension is shown on the graph. Note that even visible false dimension contribute to the default grid generate by this splom trace. Returns ------- tuple[plotly.graph_objs.splom.Dimension] dimensionsr)rrrrr:@s5zSplom.dimensionscCs ||d<dS)Nr:r)rrrrrr:N@scCs|dS)aI When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - An instance of :class:`plotly.graph_objs.splom.Dimension` - A dict of string/value properties that will be passed to the Dimension constructor Supported dict properties: Returns ------- plotly.graph_objs.splom.Dimension dimensiondefaultsr)rrrrr;T@szSplom.dimensiondefaultscCs ||d<dS)Nr;r)rrrrrr;i@scCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrro@szSplom.hoverinfocCs ||d<dS)Nrr)rrrrrr@scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr@s zSplom.hoverinfosrccCs ||d<dS)Nrr)rrrrrr@scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.splom.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.splom.Hoverlabel rr)rrrrr@s3zSplom.hoverlabelcCs ||d<dS)Nrr)rrrrrr@scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr@s!zSplom.hovertemplatecCs ||d<dS)Nrr)rrrrrr@scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrAs zSplom.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrAscCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrAszSplom.hovertextcCs ||d<dS)Nrr)rrrrrr%AscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr+As zSplom.hovertextsrccCs ||d<dS)Nrr)rrrrrr9AscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr?Asz Splom.idscCs ||d<dS)Nrr)rrrrrrOAscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrUAs z Splom.idssrccCs ||d<dS)Nrr)rrrrrrcAscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrriAszSplom.legendgroupcCs ||d<dS)Nrr)rrrrrrzAscCs|dS)av The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.splom.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.splom.marker.Color Bar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . line :class:`plotly.graph_objects.splom.marker.Line` instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.splom.Marker rr)rrrrrAs z Splom.markercCs ||d<dS)Nrr)rrrrrr BscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!Bsz Splom.metacCs ||d<dS)Nr!r)rrrrrr!)BscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"/Bs z Splom.metasrccCs ||d<dS)Nr"r)rrrrrr"=BscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#CBsz Splom.namecCs ||d<dS)Nr#r)rrrrrr#SBscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'YBs z Splom.opacitycCs ||d<dS)Nr'r)rrrrrr'gBscCs|dS)aP The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.splom.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.splom.selected.Mar ker` instance or dict with compatible properties Returns ------- plotly.graph_objs.splom.Selected rr)rrrrrmBszSplom.selectedcCs ||d<dS)Nrr)rrrrrrBscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*BszSplom.selectedpointscCs ||d<dS)Nr*r)rrrrrr*BscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+Bs zSplom.showlegendcCs ||d<dS)Nr+r)rrrrrr+BscCs|dS)a Determines whether or not subplots on the lower half from the diagonal are displayed. The 'showlowerhalf' property must be specified as a bool (either True, or False) Returns ------- bool showlowerhalfr)rrrrr<Bs zSplom.showlowerhalfcCs ||d<dS)Nr<r)rrrrrr<BscCs|dS)a Determines whether or not subplots on the upper half from the diagonal are displayed. The 'showupperhalf' property must be specified as a bool (either True, or False) Returns ------- bool showupperhalfr)rrrrr=Bs zSplom.showupperhalfcCs ||d<dS)Nr=r)rrrrrr=BscCs|dS)ad The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.splom.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.splom.Stream r,r)rrrrr,Bsz Splom.streamcCs ||d<dS)Nr,r)rrrrrr,BscCs|dS)a( Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-Csz Splom.textcCs ||d<dS)Nr-r)rrrrrr-CscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3Cs z Splom.textsrccCs ||d<dS)Nr3r)rrrrrr3(CscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7.Csz Splom.uidcCs ||d<dS)Nr7r)rrrrrr7>CscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8DCszSplom.uirevisioncCs ||d<dS)Nr8r)rrrrrr8_CscCs|dS)a\ The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.splom.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.splom.unselected.M arker` instance or dict with compatible properties Returns ------- plotly.graph_objs.splom.Unselected rr)rrrrreCszSplom.unselectedcCs ||d<dS)Nrr)rrrrrr{CscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9Csz Splom.visiblecCs ||d<dS)Nr9r)rrrrrr9CscCs|dS)a  Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis. The 'xaxes' property is an info array that may be specified as: * a list of elements where: The 'xaxes[i]' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- list xaxesr)rrrrr>Csz Splom.xaxescCs ||d<dS)Nr>r)rrrrrr>CscCs|dS)a  Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis. The 'yaxes' property is an info array that may be specified as: * a list of elements where: The 'yaxes[i]' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- list yaxesr)rrrrr?Csz Splom.yaxescCs ||d<dS)Nr?r)rrrrrr?CscCs |jdS)NrD)rE)rrrrrDCsz Splom.typecCsdS)NrFr)rrrrrGCszSplom._parent_path_strcCsdS)Na"! customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . diagonal :class:`plotly.graph_objects.splom.Diagonal` instance or dict with compatible properties dimensions A tuple of :class:`plotly.graph_objects.splom.Dimension` instances or dicts with compatible properties dimensiondefaults When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.splom.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.splom.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.splom.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showlowerhalf Determines whether or not subplots on the lower half from the diagonal are displayed. showupperhalf Determines whether or not subplots on the upper half from the diagonal are displayed. stream :class:`plotly.graph_objects.splom.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.splom.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). xaxes Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis. yaxes Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis. r)rrrrrHCs,zSplom._prop_descriptionsNc$( s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|$ dd|_ ddl m }%|%|jd<|%|jd <|%|jd <|%|jd <|%|jd <|%|jd <|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|% |jd<|%!|jd<|%"|jd<|%#|jd<|%$|jd<|%%|jd<|%&|jd<|%'|jd <|%(|jd!<|%)|jd"<|%*|jd#<|%+|jd$<|%,|jd%<|%-|jd&<|%.|jd'<|%/|jd(<|%0|jd)<| dd}&|dk rb|n|&|d<| d d}&|dk r|n|&|d <| d d}&|dk r|n|&|d <| d d}&|dk r|n|&|d <| d d}&|dk r|n|&|d <| d d}&|dk r |n|&|d <| dd}&|dk r.|n|&|d<| dd}&| dk rP| n|&|d<| dd}&| dk rr| n|&|d<| dd}&| dk r| n|&|d<| dd}&| dk r| n|&|d<| dd}&| dk r| n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r>|n|&|d<| dd}&|dk r`|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r |n|&|d<| dd}&|dk r,|n|&|d<| dd}&|dk rN|n|&|d<| dd}&|dk rp|n|&|d<| d d}&|dk r|n|&|d <| d!d}&|dk r|n|&|d!<| d"d}&|dk r|n|&|d"<| d#d}&|dk r|n|&|d#<| d$d}&|dk r|n|&|d$<| d%d}&|dk r<|n|&|d%<| d&d}&| dk r^| n|&|d&<| d'd}&|!dk r|!n|&|d'<| d(d}&|"dk r|"n|&|d(<| d)d}&|#dk r|#n|&|d)<dd*l1m2}'d|j3d+<|'d+ddd,|jd+<| d+d|j4ft|f|$d|_ dS)-a# Construct a new Splom object Splom traces generate scatter plot matrix visualizations. Each splom `dimensions` items correspond to a generated axis. Values for each of those dimensions are set in `dimensions[i].values`. Splom traces support all `scattergl` marker style attributes. Specify `layout.grid` attributes and/or layout x-axis and y-axis attributes for more control over the axis positioning and style. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Splom` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . diagonal :class:`plotly.graph_objects.splom.Diagonal` instance or dict with compatible properties dimensions A tuple of :class:`plotly.graph_objects.splom.Dimension` instances or dicts with compatible properties dimensiondefaults When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.splom.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.splom.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.splom.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showlowerhalf Determines whether or not subplots on the lower half from the diagonal are displayed. showupperhalf Determines whether or not subplots on the upper half from the diagonal are displayed. stream :class:`plotly.graph_objects.splom.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.splom.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). xaxes Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis. yaxes Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis. Returns ------- Splom splomNzThe first argument to the plotly.graph_objs.Splom constructor must be a dict or an instance of :class:`plotly.graph_objs.Splom`rJFr)r@r rr9r:r;rrrrrrrrrrrr!r"r#r'rr*r+r<r=r,r-r3r7r8rr9r>r?)rKrD)rLrMr)5rNr8rOrPrQrRrSrTrUrVrWrXrYr@r`r[raZDiagonalValidatorDimensionsValidatorDimensionValidatorrerfrgrhrirjrkrlrmrqrrrrsrtrxrr{r|ZShowlowerhalfValidatorZShowupperhalfValidatorr}r~rrrrrZXaxesValidatorZYaxesValidatorrrKrEr)(rrr rr9r:r;rrrrrrrrrrrr!r"r#r'rr*r+r<r=r,r-r3r7r8rr9r>r?rZv_splomrrK)rQrrrODse                                          zSplom.__init__)#NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN),rrrrr rrr9r:r;rrrrrrrrrrrr!r"r#r'rr*r+r<r=r,r-r3r7r8rr9r>r?rDrGrHrOrrr)rQrr8?s    7    5 #                            0r8c0seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4eddZ5eddZ6dfdd Z7Z8S)ScatterternarycCs|dS)a Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. The 'a' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray ar)rrrrrDFszScatterternary.acCs ||d<dS)NrDr)rrrrrrD%FscCs|dS)z Sets the source reference on plot.ly for a . The 'asrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str asrcr)rrrrrE+Fs zScatterternary.asrccCs ||d<dS)NrEr)rrrrrrE9FscCs|dS)a Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. The 'b' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray br)rrrrrF?FszScatterternary.bcCs ||d<dS)NrFr)rrrrrrFPFscCs|dS)z Sets the source reference on plot.ly for b . The 'bsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str bsrcr)rrrrrGVFs zScatterternary.bsrccCs ||d<dS)NrGr)rrrrrrGdFscCs|dS)a Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. The 'c' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray cr)rrrrrHjFszScatterternary.ccCs ||d<dS)NrHr)rrrrrrH{FscCs|dS)a Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. The 'cliponaxis' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr FszScatterternary.cliponaxiscCs ||d<dS)Nr r)rrrrrr FscCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrFs zScatterternary.connectgapscCs ||d<dS)Nrr)rrrrrrFscCs|dS)z Sets the source reference on plot.ly for c . The 'csrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str csrcr)rrrrrIFs zScatterternary.csrccCs ||d<dS)NrIr)rrrrrrIFscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr FszScatterternary.customdatacCs ||d<dS)Nr r)rrrrrr FscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrFs zScatterternary.customdatasrccCs ||d<dS)Nrr)rrrrrrFscCs|dS)a Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. The 'fill' property is an enumeration that may be specified as: - One of the following enumeration values: ['none', 'toself', 'tonext'] Returns ------- Any fillr)rrrrrJFszScatterternary.fillcCs ||d<dS)NrJr)rrrrrrJGscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrr Gs5zScatterternary.fillcolorcCs ||d<dS)Nrr)rrrrrr@GscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['a', 'b', 'c', 'text', 'name'] joined with '+' characters (e.g. 'a+b') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrFGszScatterternary.hoverinfocCs ||d<dS)Nrr)rrrrrrZGscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr`Gs zScatterternary.hoverinfosrccCs ||d<dS)Nrr)rrrrrrnGscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scatterternary.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scatterternary.Hoverlabel rr)rrrrrtGs3zScatterternary.hoverlabelcCs ||d<dS)Nrr)rrrrrrGscCs|dS)a Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". The 'hoveron' property is a flaglist and may be specified as a string containing: - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns ------- Any rr)rrrrrGszScatterternary.hoveroncCs ||d<dS)Nrr)rrrrrrGscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrGs!zScatterternary.hovertemplatecCs ||d<dS)Nrr)rrrrrrGscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrGs zScatterternary.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrGscCs|dS)ab Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrHszScatterternary.hovertextcCs ||d<dS)Nrr)rrrrrrHscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrHs zScatterternary.hovertextsrccCs ||d<dS)Nrr)rrrrrr-HscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr3HszScatterternary.idscCs ||d<dS)Nrr)rrrrrrCHscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrIHs zScatterternary.idssrccCs ||d<dS)Nrr)rrrrrrWHscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr]HszScatterternary.legendgroupcCs ||d<dS)Nrr)rrrrrrnHscCs|dS)a, The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scatterternary.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). shape Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. smoothing Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a "linear" shape). width Sets the line width (in px). Returns ------- plotly.graph_objs.scatterternary.Line rr)rrrrrtHs#zScatterternary.linecCs ||d<dS)Nrr)rrrrrrHscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scatterternary.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scatterternary.mar ker.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . gradient :class:`plotly.graph_objects.scatterternary.mar ker.Gradient` instance or dict with compatible properties line :class:`plotly.graph_objects.scatterternary.mar ker.Line` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scatterternary.Marker rr)rrrrrHszScatterternary.markercCs ||d<dS)Nrr)rrrrrr4IscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!:IszScatterternary.metacCs ||d<dS)Nr!r)rrrrrr!PIscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"VIs zScatterternary.metasrccCs ||d<dS)Nr"r)rrrrrr"dIscCs|dS)a Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any moder)rrrrrKjIszScatterternary.modecCs ||d<dS)NrKr)rrrrrrKIscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#IszScatterternary.namecCs ||d<dS)Nr#r)rrrrrr#IscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'Is zScatterternary.opacitycCs ||d<dS)Nr'r)rrrrrr'IscCs|dS)a, The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scatterternary.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatterternary.sel ected.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatterternary.sel ected.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatterternary.Selected rr)rrrrrIszScatterternary.selectedcCs ||d<dS)Nrr)rrrrrrIscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*IszScatterternary.selectedpointscCs ||d<dS)Nr*r)rrrrrr*IscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+Is zScatterternary.showlegendcCs ||d<dS)Nr+r)rrrrrr+IscCs|dS)av The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scatterternary.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scatterternary.Stream r,r)rrrrr,IszScatterternary.streamcCs ||d<dS)Nr,r)rrrrrr,JscCs|dS)a2 Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default value), the data refer to `layout.ternary`. If "ternary2", the data refer to `layout.ternary2`, and so on. The 'subplot' property is an identifier of a particular subplot, of type 'ternary', that may be specified as the string 'ternary' optionally followed by an integer >= 1 (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.) Returns ------- str subplotr)rrrrrLJszScatterternary.subplotcCs ||d<dS)NrLr)rrrrrrL1JscCs|dS)a The number each triplet should sum to, if only two of `a`, `b`, and `c` are provided. This overrides `ternary.sum` to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary.sum The 'sum' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float sumr)rrrrrM7JszScatterternary.sumcCs ||d<dS)NrMr)rrrrrrMIJscCs|dS)a Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-OJszScatterternary.textcCs ||d<dS)Nr-r)rrrrrr-dJscCs|dS)a? Sets the text font. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scatterternary.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.scatterternary.Textfont r/r)rrrrr/jJs/zScatterternary.textfontcCs ||d<dS)Nr/r)rrrrrr/JscCs|dS)a/ Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1JszScatterternary.textpositioncCs ||d<dS)Nr1r)rrrrrr1JscCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2Js zScatterternary.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2JscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3Js zScatterternary.textsrccCs ||d<dS)Nr3r)rrrrrr3JscCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b`, `c` and `text`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4JszScatterternary.texttemplatecCs ||d<dS)Nr4r)rrrrrr4JscCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5Ks zScatterternary.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5KscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7KszScatterternary.uidcCs ||d<dS)Nr7r)rrrrrr7)KscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8/KszScatterternary.uirevisioncCs ||d<dS)Nr8r)rrrrrr8JKscCs|dS)a: The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.scatterternary.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatterternary.uns elected.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatterternary.uns elected.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatterternary.Unselected rr)rrrrrPKszScatterternary.unselectedcCs ||d<dS)Nrr)rrrrrrjKscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9pKszScatterternary.visiblecCs ||d<dS)Nr9r)rrrrrr9KscCs |jdS)NrD)rE)rrrrrDKszScatterternary.typecCsdS)NrFr)rrrrrGKszScatterternary._parent_path_strcCsdS)Na1 a Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. asrc Sets the source reference on plot.ly for a . b Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. bsrc Sets the source reference on plot.ly for b . c Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. cliponaxis Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. csrc Sets the source reference on plot.ly for c . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . fill Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatterternary.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatterternary.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatterternary.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scatterternary.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatterternary.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default value), the data refer to `layout.ternary`. If "ternary2", the data refer to `layout.ternary2`, and so on. sum The number each triplet should sum to, if only two of `a`, `b`, and `c` are provided. This overrides `ternary.sum` to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary.sum text Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b`, `c` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatterternary.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHKsyz!Scatterternary._prop_descriptionsNc15 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|1 dd|_ ddl m }2|2|jd<|2|jd <|2|jd <|2|jd <|2|jd <|2|jd <|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2 |jd<|2!|jd<|2"|jd<|2#|jd<|2$|jd<|2%|jd<|2&|jd<|2'|jd <|2(|jd!<|2)|jd"<|2*|jd#<|2+|jd$<|2,|jd%<|2-|jd&<|2.|jd'<|2/|jd(<|20|jd)<|21|jd*<|22|jd+<|23|jd,<|24|jd-<|25|jd.<|26|jd/<|27|jd0<|28|jd1<|29|jd2<|2:|jd3<|2;|jd4<|2<|jd5<|2=|jd6<| dd}3|dk r|n|3|d<| d d}3|dk r:|n|3|d <| d d}3|dk r\|n|3|d <| d d}3|dk r~|n|3|d <| d d}3|dk r|n|3|d <| d d}3|dk r|n|3|d <| dd}3|dk r|n|3|d<| dd}3| dk r| n|3|d<| dd}3| dk r(| n|3|d<| dd}3| dk rJ| n|3|d<| dd}3| dk rl| n|3|d<| dd}3| dk r| n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r8|n|3|d<| dd}3|dk rZ|n|3|d<| dd}3|dk r||n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r&|n|3|d<| d d}3|dk rH|n|3|d <| d!d}3|dk rj|n|3|d!<| d"d}3|dk r|n|3|d"<| d#d}3|dk r|n|3|d#<| d$d}3|dk r|n|3|d$<| d%d}3|dk r|n|3|d%<| d&d}3| dk r| n|3|d&<| d'd}3|!dk r6|!n|3|d'<| d(d}3|"dk rX|"n|3|d(<| d)d}3|#dk rz|#n|3|d)<| d*d}3|$dk r|$n|3|d*<| d+d}3|%dk r|%n|3|d+<| d,d}3|&dk r|&n|3|d,<| d-d}3|'dk r|'n|3|d-<| d.d}3|(dk r$|(n|3|d.<| d/d}3|)dk rF|)n|3|d/<| d0d}3|*dk rh|*n|3|d0<| d1d}3|+dk r|+n|3|d1<| d2d}3|,dk r|,n|3|d2<| d3d}3|-dk r|-n|3|d3<| d4d}3|.dk r|.n|3|d4<| d5d}3|/dk r|/n|3|d5<| d6d}3|0dk r4|0n|3|d6<dd7l>m?}4d|j@d8<|4d8ddd9|jd8<| d8d|jAft|f|1d|_ dS):a3 Construct a new Scatterternary object Provides similar functionality to the "scatter" type but on a ternary phase diagram. The data is provided by at least two arrays out of `a`, `b`, `c` triplets. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Scatterternary` a Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. asrc Sets the source reference on plot.ly for a . b Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. bsrc Sets the source reference on plot.ly for b . c Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`. cliponaxis Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. csrc Sets the source reference on plot.ly for c . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . fill Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatterternary.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatterternary.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatterternary.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scatterternary.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatterternary.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default value), the data refer to `layout.ternary`. If "ternary2", the data refer to `layout.ternary2`, and so on. sum The number each triplet should sum to, if only two of `a`, `b`, and `c` are provided. This overrides `ternary.sum` to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary.sum text Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b`, `c` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatterternary.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Scatterternary scatterternaryNzThe first argument to the plotly.graph_objs.Scatterternary constructor must be a dict or an instance of :class:`plotly.graph_objs.Scatterternary`rJFr)rNrDrErFrGrHr rrIr rrJrrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,rLrMr-r/r1r2r3r4r5r7r8rr9)rKrD)rLrMr)BrNrCrOrPrQrRrSrTrUrVrWrXrYrN AValidatorr[ AsrcValidator BValidator BsrcValidatorZ CValidatorr]rZ CsrcValidatorr`ra FillValidatorrrerfrgrrhrirjrkrlrmrqrrrrrs ModeValidatorrtrxrr{r|r}SubplotValidatorZ SumValidatorr~rrrrrrrrrrrrKrEr)5rrrDrErFrGrHr rrIr rrJrrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,rLrMr-r/r1r2r3r4r5r7r8rr9rZv_scatterternaryrrK)rQrrrOLsB=                                                       zScatterternary.__init__)0NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)9rrrrrDrrErFrGrHr rrIr rrJrrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,rLrMr-r/r1r2r3r4r5r7r8rr9rDrGrHrOrrr)rQrrCFs&            7   5  #       %              1            }rCc0seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4eddZ5eddZ6dfdd Z7Z8S)ScatterpolarglcCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrNs zScatterpolargl.connectgapscCs ||d<dS)Nrr)rrrrrrNscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr NszScatterpolargl.customdatacCs ||d<dS)Nr r)rrrrrr NscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrNs zScatterpolargl.customdatasrccCs ||d<dS)Nrr)rrrrrrNscCs|dS)z Sets the r coordinate step. The 'dr' property is a number and may be specified as: - An int or float Returns ------- int|float drr)rrrrrWNs zScatterpolargl.drcCs ||d<dS)NrWr)rrrrrrWNscCs|dS)a@ Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates. The 'dtheta' property is a number and may be specified as: - An int or float Returns ------- int|float dthetar)rrrrrXNszScatterpolargl.dthetacCs ||d<dS)NrXr)rrrrrrXNscCs|dS)a" Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill- linked traces are not already consecutive, the later ones will be pushed down in the drawing order. The 'fill' property is an enumeration that may be specified as: - One of the following enumeration values: ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', 'toself', 'tonext'] Returns ------- Any rJr)rrrrrJOs zScatterpolargl.fillcCs ||d<dS)NrJr)rrrrrrJ$OscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrr*Os5zScatterpolargl.fillcolorcCs ||d<dS)Nrr)rrrrrraOscCs|dS)ac Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters (e.g. 'r+theta') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrgOszScatterpolargl.hoverinfocCs ||d<dS)Nrr)rrrrrr{OscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrOs zScatterpolargl.hoverinfosrccCs ||d<dS)Nrr)rrrrrrOscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolargl.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scatterpolargl.Hoverlabel rr)rrrrrOs3zScatterpolargl.hoverlabelcCs ||d<dS)Nrr)rrrrrrOscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrOs!zScatterpolargl.hovertemplatecCs ||d<dS)Nrr)rrrrrrOscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrOs zScatterpolargl.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrPscCs|dS)ab Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr PszScatterpolargl.hovertextcCs ||d<dS)Nrr)rrrrrr!PscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr'Ps zScatterpolargl.hovertextsrccCs ||d<dS)Nrr)rrrrrr5PscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr;PszScatterpolargl.idscCs ||d<dS)Nrr)rrrrrrKPscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrQPs zScatterpolargl.idssrccCs ||d<dS)Nrr)rrrrrr_PscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrePszScatterpolargl.legendgroupcCs ||d<dS)Nrr)rrrrrrvPscCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolargl.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. dash Sets the style of the lines. shape Determines the line shape. The values correspond to step-wise line shapes. width Sets the line width (in px). Returns ------- plotly.graph_objs.scatterpolargl.Line rr)rrrrr|PszScatterpolargl.linecCs ||d<dS)Nrr)rrrrrrPscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolargl.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scatterpolargl.mar ker.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . line :class:`plotly.graph_objects.scatterpolargl.mar ker.Line` instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scatterpolargl.Marker rr)rrrrrPs zScatterpolargl.markercCs ||d<dS)Nrr)rrrrrr+QscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!1QszScatterpolargl.metacCs ||d<dS)Nr!r)rrrrrr!GQscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"MQs zScatterpolargl.metasrccCs ||d<dS)Nr"r)rrrrrr"[QscCs|dS)a Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrKaQszScatterpolargl.modecCs ||d<dS)NrKr)rrrrrrKwQscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#}QszScatterpolargl.namecCs ||d<dS)Nr#r)rrrrrr#QscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'Qs zScatterpolargl.opacitycCs ||d<dS)Nr'r)rrrrrr'QscCs|dS)z Sets the radial coordinates The 'r' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrYQs zScatterpolargl.rcCs ||d<dS)NrYr)rrrrrrYQscCs|dS)a  Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. The 'r0' property accepts values of any type Returns ------- Any r0r)rrrrrZQs zScatterpolargl.r0cCs ||d<dS)NrZr)rrrrrrZQscCs|dS)z Sets the source reference on plot.ly for r . The 'rsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rsrcr)rrrrr[Qs zScatterpolargl.rsrccCs ||d<dS)Nr[r)rrrrrr[QscCs|dS)a, The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolargl.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatterpolargl.sel ected.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatterpolargl.sel ected.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatterpolargl.Selected rr)rrrrrQszScatterpolargl.selectedcCs ||d<dS)Nrr)rrrrrrQscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*RszScatterpolargl.selectedpointscCs ||d<dS)Nr*r)rrrrrr*RscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+Rs zScatterpolargl.showlegendcCs ||d<dS)Nr+r)rrrrrr++RscCs|dS)av The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolargl.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scatterpolargl.Stream r,r)rrrrr,1RszScatterpolargl.streamcCs ||d<dS)Nr,r)rrrrrr,LRscCs|dS)a Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. The 'subplot' property is an identifier of a particular subplot, of type 'polar', that may be specified as the string 'polar' optionally followed by an integer >= 1 (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) Returns ------- str rLr)rrrrrLRRszScatterpolargl.subplotcCs ||d<dS)NrLr)rrrrrrLeRscCs|dS)a Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-kRszScatterpolargl.textcCs ||d<dS)Nr-r)rrrrrr-RscCs|dS)a? Sets the text font. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolargl.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.scatterpolargl.Textfont r/r)rrrrr/Rs/zScatterpolargl.textfontcCs ||d<dS)Nr/r)rrrrrr/RscCs|dS)a/ Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1RszScatterpolargl.textpositioncCs ||d<dS)Nr1r)rrrrrr1RscCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2Rs zScatterpolargl.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2RscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3Rs zScatterpolargl.textsrccCs ||d<dS)Nr3r)rrrrrr3RscCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4RszScatterpolargl.texttemplatecCs ||d<dS)Nr4r)rrrrrr4SscCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5!Ss zScatterpolargl.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5/SscCs|dS)z Sets the angular coordinates The 'theta' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray thetar)rrrrr\5Ss zScatterpolargl.thetacCs ||d<dS)Nr\r)rrrrrr\CSscCs|dS)a! Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. The 'theta0' property accepts values of any type Returns ------- Any theta0r)rrrrr]ISs zScatterpolargl.theta0cCs ||d<dS)Nr]r)rrrrrr]XSscCs|dS)z Sets the source reference on plot.ly for theta . The 'thetasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str thetasrcr)rrrrr^^Ss zScatterpolargl.thetasrccCs ||d<dS)Nr^r)rrrrrr^lSscCs|dS)aY Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. The 'thetaunit' property is an enumeration that may be specified as: - One of the following enumeration values: ['radians', 'degrees', 'gradians'] Returns ------- Any thetaunitr)rrrrr_rSszScatterpolargl.thetaunitcCs ||d<dS)Nr_r)rrrrrr_SscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7SszScatterpolargl.uidcCs ||d<dS)Nr7r)rrrrrr7SscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8SszScatterpolargl.uirevisioncCs ||d<dS)Nr8r)rrrrrr8SscCs|dS)a: The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolargl.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatterpolargl.uns elected.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatterpolargl.uns elected.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatterpolargl.Unselected rr)rrrrrSszScatterpolargl.unselectedcCs ||d<dS)Nrr)rrrrrrSscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9SszScatterpolargl.visiblecCs ||d<dS)Nr9r)rrrrrr9SscCs |jdS)NrD)rE)rrrrrDSszScatterpolargl.typecCsdS)NrFr)rrrrrGSszScatterpolargl._parent_path_strcCsdS)Na/ connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dr Sets the r coordinate step. dtheta Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates. fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatterpolargl.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatterpolargl.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. r Sets the radial coordinates r0 Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.scatterpolargl.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatterpolargl.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . theta Sets the angular coordinates theta0 Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. thetasrc Sets the source reference on plot.ly for theta . thetaunit Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatterpolargl.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHTssz!Scatterpolargl._prop_descriptionsNc15 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|1 dd|_ ddl m }2|2|jd<|2|jd <|2|jd <|2|jd <|2|jd <|2|jd <|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2 |jd<|2!|jd<|2"|jd<|2#|jd<|2$|jd<|2%|jd<|2&|jd<|2'|jd <|2(|jd!<|2)|jd"<|2*|jd#<|2+|jd$<|2,|jd%<|2-|jd&<|2.|jd'<|2/|jd(<|20|jd)<|21|jd*<|22|jd+<|23|jd,<|24|jd-<|25|jd.<|26|jd/<|27|jd0<|28|jd1<|29|jd2<|2:|jd3<|2;|jd4<|2<|jd5<|2=|jd6<| dd}3|dk r|n|3|d<| d d}3|dk r:|n|3|d <| d d}3|dk r\|n|3|d <| d d}3|dk r~|n|3|d <| d d}3|dk r|n|3|d <| d d}3|dk r|n|3|d <| dd}3|dk r|n|3|d<| dd}3| dk r| n|3|d<| dd}3| dk r(| n|3|d<| dd}3| dk rJ| n|3|d<| dd}3| dk rl| n|3|d<| dd}3| dk r| n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r8|n|3|d<| dd}3|dk rZ|n|3|d<| dd}3|dk r||n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r&|n|3|d<| d d}3|dk rH|n|3|d <| d!d}3|dk rj|n|3|d!<| d"d}3|dk r|n|3|d"<| d#d}3|dk r|n|3|d#<| d$d}3|dk r|n|3|d$<| d%d}3|dk r|n|3|d%<| d&d}3| dk r| n|3|d&<| d'd}3|!dk r6|!n|3|d'<| d(d}3|"dk rX|"n|3|d(<| d)d}3|#dk rz|#n|3|d)<| d*d}3|$dk r|$n|3|d*<| d+d}3|%dk r|%n|3|d+<| d,d}3|&dk r|&n|3|d,<| d-d}3|'dk r|'n|3|d-<| d.d}3|(dk r$|(n|3|d.<| d/d}3|)dk rF|)n|3|d/<| d0d}3|*dk rh|*n|3|d0<| d1d}3|+dk r|+n|3|d1<| d2d}3|,dk r|,n|3|d2<| d3d}3|-dk r|-n|3|d3<| d4d}3|.dk r|.n|3|d4<| d5d}3|/dk r|/n|3|d5<| d6d}3|0dk r4|0n|3|d6<dd7l>m?}4d|j@d8<|4d8ddd9|jd8<| d8d|jAft|f|1d|_ dS):a2 Construct a new Scatterpolargl object The scatterpolargl trace type encompasses line charts, scatter charts, and bubble charts in polar coordinates using the WebGL plotting engine. The data visualized as scatter point or lines is set in `r` (radial) and `theta` (angular) coordinates Bubble charts are achieved by setting `marker.size` and/or `marker.color` to numerical arrays. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Scatterpolargl` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dr Sets the r coordinate step. dtheta Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates. fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatterpolargl.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatterpolargl.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. r Sets the radial coordinates r0 Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.scatterpolargl.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatterpolargl.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . theta Sets the angular coordinates theta0 Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. thetasrc Sets the source reference on plot.ly for theta . thetaunit Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatterpolargl.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Scatterpolargl scatterpolarglNzThe first argument to the plotly.graph_objs.Scatterpolargl constructor must be a dict or an instance of :class:`plotly.graph_objs.Scatterpolargl`rJFr)r`rr rrWrXrJrrrrrrrrrrrrrr!r"rKr#r'rYrZr[rr*r+r,rLr-r/r1r2r3r4r5r\r]r^r_r7r8rr9)rKrD)rLrMr)BrNrVrOrPrQrRrSrTrUrVrWrXrYr`rr[r`ra DrValidatorDthetaValidatorrSrrerfrgrhrirjrkrlrmrqrrrrrsrTrtrx RValidator R0Validator RsrcValidatorrr{r|r}rUr~rrrrrrThetaValidatorTheta0ValidatorThetasrcValidatorThetaunitValidatorrrrrrrKrEr)5rrrr rrWrXrJrrrrrrrrrrrrrr!r"rKr#r'rYrZr[rr*r+r,rLr-r/r1r2r3r4r5r\r]r^r_r7r8rr9rZv_scatterpolarglrrK)rQrrrOTsB:                                                       zScatterpolargl.__init__)0NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)9rrrrrrr rrWrXrJrrrrrrrrrrrrrr!r"rKr#r'rYrZr[rr*r+r,rLr-r/r1r2r3r4r5r\r]r^r_r7r8rr9rDrGrHrOrrr)rQrrVNs&      " 7   5 #                       1                wrVc2s<eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6eddZ7eddZ8dfdd Z9Z:S) ScatterpolarcCs|dS)a Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. The 'cliponaxis' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr VszScatterpolar.cliponaxiscCs ||d<dS)Nr r)rrrrrr WscCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrWs zScatterpolar.connectgapscCs ||d<dS)Nrr)rrrrrr$WscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr *WszScatterpolar.customdatacCs ||d<dS)Nr r)rrrrrr ;WscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrAWs zScatterpolar.customdatasrccCs ||d<dS)Nrr)rrrrrrOWscCs|dS)z Sets the r coordinate step. The 'dr' property is a number and may be specified as: - An int or float Returns ------- int|float rWr)rrrrrWUWs zScatterpolar.drcCs ||d<dS)NrWr)rrrrrrWcWscCs|dS)a@ Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates. The 'dtheta' property is a number and may be specified as: - An int or float Returns ------- int|float rXr)rrrrrXiWszScatterpolar.dthetacCs ||d<dS)NrXr)rrrrrrXyWscCs|dS)a Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterpolar has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. The 'fill' property is an enumeration that may be specified as: - One of the following enumeration values: ['none', 'toself', 'tonext'] Returns ------- Any rJr)rrrrrJWszScatterpolar.fillcCs ||d<dS)NrJr)rrrrrrJWscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrrWs5zScatterpolar.fillcolorcCs ||d<dS)Nrr)rrrrrrWscCs|dS)ac Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters (e.g. 'r+theta') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrWszScatterpolar.hoverinfocCs ||d<dS)Nrr)rrrrrrWscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrWs zScatterpolar.hoverinfosrccCs ||d<dS)Nrr)rrrrrrXscCs|dS)a  The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolar.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scatterpolar.Hoverlabel rr)rrrrrXs3zScatterpolar.hoverlabelcCs ||d<dS)Nrr)rrrrrr` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr[Xs!zScatterpolar.hovertemplatecCs ||d<dS)Nrr)rrrrrr~XscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrXs zScatterpolar.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrXscCs|dS)ab Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrXszScatterpolar.hovertextcCs ||d<dS)Nrr)rrrrrrXscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrXs zScatterpolar.hovertextsrccCs ||d<dS)Nrr)rrrrrrXscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrXszScatterpolar.idscCs ||d<dS)Nrr)rrrrrrXscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrXs zScatterpolar.idssrccCs ||d<dS)Nrr)rrrrrrXscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrXszScatterpolar.legendgroupcCs ||d<dS)Nrr)rrrrrrYscCs|dS)a( The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolar.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). shape Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. smoothing Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a "linear" shape). width Sets the line width (in px). Returns ------- plotly.graph_objs.scatterpolar.Line rr)rrrrrYs#zScatterpolar.linecCs ||d<dS)Nrr)rrrrrr,YscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolar.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scatterpolar.marke r.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . gradient :class:`plotly.graph_objects.scatterpolar.marke r.Gradient` instance or dict with compatible properties line :class:`plotly.graph_objects.scatterpolar.marke r.Line` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scatterpolar.Marker rr)rrrrr2YszScatterpolar.markercCs ||d<dS)Nrr)rrrrrrYscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!YszScatterpolar.metacCs ||d<dS)Nr!r)rrrrrr!YscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Ys zScatterpolar.metasrccCs ||d<dS)Nr"r)rrrrrr"YscCs|dS)a Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrKYszScatterpolar.modecCs ||d<dS)NrKr)rrrrrrKZscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#ZszScatterpolar.namecCs ||d<dS)Nr#r)rrrrrr#)ZscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'/Zs zScatterpolar.opacitycCs ||d<dS)Nr'r)rrrrrr'=ZscCs|dS)z Sets the radial coordinates The 'r' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rYr)rrrrrYCZs zScatterpolar.rcCs ||d<dS)NrYr)rrrrrrYQZscCs|dS)a  Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. The 'r0' property accepts values of any type Returns ------- Any rZr)rrrrrZWZs zScatterpolar.r0cCs ||d<dS)NrZr)rrrrrrZfZscCs|dS)z Sets the source reference on plot.ly for r . The 'rsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r[r)rrrrr[lZs zScatterpolar.rsrccCs ||d<dS)Nr[r)rrrrrr[zZscCs|dS)a$ The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolar.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatterpolar.selec ted.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatterpolar.selec ted.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatterpolar.Selected rr)rrrrrZszScatterpolar.selectedcCs ||d<dS)Nrr)rrrrrrZscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*ZszScatterpolar.selectedpointscCs ||d<dS)Nr*r)rrrrrr*ZscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+Zs zScatterpolar.showlegendcCs ||d<dS)Nr+r)rrrrrr+ZscCs|dS)ar The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolar.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scatterpolar.Stream r,r)rrrrr,ZszScatterpolar.streamcCs ||d<dS)Nr,r)rrrrrr,ZscCs|dS)a Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. The 'subplot' property is an identifier of a particular subplot, of type 'polar', that may be specified as the string 'polar' optionally followed by an integer >= 1 (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) Returns ------- str rLr)rrrrrLZszScatterpolar.subplotcCs ||d<dS)NrLr)rrrrrrL[scCs|dS)a Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-[szScatterpolar.textcCs ||d<dS)Nr-r)rrrrrr-[scCs|dS)a; Sets the text font. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolar.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.scatterpolar.Textfont r/r)rrrrr/"[s/zScatterpolar.textfontcCs ||d<dS)Nr/r)rrrrrr/S[scCs|dS)a/ Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1Y[szScatterpolar.textpositioncCs ||d<dS)Nr1r)rrrrrr1l[scCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2r[s zScatterpolar.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2[scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3[s zScatterpolar.textsrccCs ||d<dS)Nr3r)rrrrrr3[scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4[szScatterpolar.texttemplatecCs ||d<dS)Nr4r)rrrrrr4[scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5[s zScatterpolar.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5[scCs|dS)z Sets the angular coordinates The 'theta' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r\r)rrrrr\[s zScatterpolar.thetacCs ||d<dS)Nr\r)rrrrrr\[scCs|dS)a! Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. The 'theta0' property accepts values of any type Returns ------- Any r]r)rrrrr][s zScatterpolar.theta0cCs ||d<dS)Nr]r)rrrrrr][scCs|dS)z Sets the source reference on plot.ly for theta . The 'thetasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r^r)rrrrr^[s zScatterpolar.thetasrccCs ||d<dS)Nr^r)rrrrrr^\scCs|dS)aY Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. The 'thetaunit' property is an enumeration that may be specified as: - One of the following enumeration values: ['radians', 'degrees', 'gradians'] Returns ------- Any r_r)rrrrr_\szScatterpolar.thetaunitcCs ||d<dS)Nr_r)rrrrrr_\scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7$\szScatterpolar.uidcCs ||d<dS)Nr7r)rrrrrr74\scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8:\szScatterpolar.uirevisioncCs ||d<dS)Nr8r)rrrrrr8U\scCs|dS)a2 The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.scatterpolar.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatterpolar.unsel ected.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatterpolar.unsel ected.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatterpolar.Unselected rr)rrrrr[\szScatterpolar.unselectedcCs ||d<dS)Nrr)rrrrrru\scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9{\szScatterpolar.visiblecCs ||d<dS)Nr9r)rrrrrr9\scCs |jdS)NrD)rE)rrrrrD\szScatterpolar.typecCsdS)NrFr)rrrrrG\szScatterpolar._parent_path_strcCsdS)Na'/ cliponaxis Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dr Sets the r coordinate step. dtheta Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates. fill Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterpolar has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatterpolar.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatterpolar.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatterpolar.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. r Sets the radial coordinates r0 Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.scatterpolar.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatterpolar.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . theta Sets the angular coordinates theta0 Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. thetasrc Sets the source reference on plot.ly for theta . thetaunit Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatterpolar.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrH\sszScatterpolar._prop_descriptionsNc37 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|3 dd|_ ddl m }4|4|jd<|4|jd <|4|jd <|4|jd <|4|jd <|4|jd <|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4 |jd<|4!|jd<|4"|jd<|4#|jd<|4$|jd<|4%|jd<|4&|jd<|4'|jd <|4(|jd!<|4)|jd"<|4*|jd#<|4+|jd$<|4,|jd%<|4-|jd&<|4.|jd'<|4/|jd(<|40|jd)<|41|jd*<|42|jd+<|43|jd,<|44|jd-<|45|jd.<|46|jd/<|47|jd0<|48|jd1<|49|jd2<|4:|jd3<|4;|jd4<|4<|jd5<|4=|jd6<|4>|jd7<|4?|jd8<| dd}5|dk r4|n|5|d<| d d}5|dk rV|n|5|d <| d d}5|dk rx|n|5|d <| d d}5|dk r|n|5|d <| d d}5|dk r|n|5|d <| d d}5|dk r|n|5|d <| dd}5|dk r|n|5|d<| dd}5| dk r"| n|5|d<| dd}5| dk rD| n|5|d<| dd}5| dk rf| n|5|d<| dd}5| dk r| n|5|d<| dd}5| dk r| n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r2|n|5|d<| dd}5|dk rT|n|5|d<| dd}5|dk rv|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r |n|5|d<| dd}5|dk rB|n|5|d<| d d}5|dk rd|n|5|d <| d!d}5|dk r|n|5|d!<| d"d}5|dk r|n|5|d"<| d#d}5|dk r|n|5|d#<| d$d}5|dk r|n|5|d$<| d%d}5|dk r|n|5|d%<| d&d}5| dk r0| n|5|d&<| d'd}5|!dk rR|!n|5|d'<| d(d}5|"dk rt|"n|5|d(<| d)d}5|#dk r|#n|5|d)<| d*d}5|$dk r|$n|5|d*<| d+d}5|%dk r|%n|5|d+<| d,d}5|&dk r|&n|5|d,<| d-d}5|'dk r|'n|5|d-<| d.d}5|(dk r@|(n|5|d.<| d/d}5|)dk rb|)n|5|d/<| d0d}5|*dk r|*n|5|d0<| d1d}5|+dk r|+n|5|d1<| d2d}5|,dk r|,n|5|d2<| d3d}5|-dk r|-n|5|d3<| d4d}5|.dk r |.n|5|d4<| d5d}5|/dk r.|/n|5|d5<| d6d}5|0dk rP|0n|5|d6<| d7d}5|1dk rr|1n|5|d7<| d8d}5|2dk r|2n|5|d8<dd9l@mA}6d|jBd:<|6d:ddd;|jd:<| d:d|jCft|f|3d|_ dS)` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatterpolar.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatterpolar.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. r Sets the radial coordinates r0 Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.scatterpolar.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatterpolar.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . theta Sets the angular coordinates theta0 Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. thetasrc Sets the source reference on plot.ly for theta . thetaunit Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatterpolar.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Scatterpolar scatterpolarNzThe first argument to the plotly.graph_objs.Scatterpolar constructor must be a dict or an instance of :class:`plotly.graph_objs.Scatterpolar`rJFr)rkr rr rrWrXrJrrrrrrrrrrrrrrr!r"rKr#r'rYrZr[rr*r+r,rLr-r/r1r2r3r4r5r\r]r^r_r7r8rr9)rKrD)rLrMr)DrNrjrOrPrQrRrSrTrUrVrWrXrYrkr]r[rr`rararbrSrrerfrgrrhrirjrkrlrmrqrrrrrsrTrtrxrcrdrerr{r|r}rUr~rrrrrrrfrgrhrirrrrrrKrEr)7rrr rr rrWrXrJrrrrrrrrrrrrrrr!r"rKr#r'rYrZr[rr*r+r,rLr-r/r1r2r3r4r5r\r]r^r_r7r8rr9rZv_scatterpolarrrK)rQrrrO]sN<                                                         zScatterpolar.__init__)2NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN);rrrrr rrr rrWrXrJrrrrrrrrrrrrrrr!r"rKr#r'rYrZr[rr*r+r,rLr-r/r1r2r3r4r5r\r]r^r_r7r8rr9rDrGrHrOrrr)rQrrjVs2        7   5  #       %                1                wrjc+seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/eddZ0eddZ1dfdd Z2Z3S) ScattermapboxcCs|dS)a Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''". The 'below' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str belowr)rrrrrm_szScattermapbox.belowcCs ||d<dS)Nrmr)rrrrrrm_scCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr_s zScattermapbox.connectgapscCs ||d<dS)Nrr)rrrrrr_scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr _szScattermapbox.customdatacCs ||d<dS)Nr r)rrrrrr _scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr_s zScattermapbox.customdatasrccCs ||d<dS)Nrr)rrrrrr_scCs|dS)a Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. The 'fill' property is an enumeration that may be specified as: - One of the following enumeration values: ['none', 'toself'] Returns ------- Any rJr)rrrrrJ_szScattermapbox.fillcCs ||d<dS)NrJr)rrrrrrJ`scCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrr`s5zScattermapbox.fillcolorcCs ||d<dS)Nrr)rrrrrrE`scCs|dS)ac Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters (e.g. 'lon+lat') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrK`szScattermapbox.hoverinfocCs ||d<dS)Nrr)rrrrrr_`scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrre`s zScattermapbox.hoverinfosrccCs ||d<dS)Nrr)rrrrrrs`scCs|dS)a  The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scattermapbox.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scattermapbox.Hoverlabel rr)rrrrry`s3zScattermapbox.hoverlabelcCs ||d<dS)Nrr)rrrrrr`scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr`s!zScattermapbox.hovertemplatecCs ||d<dS)Nrr)rrrrrr`scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr`s zScattermapbox.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr`scCs|dS)ai Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr`szScattermapbox.hovertextcCs ||d<dS)Nrr)rrrrrrascCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr as zScattermapbox.hovertextsrccCs ||d<dS)Nrr)rrrrrrascCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrraszScattermapbox.idscCs ||d<dS)Nrr)rrrrrr/ascCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr5as zScattermapbox.idssrccCs ||d<dS)Nrr)rrrrrrCascCs|dS)z Sets the latitude coordinates (in degrees North). The 'lat' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray latr)rrrrrnIas zScattermapbox.latcCs ||d<dS)Nrnr)rrrrrrnWascCs|dS)z Sets the source reference on plot.ly for lat . The 'latsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str latsrcr)rrrrro]as zScattermapbox.latsrccCs ||d<dS)Nror)rrrrrrokascCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrqaszScattermapbox.legendgroupcCs ||d<dS)Nrr)rrrrrrascCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scattermapbox.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. width Sets the line width (in px). Returns ------- plotly.graph_objs.scattermapbox.Line rr)rrrrraszScattermapbox.linecCs ||d<dS)Nrr)rrrrrrascCs|dS)z Sets the longitude coordinates (in degrees East). The 'lon' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray lonr)rrrrrpas zScattermapbox.loncCs ||d<dS)Nrpr)rrrrrrpascCs|dS)z Sets the source reference on plot.ly for lon . The 'lonsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str lonsrcr)rrrrrqas zScattermapbox.lonsrccCs ||d<dS)Nrqr)rrrrrrqascCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scattermapbox.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scattermapbox.mark er.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for "circle" symbols. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scattermapbox.Marker rr)rrrrraszScattermapbox.markercCs ||d<dS)Nrr)rrrrrrTbscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!ZbszScattermapbox.metacCs ||d<dS)Nr!r)rrrrrr!pbscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"vbs zScattermapbox.metasrccCs ||d<dS)Nr"r)rrrrrr"bscCs|dS)a( Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrKbszScattermapbox.modecCs ||d<dS)NrKr)rrrrrrKbscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#bszScattermapbox.namecCs ||d<dS)Nr#r)rrrrrr#bscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'bs zScattermapbox.opacitycCs ||d<dS)Nr'r)rrrrrr'bscCs|dS)ah The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scattermapbox.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scattermapbox.sele cted.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.scattermapbox.Selected rr)rrrrrbszScattermapbox.selectedcCs ||d<dS)Nrr)rrrrrrbscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*bszScattermapbox.selectedpointscCs ||d<dS)Nr*r)rrrrrr*bscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+cs zScattermapbox.showlegendcCs ||d<dS)Nr+r)rrrrrr+cscCs|dS)at The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scattermapbox.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scattermapbox.Stream r,r)rrrrr,cszScattermapbox.streamcCs ||d<dS)Nr,r)rrrrrr,2cscCs|dS)a' Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. The 'subplot' property is an identifier of a particular subplot, of type 'mapbox', that may be specified as the string 'mapbox' optionally followed by an integer >= 1 (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) Returns ------- str rLr)rrrrrL8cszScattermapbox.subplotcCs ||d<dS)NrLr)rrrrrrLKcscCs|dS)a Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-QcszScattermapbox.textcCs ||d<dS)Nr-r)rrrrrr-fcscCs|dS)ar Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to "symbol". The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scattermapbox.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.scattermapbox.Textfont r/r)rrrrr/lcs'zScattermapbox.textfontcCs ||d<dS)Nr/r)rrrrrr/cscCs|dS)a Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] Returns ------- Any r1r)rrrrr1cszScattermapbox.textpositioncCs ||d<dS)Nr1r)rrrrrr1cscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3cs zScattermapbox.textsrccCs ||d<dS)Nr3r)rrrrrr3cscCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon` and `text`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4cszScattermapbox.texttemplatecCs ||d<dS)Nr4r)rrrrrr4cscCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5cs zScattermapbox.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5cscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7cszScattermapbox.uidcCs ||d<dS)Nr7r)rrrrrr7dscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8dszScattermapbox.uirevisioncCs ||d<dS)Nr8r)rrrrrr8/dscCs|dS)at The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.scattermapbox.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.scattermapbox.unse lected.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.scattermapbox.Unselected rr)rrrrr5dszScattermapbox.unselectedcCs ||d<dS)Nrr)rrrrrrKdscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9QdszScattermapbox.visiblecCs ||d<dS)Nr9r)rrrrrr9bdscCs |jdS)NrD)rE)rrrrrDhdszScattermapbox.typecCsdS)NrFr)rrrrrGndszScattermapbox._parent_path_strcCsdS)Na) below Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''". connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . fill Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scattermapbox.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . lat Sets the latitude coordinates (in degrees North). latsrc Sets the source reference on plot.ly for lat . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattermapbox.Line` instance or dict with compatible properties lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker :class:`plotly.graph_objects.scattermapbox.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattermapbox.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattermapbox.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. text Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the icon text font (color=mapbox.layer.paint.text- color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to "symbol". textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattermapbox.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHtdsSz Scattermapbox._prop_descriptionsNc,0 stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|, dd|_ ddl m }-|-|jd<|-|jd <|-|jd <|-|jd <|-|jd <|-|jd <|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|- |jd<|-!|jd<|-"|jd<|-#|jd<|-$|jd<|-%|jd<|-&|jd<|-'|jd <|-(|jd!<|-)|jd"<|-*|jd#<|-+|jd$<|-,|jd%<|--|jd&<|-.|jd'<|-/|jd(<|-0|jd)<|-1|jd*<|-2|jd+<|-3|jd,<|-4|jd-<|-5|jd.<|-6|jd/<|-7|jd0<|-8|jd1<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d d}.|dk r|n|.|d <| d d}.|dk r8|n|.|d <| d d}.|dk rZ|n|.|d <| d d}.|dk r||n|.|d <| dd}.|dk r|n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r&| n|.|d<| dd}.| dk rH| n|.|d<| dd}.|dk rj|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r6|n|.|d<| dd}.|dk rX|n|.|d<| dd}.|dk rz|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d!d}.|dk r$|n|.|d!<| d"d}.|dk rF|n|.|d"<| d#d}.|dk rh|n|.|d#<| d$d}.|dk r|n|.|d$<| d%d}.|dk r|n|.|d%<| d&d}.| dk r| n|.|d&<| d'd}.|!dk r|!n|.|d'<| d(d}.|"dk r|"n|.|d(<| d)d}.|#dk r4|#n|.|d)<| d*d}.|$dk rV|$n|.|d*<| d+d}.|%dk rx|%n|.|d+<| d,d}.|&dk r|&n|.|d,<| d-d}.|'dk r|'n|.|d-<| d.d}.|(dk r|(n|.|d.<| d/d}.|)dk r|)n|.|d/<| d0d}.|*dk r"|*n|.|d0<| d1d}.|+dk rD|+n|.|d1<dd2l9m:}/d|j;d3<|/d3ddd4|jd3<| d3d|j` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . lat Sets the latitude coordinates (in degrees North). latsrc Sets the source reference on plot.ly for lat . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattermapbox.Line` instance or dict with compatible properties lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker :class:`plotly.graph_objects.scattermapbox.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattermapbox.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattermapbox.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. text Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the icon text font (color=mapbox.layer.paint.text- color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to "symbol". textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattermapbox.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Scattermapbox scattermapboxNzThe first argument to the plotly.graph_objs.Scattermapbox constructor must be a dict or an instance of :class:`plotly.graph_objs.Scattermapbox`rJFr)rrrmrr rrJrrrrrrrrrrrnrorrrprqrr!r"rKr#r'rr*r+r,rLr-r/r1r3r4r5r7r8rr9)rKrD)rLrMr)=rNrlrOrPrQrRrSrTrUrVrWrXrYrrBelowValidatorr[rr`rarSrrerfrgrhrirjrkrlrm LatValidatorLatsrcValidatorrqr LonValidatorLonsrcValidatorrrrrsrTrtrxrr{r|r}rUr~rrrrrrrrrrrKrEr)0rrrmrr rrJrrrrrrrrrrrnrorrrprqrr!r"rKr#r'rr*r+r,rLr-r/r1r3r4r5r7r8rr9rZv_scattermapboxrrK)rQrrrOHes$                                                  zScattermapbox.__init__)+NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)4rrrrrmrrr rrJrrrrrrrrrrrnrorrrprqrr!r"rKr#r'rr*r+r,rLr-r/r1r3r4r5r7r8rr9rDrGrHrOrrr)rQrrl_s      7   5 #                         )           Wrlc4speZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8eddZ9eddZ:dfdd Z;ZhscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrrDhs5zScattergl.fillcolorcCs ||d<dS)Nrr)rrrrrr{hscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrhszScattergl.hoverinfocCs ||d<dS)Nrr)rrrrrrhscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrhs zScattergl.hoverinfosrccCs ||d<dS)Nrr)rrrrrrhscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scattergl.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scattergl.Hoverlabel rr)rrrrrhs3zScattergl.hoverlabelcCs ||d<dS)Nrr)rrrrrrhscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrhs!zScattergl.hovertemplatecCs ||d<dS)Nrr)rrrrrr iscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrris zScattergl.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr!iscCs|dS)ab Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr'iszScattergl.hovertextcCs ||d<dS)Nrr)rrrrrr;iscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrAis zScattergl.hovertextsrccCs ||d<dS)Nrr)rrrrrrOiscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrUisz Scattergl.idscCs ||d<dS)Nrr)rrrrrreiscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrkis zScattergl.idssrccCs ||d<dS)Nrr)rrrrrryiscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrriszScattergl.legendgroupcCs ||d<dS)Nrr)rrrrrriscCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scattergl.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. dash Sets the style of the lines. shape Determines the line shape. The values correspond to step-wise line shapes. width Sets the line width (in px). Returns ------- plotly.graph_objs.scattergl.Line rr)rrrrriszScattergl.linecCs ||d<dS)Nrr)rrrrrriscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scattergl.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scattergl.marker.C olorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . line :class:`plotly.graph_objects.scattergl.marker.L ine` instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scattergl.Marker rr)rrrrris zScattergl.markercCs ||d<dS)Nrr)rrrrrrEjscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!KjszScattergl.metacCs ||d<dS)Nr!r)rrrrrr!ajscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"gjs zScattergl.metasrccCs ||d<dS)Nr"r)rrrrrr"ujscCs|dS)a Determines the drawing mode for this scatter trace. The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrK{jszScattergl.modecCs ||d<dS)NrKr)rrrrrrKjscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#jszScattergl.namecCs ||d<dS)Nr#r)rrrrrr#jscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'js zScattergl.opacitycCs ||d<dS)Nr'r)rrrrrr'jscCs|dS)a The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scattergl.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scattergl.selected .Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scattergl.selected .Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scattergl.Selected rr)rrrrrjszScattergl.selectedcCs ||d<dS)Nrr)rrrrrrjscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*jszScattergl.selectedpointscCs ||d<dS)Nr*r)rrrrrr*jscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+js zScattergl.showlegendcCs ||d<dS)Nr+r)rrrrrr+kscCs|dS)al The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scattergl.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scattergl.Stream r,r)rrrrr, kszScattergl.streamcCs ||d<dS)Nr,r)rrrrrr,$kscCs|dS)a Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-*kszScattergl.textcCs ||d<dS)Nr-r)rrrrrr-?kscCs|dS)a5 Sets the text font. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scattergl.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.scattergl.Textfont r/r)rrrrr/Eks/zScattergl.textfontcCs ||d<dS)Nr/r)rrrrrr/vkscCs|dS)a/ Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1|kszScattergl.textpositioncCs ||d<dS)Nr1r)rrrrrr1kscCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2ks zScattergl.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2kscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3ks zScattergl.textsrccCs ||d<dS)Nr3r)rrrrrr3kscCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4kszScattergl.texttemplatecCs ||d<dS)Nr4r)rrrrrr4kscCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5ks zScattergl.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5kscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7ksz Scattergl.uidcCs ||d<dS)Nr7r)rrrrrr7lscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8 lszScattergl.uirevisioncCs ||d<dS)Nr8r)rrrrrr8%lscCs|dS)a& The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.scattergl.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.scattergl.unselect ed.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scattergl.unselect ed.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scattergl.Unselected rr)rrrrr+lszScattergl.unselectedcCs ||d<dS)Nrr)rrrrrrElscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9KlszScattergl.visiblecCs ||d<dS)Nr9r)rrrrrr9\lscCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<bls z Scattergl.xcCs ||d<dS)Nr<r)rrrrrr<plscCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr=vls z Scattergl.x0cCs ||d<dS)Nr=r)rrrrrr=lscCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>lszScattergl.xaxiscCs ||d<dS)Nr>r)rrrrrr>lscCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrlszScattergl.xcalendarcCs ||d<dS)Nrr)rrrrrrlscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?ls zScattergl.xsrccCs ||d<dS)Nr?r)rrrrrr?lscCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@ls z Scattergl.ycCs ||d<dS)Nr@r)rrrrrr@lscCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAls z Scattergl.y0cCs ||d<dS)NrAr)rrrrrrAlscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBlszScattergl.yaxiscCs ||d<dS)NrBr)rrrrrrB mscCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrmszScattergl.ycalendarcCs ||d<dS)Nrr)rrrrrr$mscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC*ms zScattergl.ysrccCs ||d<dS)NrCr)rrrrrrC8mscCs |jdS)NrD)rE)rrrrrD>mszScattergl.typecCsdS)NrFr)rrrrrGDmszScattergl._parent_path_strcCsdS)Na0 connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. error_x :class:`plotly.graph_objects.scattergl.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.scattergl.ErrorY` instance or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scattergl.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattergl.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scattergl.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattergl.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattergl.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattergl.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . r)rrrrrHJmswzScattergl._prop_descriptionsNc59 sP tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|5 dd|_ ddl m }6|6|jd<|6|jd <|6|jd <|6|jd <|6|jd <|6|jd <|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6 |jd<|6!|jd<|6"|jd<|6#|jd<|6$|jd<|6%|jd<|6&|jd<|6'|jd <|6(|jd!<|6)|jd"<|6*|jd#<|6+|jd$<|6,|jd%<|6-|jd&<|6.|jd'<|6/|jd(<|60|jd)<|61|jd*<|62|jd+<|63|jd,<|64|jd-<|65|jd.<|66|jd/<|67|jd0<|68|jd1<|69|jd2<|6:|jd3<|6;|jd4<|6<|jd5<|6=|jd6<|6>|jd7<|6?|jd8<|6@|jd9<|6A|jd:<| dd}7|dk rP|n|7|d<| d d}7|dk rr|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| dd}7|dk r|n|7|d<| dd}7| dk r>| n|7|d<| dd}7| dk r`| n|7|d<| dd}7| dk r| n|7|d<| dd}7| dk r| n|7|d<| dd}7| dk r| n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r |n|7|d<| dd}7|dk r,|n|7|d<| dd}7|dk rN|n|7|d<| dd}7|dk rp|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r<|n|7|d<| dd}7|dk r^|n|7|d<| d d}7|dk r|n|7|d <| d!d}7|dk r|n|7|d!<| d"d}7|dk r|n|7|d"<| d#d}7|dk r|n|7|d#<| d$d}7|dk r|n|7|d$<| d%d}7|dk r*|n|7|d%<| d&d}7| dk rL| n|7|d&<| d'd}7|!dk rn|!n|7|d'<| d(d}7|"dk r|"n|7|d(<| d)d}7|#dk r|#n|7|d)<| d*d}7|$dk r|$n|7|d*<| d+d}7|%dk r|%n|7|d+<| d,d}7|&dk r|&n|7|d,<| d-d}7|'dk r:|'n|7|d-<| d.d}7|(dk r\|(n|7|d.<| d/d}7|)dk r~|)n|7|d/<| d0d}7|*dk r|*n|7|d0<| d1d}7|+dk r|+n|7|d1<| d2d}7|,dk r|,n|7|d2<| d3d}7|-dk r|-n|7|d3<| d4d}7|.dk r(|.n|7|d4<| d5d}7|/dk rJ|/n|7|d5<| d6d}7|0dk rl|0n|7|d6<| d7d}7|1dk r|1n|7|d7<| d8d}7|2dk r|2n|7|d8<| d9d}7|3dk r|3n|7|d9<| d:d}7|4dk r|4n|7|d:<dd;lBmC}8d|jDd<<|8da2 Construct a new Scattergl object The data visualized as scatter point or lines is set in `x` and `y` using the WebGL plotting engine. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Scattergl` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. error_x :class:`plotly.graph_objects.scattergl.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.scattergl.ErrorY` instance or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scattergl.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattergl.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scattergl.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattergl.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattergl.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattergl.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . Returns ------- Scattergl scatterglNzThe first argument to the plotly.graph_objs.Scattergl constructor must be a dict or an instance of :class:`plotly.graph_objs.Scattergl`rJFr)r{rr rrrryrzrJrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9r<r=r>rr?r@rArBrrC)rKrD)rLrMr)FrNrxrOrPrQrRrSrTrUrVrWrXrYr{rr[r`rarcrdErrorXValidatorErrorYValidatorrSrrerfrgrhrirjrkrlrmrqrrrrrsrTrtrxrr{r|r}r~rrrrrrrrrrrrrrrrrrrrrrKrEr)9rrrr rrrryrzrJrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9r<r=r>rr?r@rArBrrCrZ v_scatterglrrK)rQrrrOBnsZ?                                                           zScattergl.__init__)4NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)=rrrrrrr rrrryrzrJrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9r<r=r>rr?r@rArBrrCrDrGrHrOrrr)rQrrxgs>      K I " 7   5 #                   1                      {rxc0seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4eddZ5eddZ6dfdd Z7Z8S) ScattergeocCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrUps zScattergeo.connectgapscCs ||d<dS)Nrr)rrrrrrdpscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr jpszScattergeo.customdatacCs ||d<dS)Nr r)rrrrrr {pscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrps zScattergeo.customdatasrccCs ||d<dS)Nrr)rrrrrrpscCs|dS)a Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name". The 'featureidkey' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str featureidkeyr)rrrrrpszScattergeo.featureidkeycCs ||d<dS)Nrr)rrrrrrpscCs|dS)a Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. The 'fill' property is an enumeration that may be specified as: - One of the following enumeration values: ['none', 'toself'] Returns ------- Any rJr)rrrrrJpszScattergeo.fillcCs ||d<dS)NrJr)rrrrrrJpscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrrps5zScattergeo.fillcolorcCs ||d<dS)Nrr)rrrrrrpscCs|dS)a/ Sets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on. The 'geo' property is an identifier of a particular subplot, of type 'geo', that may be specified as the string 'geo' optionally followed by an integer >= 1 (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) Returns ------- str geor)rrrrrqszScattergeo.geocCs ||d<dS)Nrr)rrrrrrqscCs|dS)a Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". The 'geojson' property accepts values of any type Returns ------- Any geojsonr)rrrrrqszScattergeo.geojsoncCs ||d<dS)Nrr)rrrrrr,qscCs|dS)ao Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['lon', 'lat', 'location', 'text', 'name'] joined with '+' characters (e.g. 'lon+lat') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr2qszScattergeo.hoverinfocCs ||d<dS)Nrr)rrrrrrFqscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrLqs zScattergeo.hoverinfosrccCs ||d<dS)Nrr)rrrrrrZqscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scattergeo.Hoverlabel rr)rrrrr`qs3zScattergeo.hoverlabelcCs ||d<dS)Nrr)rrrrrrqscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrqs!zScattergeo.hovertemplatecCs ||d<dS)Nrr)rrrrrrqscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrqs zScattergeo.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrqscCs|dS)a Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrqszScattergeo.hovertextcCs ||d<dS)Nrr)rrrrrrqscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrqs zScattergeo.hovertextsrccCs ||d<dS)Nrr)rrrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrrszScattergeo.idscCs ||d<dS)Nrr)rrrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrrs zScattergeo.idssrccCs ||d<dS)Nrr)rrrrrr+rscCs|dS)z Sets the latitude coordinates (in degrees North). The 'lat' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rnr)rrrrrn1rs zScattergeo.latcCs ||d<dS)Nrnr)rrrrrrn?rscCs|dS)z Sets the source reference on plot.ly for lat . The 'latsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str ror)rrrrroErs zScattergeo.latsrccCs ||d<dS)Nror)rrrrrroSrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrYrszScattergeo.legendgroupcCs ||d<dS)Nrr)rrrrrrjrscCs|dS)a, The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scattergeo.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). width Sets the line width (in px). Returns ------- plotly.graph_objs.scattergeo.Line rr)rrrrrprszScattergeo.linecCs ||d<dS)Nrr)rrrrrrrscCs|dS)aI Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", "USA- states", *country names* correspond to features on the base map and value "geojson-id" corresponds to features from a custom GeoJSON linked to the `geojson` attribute. The 'locationmode' property is an enumeration that may be specified as: - One of the following enumeration values: ['ISO-3', 'USA-states', 'country names', 'geojson-id'] Returns ------- Any locationmoder)rrrrrrszScattergeo.locationmodecCs ||d<dS)Nrr)rrrrrrrscCs|dS)ai Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info. The 'locations' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray locationsr)rrrrrrszScattergeo.locationscCs ||d<dS)Nrr)rrrrrrrscCs|dS)z Sets the source reference on plot.ly for locations . The 'locationssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str locationssrcr)rrrrrrs zScattergeo.locationssrccCs ||d<dS)Nrr)rrrrrrrscCs|dS)z Sets the longitude coordinates (in degrees East). The 'lon' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rpr)rrrrrprs zScattergeo.loncCs ||d<dS)Nrpr)rrrrrrprscCs|dS)z Sets the source reference on plot.ly for lon . The 'lonsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rqr)rrrrrqrs zScattergeo.lonsrccCs ||d<dS)Nrqr)rrrrrrqrscCs|dS)aZ The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scattergeo.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scattergeo.marker. ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . gradient :class:`plotly.graph_objects.scattergeo.marker. Gradient` instance or dict with compatible properties line :class:`plotly.graph_objects.scattergeo.marker. Line` instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scattergeo.Marker rr)rrrrrrszScattergeo.markercCs ||d<dS)Nrr)rrrrrrsscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!sszScattergeo.metacCs ||d<dS)Nr!r)rrrrrr!sscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"ss zScattergeo.metasrccCs ||d<dS)Nr"r)rrrrrr"sscCs|dS)a Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrKsszScattergeo.modecCs ||d<dS)NrKr)rrrrrrKsscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#sszScattergeo.namecCs ||d<dS)Nr#r)rrrrrr#sscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'ss zScattergeo.opacitycCs ||d<dS)Nr'r)rrrrrr'tscCs|dS)a The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scattergeo.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scattergeo.selecte d.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scattergeo.selecte d.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scattergeo.Selected rr)rrrrr tszScattergeo.selectedcCs ||d<dS)Nrr)rrrrrr$tscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr**tszScattergeo.selectedpointscCs ||d<dS)Nr*r)rrrrrr*` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . lat Sets the latitude coordinates (in degrees North). latsrc Sets the source reference on plot.ly for lat . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattergeo.Line` instance or dict with compatible properties locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", "USA-states", *country names* correspond to features on the base map and value "geojson-id" corresponds to features from a custom GeoJSON linked to the `geojson` attribute. locations Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info. locationssrc Sets the source reference on plot.ly for locations . lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker :class:`plotly.graph_objects.scattergeo.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattergeo.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattergeo.Stream` instance or dict with compatible properties text Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon`, `location` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattergeo.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHuslzScattergeo._prop_descriptionsNc15 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|1 dd|_ ddl m }2|2|jd<|2|jd <|2|jd <|2|jd <|2|jd <|2|jd <|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2|jd<|2 |jd<|2!|jd<|2"|jd<|2#|jd<|2$|jd<|2%|jd<|2&|jd<|2'|jd <|2(|jd!<|2)|jd"<|2*|jd#<|2+|jd$<|2,|jd%<|2-|jd&<|2.|jd'<|2/|jd(<|20|jd)<|21|jd*<|22|jd+<|23|jd,<|24|jd-<|25|jd.<|26|jd/<|27|jd0<|28|jd1<|29|jd2<|2:|jd3<|2;|jd4<|2<|jd5<|2=|jd6<| dd}3|dk r|n|3|d<| d d}3|dk r:|n|3|d <| d d}3|dk r\|n|3|d <| d d}3|dk r~|n|3|d <| d d}3|dk r|n|3|d <| d d}3|dk r|n|3|d <| dd}3|dk r|n|3|d<| dd}3| dk r| n|3|d<| dd}3| dk r(| n|3|d<| dd}3| dk rJ| n|3|d<| dd}3| dk rl| n|3|d<| dd}3| dk r| n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r8|n|3|d<| dd}3|dk rZ|n|3|d<| dd}3|dk r||n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r|n|3|d<| dd}3|dk r&|n|3|d<| d d}3|dk rH|n|3|d <| d!d}3|dk rj|n|3|d!<| d"d}3|dk r|n|3|d"<| d#d}3|dk r|n|3|d#<| d$d}3|dk r|n|3|d$<| d%d}3|dk r|n|3|d%<| d&d}3| dk r| n|3|d&<| d'd}3|!dk r6|!n|3|d'<| d(d}3|"dk rX|"n|3|d(<| d)d}3|#dk rz|#n|3|d)<| d*d}3|$dk r|$n|3|d*<| d+d}3|%dk r|%n|3|d+<| d,d}3|&dk r|&n|3|d,<| d-d}3|'dk r|'n|3|d-<| d.d}3|(dk r$|(n|3|d.<| d/d}3|)dk rF|)n|3|d/<| d0d}3|*dk rh|*n|3|d0<| d1d}3|+dk r|+n|3|d1<| d2d}3|,dk r|,n|3|d2<| d3d}3|-dk r|-n|3|d3<| d4d}3|.dk r|.n|3|d4<| d5d}3|/dk r|/n|3|d5<| d6d}3|0dk r4|0n|3|d6<dd7l>m?}4d|j@d8<|4d8ddd9|jd8<| d8d|jAft|f|1d|_ dS):au0 Construct a new Scattergeo object The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in `lon` and `lat` respectively or by geographic location IDs or names in `locations`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Scattergeo` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . featureidkey Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name". fill Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. geo Sets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on. geojson Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scattergeo.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . lat Sets the latitude coordinates (in degrees North). latsrc Sets the source reference on plot.ly for lat . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattergeo.Line` instance or dict with compatible properties locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", "USA-states", *country names* correspond to features on the base map and value "geojson-id" corresponds to features from a custom GeoJSON linked to the `geojson` attribute. locations Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info. locationssrc Sets the source reference on plot.ly for locations . lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker :class:`plotly.graph_objects.scattergeo.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattergeo.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattergeo.Stream` instance or dict with compatible properties text Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon`, `location` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattergeo.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Scattergeo scattergeoNzThe first argument to the plotly.graph_objs.Scattergeo constructor must be a dict or an instance of :class:`plotly.graph_objs.Scattergeo`rJFr)rrr rrrJrrrrrrrrrrrrrnrorrrrrrprqrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9)rKrD)rLrMr)BrNr~rOrPrQrRrSrTrUrVrWrXrYrrr[r`raFeatureidkeyValidatorrSr GeoValidatorGeojsonValidatorrerfrgrhrirjrkrlrmrtrurqrLocationmodeValidatorLocationsValidatorLocationssrcValidatorrvrwrrrrsrTrtrxrr{r|r}r~rrrrrrrrrrrrKrEr)5rrrr rrrJrrrrrrrrrrrrrnrorrrrrrprqrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9rZ v_scattergeorrK)rQrrrOvsB0                                                       zScattergeo.__init__)0NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)9rrrrrrr rrrJrrrrrrrrrrrrrnrorrrrrrprqrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9rDrGrHrOrrr)rQrr~Qps&      7     5 #                          1            pr~c.seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2eddZ3eddZ4dfdd Z5Z6S) ScattercarpetcCs|dS)z Sets the a-axis coordinates. The 'a' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rDr)rrrrrDxs zScattercarpet.acCs ||d<dS)NrDr)rrrrrrDxscCs|dS)z Sets the source reference on plot.ly for a . The 'asrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rEr)rrrrrExs zScattercarpet.asrccCs ||d<dS)NrEr)rrrrrrExscCs|dS)z Sets the b-axis coordinates. The 'b' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rFr)rrrrrFxs zScattercarpet.bcCs ||d<dS)NrFr)rrrrrrFxscCs|dS)z Sets the source reference on plot.ly for b . The 'bsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rGr)rrrrrGxs zScattercarpet.bsrccCs ||d<dS)NrGr)rrrrrrGxscCs|dS)ab An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie The 'carpet' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str carpetr)rrrrrxszScattercarpet.carpetcCs ||d<dS)Nrr)rrrrrryscCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr ys zScattercarpet.connectgapscCs ||d<dS)Nrr)rrrrrryscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr yszScattercarpet.customdatacCs ||d<dS)Nr r)rrrrrr /yscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr5ys zScattercarpet.customdatasrccCs ||d<dS)Nrr)rrrrrrCyscCs|dS)a Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. The 'fill' property is an enumeration that may be specified as: - One of the following enumeration values: ['none', 'toself', 'tonext'] Returns ------- Any rJr)rrrrrJIyszScattercarpet.fillcCs ||d<dS)NrJr)rrrrrrJ`yscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrrfys5zScattercarpet.fillcolorcCs ||d<dS)Nrr)rrrrrryscCs|dS)a[ Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['a', 'b', 'text', 'name'] joined with '+' characters (e.g. 'a+b') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrryszScattercarpet.hoverinfocCs ||d<dS)Nrr)rrrrrryscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrys zScattercarpet.hoverinfosrccCs ||d<dS)Nrr)rrrrrryscCs|dS)a  The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scattercarpet.Hoverlabel rr)rrrrrys3zScattercarpet.hoverlabelcCs ||d<dS)Nrr)rrrrrrzscCs|dS)a Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". The 'hoveron' property is a flaglist and may be specified as a string containing: - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns ------- Any rr)rrrrr zszScattercarpet.hoveroncCs ||d<dS)Nrr)rrrrrrzscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr%zs!zScattercarpet.hovertemplatecCs ||d<dS)Nrr)rrrrrrHzscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrNzs zScattercarpet.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr\zscCs|dS)a^ Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrbzszScattercarpet.hovertextcCs ||d<dS)Nrr)rrrrrrvzscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr|zs zScattercarpet.hovertextsrccCs ||d<dS)Nrr)rrrrrrzscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrzszScattercarpet.idscCs ||d<dS)Nrr)rrrrrrzscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrzs zScattercarpet.idssrccCs ||d<dS)Nrr)rrrrrrzscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrzszScattercarpet.legendgroupcCs ||d<dS)Nrr)rrrrrrzscCs|dS)a* The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). shape Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. smoothing Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a "linear" shape). width Sets the line width (in px). Returns ------- plotly.graph_objs.scattercarpet.Line rr)rrrrrzs#zScattercarpet.linecCs ||d<dS)Nrr)rrrrrrzscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scattercarpet.mark er.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . gradient :class:`plotly.graph_objects.scattercarpet.mark er.Gradient` instance or dict with compatible properties line :class:`plotly.graph_objects.scattercarpet.mark er.Line` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scattercarpet.Marker rr)rrrrrzszScattercarpet.markercCs ||d<dS)Nrr)rrrrrr{scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!{szScattercarpet.metacCs ||d<dS)Nr!r)rrrrrr!{scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"{s zScattercarpet.metasrccCs ||d<dS)Nr"r)rrrrrr"{scCs|dS)a Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrK{szScattercarpet.modecCs ||d<dS)NrKr)rrrrrrK{scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#{szScattercarpet.namecCs ||d<dS)Nr#r)rrrrrr#{scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'{s zScattercarpet.opacitycCs ||d<dS)Nr'r)rrrrrr'|scCs|dS)a( The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scattercarpet.sele cted.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scattercarpet.sele cted.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scattercarpet.Selected rr)rrrrr |szScattercarpet.selectedcCs ||d<dS)Nrr)rrrrrr'|scCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*-|szScattercarpet.selectedpointscCs ||d<dS)Nr*r)rrrrrr*?|scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+E|s zScattercarpet.showlegendcCs ||d<dS)Nr+r)rrrrrr+T|scCs|dS)at The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scattercarpet.Stream r,r)rrrrr,Z|szScattercarpet.streamcCs ||d<dS)Nr,r)rrrrrr,u|scCs|dS)a Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-{|szScattercarpet.textcCs ||d<dS)Nr-r)rrrrrr-|scCs|dS)a= Sets the text font. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.scattercarpet.Textfont r/r)rrrrr/|s/zScattercarpet.textfontcCs ||d<dS)Nr/r)rrrrrr/|scCs|dS)a/ Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1|szScattercarpet.textpositioncCs ||d<dS)Nr1r)rrrrrr1|scCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2|s zScattercarpet.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2|scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3|s zScattercarpet.textsrccCs ||d<dS)Nr3r)rrrrrr3}scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b` and `text`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4}szScattercarpet.texttemplatecCs ||d<dS)Nr4r)rrrrrr4+}scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr51}s zScattercarpet.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5?}scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7E}szScattercarpet.uidcCs ||d<dS)Nr7r)rrrrrr7U}scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8[}szScattercarpet.uirevisioncCs ||d<dS)Nr8r)rrrrrr8v}scCs|dS)a6 The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.scattercarpet.unse lected.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scattercarpet.unse lected.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scattercarpet.Unselected rr)rrrrr|}szScattercarpet.unselectedcCs ||d<dS)Nrr)rrrrrr}scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9}szScattercarpet.visiblecCs ||d<dS)Nr9r)rrrrrr9}scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>}szScattercarpet.xaxiscCs ||d<dS)Nr>r)rrrrrr>}scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrB}szScattercarpet.yaxiscCs ||d<dS)NrBr)rrrrrrB}scCs |jdS)NrD)rE)rrrrrD}szScattercarpet.typecCsdS)NrFr)rrrrrG}szScattercarpet._parent_path_strcCsdS)Na, a Sets the a-axis coordinates. asrc Sets the source reference on plot.ly for a . b Sets the b-axis coordinates. bsrc Sets the source reference on plot.ly for b . carpet An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . fill Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scattercarpet.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattercarpet.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scattercarpet.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattercarpet.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattercarpet.Stream` instance or dict with compatible properties text Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattercarpet.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. r)rrrrrH}sdz Scattercarpet._prop_descriptionsNc/3 s0 tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|/ dd|_ ddl m }0|0|jd<|0|jd <|0|jd <|0|jd <|0|jd <|0|jd <|0|jd<|0|jd<|0|jd<|0|jd<|0|jd<|0|jd<|0|jd<|0|jd<|0|jd<|0|jd<|0|jd<|0 |jd<|0!|jd<|0"|jd<|0#|jd<|0$|jd<|0%|jd<|0&|jd<|0'|jd <|0(|jd!<|0)|jd"<|0*|jd#<|0+|jd$<|0,|jd%<|0-|jd&<|0.|jd'<|0/|jd(<|00|jd)<|01|jd*<|02|jd+<|03|jd,<|04|jd-<|05|jd.<|06|jd/<|07|jd0<|08|jd1<|09|jd2<|0:|jd3<|0;|jd4<| dd}1|dk r|n|1|d<| d d}1|dk r|n|1|d <| d d}1|dk r@|n|1|d <| d d}1|dk rb|n|1|d <| d d}1|dk r|n|1|d <| d d}1|dk r|n|1|d <| dd}1|dk r|n|1|d<| dd}1| dk r| n|1|d<| dd}1| dk r | n|1|d<| dd}1| dk r.| n|1|d<| dd}1| dk rP| n|1|d<| dd}1| dk rr| n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r>|n|1|d<| dd}1|dk r`|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r|n|1|d<| dd}1|dk r |n|1|d<| d d}1|dk r,|n|1|d <| d!d}1|dk rN|n|1|d!<| d"d}1|dk rp|n|1|d"<| d#d}1|dk r|n|1|d#<| d$d}1|dk r|n|1|d$<| d%d}1|dk r|n|1|d%<| d&d}1| dk r| n|1|d&<| d'd}1|!dk r|!n|1|d'<| d(d}1|"dk r<|"n|1|d(<| d)d}1|#dk r^|#n|1|d)<| d*d}1|$dk r|$n|1|d*<| d+d}1|%dk r|%n|1|d+<| d,d}1|&dk r|&n|1|d,<| d-d}1|'dk r|'n|1|d-<| d.d}1|(dk r|(n|1|d.<| d/d}1|)dk r*|)n|1|d/<| d0d}1|*dk rL|*n|1|d0<| d1d}1|+dk rn|+n|1|d1<| d2d}1|,dk r|,n|1|d2<| d3d}1|-dk r|-n|1|d3<| d4d}1|.dk r|.n|1|d4<dd5ld6<|2d6ddd7|jd6<| d6d|j?ft|f|/d|_ dS)8ao. Construct a new Scattercarpet object Plots a scatter trace on either the first carpet axis or the carpet axis with a matching `carpet` attribute. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Scattercarpet` a Sets the a-axis coordinates. asrc Sets the source reference on plot.ly for a . b Sets the b-axis coordinates. bsrc Sets the source reference on plot.ly for b . carpet An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . fill Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scattercarpet.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scattercarpet.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scattercarpet.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. selected :class:`plotly.graph_objects.scattercarpet.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scattercarpet.Stream` instance or dict with compatible properties text Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scattercarpet.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. Returns ------- Scattercarpet scattercarpetNzThe first argument to the plotly.graph_objs.Scattercarpet constructor must be a dict or an instance of :class:`plotly.graph_objs.Scattercarpet`rJFr)rrDrErFrGrrr rrJrrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9r>rB)rKrD)rLrMr)@rNrrOrPrQrRrSrTrUrVrWrXrYrrOr[rPrQrRCarpetValidatorrr`rarSrrerfrgrrhrirjrkrlrmrqrrrrrsrTrtrxrr{r|r}r~rrrrrrrrrrrrrrKrEr)3rrrDrErFrGrrr rrJrrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9r>rBrZv_scattercarpetrrK)rQrrrO~s6$                                                     zScattercarpet.__init__).NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)7rrrrrDrrErFrGrrr rrJrrrrrrrrrrrrrrr!r"rKr#r'rr*r+r,r-r/r1r2r3r4r5r7r8rr9r>rBrDrGrHrOrrr)rQrrxs          7   5  #       %            1              hrc1s"eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5eddZ6eddZ7dfdd Z8Z9S) Scatter3dcCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrs zScatter3d.connectgapscCs ||d<dS)Nrr)rrrrrr̀scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr ӀszScatter3d.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zScatter3d.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a' The 'error_x' property is an instance of ErrorX that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. copy_zstyle symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.scatter3d.ErrorX ryr)rrrrrysIzScatter3d.error_xcCs ||d<dS)Nryr)rrrrrryIscCs|dS)a' The 'error_y' property is an instance of ErrorY that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. copy_zstyle symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.scatter3d.ErrorY rzr)rrrrrzOsIzScatter3d.error_ycCs ||d<dS)Nrzr)rrrrrrzscCs|dS)a The 'error_z' property is an instance of ErrorZ that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.ErrorZ` - A dict of string/value properties that will be passed to the ErrorZ constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.scatter3d.ErrorZ error_zr)rrrrrsGzScatter3d.error_zcCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszScatter3d.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr s zScatter3d.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scatter3d.Hoverlabel rr)rrrrrs3zScatter3d.hoverlabelcCs ||d<dS)Nrr)rrrrrrRscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrXs!zScatter3d.hovertemplatecCs ||d<dS)Nrr)rrrrrr{scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zScatter3d.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ac Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrszScatter3d.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zScatter3d.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrÂsz Scatter3d.idscCs ||d<dS)Nrr)rrrrrrӂscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrقs zScatter3d.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszScatter3d.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well. color Sets thelinecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scatter3d.line.Col orBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri c,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . dash Sets the dash style of the lines. reversescale Reverses the color mapping if true. Has an effect only if in `line.color`is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array. width Sets the line width (in px). Returns ------- plotly.graph_objs.scatter3d.Line rr)rrrrrsjzScatter3d.linecCs ||d<dS)Nrr)rrrrrrpscCs|dS)a5 The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scatter3d.marker.C olorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . line :class:`plotly.graph_objects.scatter3d.marker.L ine` instance or dict with compatible properties opacity Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set "marker.color" to an rgba color and use its alpha channel. reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scatter3d.Marker rr)rrrrrvs zScatter3d.markercCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szScatter3d.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"#s zScatter3d.metasrccCs ||d<dS)Nr"r)rrrrrr"1scCs|dS)a Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrK7szScatter3d.modecCs ||d<dS)NrKr)rrrrrrKMscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#SszScatter3d.namecCs ||d<dS)Nr#r)rrrrrr#cscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'is zScatter3d.opacitycCs ||d<dS)Nr'r)rrrrrr'wscCs|dS)a The 'projection' property is an instance of Projection that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.Projection` - A dict of string/value properties that will be passed to the Projection constructor Supported dict properties: x :class:`plotly.graph_objects.scatter3d.projecti on.X` instance or dict with compatible properties y :class:`plotly.graph_objects.scatter3d.projecti on.Y` instance or dict with compatible properties z :class:`plotly.graph_objects.scatter3d.projecti on.Z` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatter3d.Projection projectionr)rrrrr}szScatter3d.projectioncCs ||d<dS)Nrr)rrrrrrscCs|dS)a7 Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular subplot, of type 'scene', that may be specified as the string 'scene' optionally followed by an integer >= 1 (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- str rr)rrrrrszScatter3d.scenecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zScatter3d.showlegendcCs ||d<dS)Nr+r)rrrrrr+ɄscCs|dS)al The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scatter3d.Stream r,r)rrrrr,τszScatter3d.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively. The 'surfaceaxis' property is an enumeration that may be specified as: - One of the following enumeration values: [-1, 0, 1, 2] Returns ------- Any surfaceaxisr)rrrrrszScatter3d.surfaceaxiscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the surface fill color. The 'surfacecolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrrs3zScatter3d.surfacecolorcCs ||d<dS)Nrr)rrrrrr<scCs|dS)a Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-BszScatter3d.textcCs ||d<dS)Nr-r)rrrrrr-WscCs|dS)a The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scatter3d.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.scatter3d.Textfont r/r)rrrrr/]s*zScatter3d.textfontcCs ||d<dS)Nr/r)rrrrrr/scCs|dS)a/ Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1szScatter3d.textpositioncCs ||d<dS)Nr1r)rrrrrr1scCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2s zScatter3d.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zScatter3d.textsrccCs ||d<dS)Nr3r)rrrrrr3ʅscCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4ЅszScatter3d.texttemplatecCs ||d<dS)Nr4r)rrrrrr4scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5s zScatter3d.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7sz Scatter3d.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szScatter3d.uirevisioncCs ||d<dS)Nr8r)rrrrrr88scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9>szScatter3d.visiblecCs ||d<dS)Nr9r)rrrrrr9OscCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<Us z Scatter3d.xcCs ||d<dS)Nr<r)rrrrrr<cscCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrriszScatter3d.xcalendarcCs ||d<dS)Nrr)rrrrrr{scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s zScatter3d.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@s z Scatter3d.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszScatter3d.ycalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs zScatter3d.ysrccCs ||d<dS)NrCr)rrrrrrCφscCs|dS)z Sets the z coordinates. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrՆs z Scatter3d.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the calendar system to use with `z` date data. The 'zcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszScatter3d.zcalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zScatter3d.zsrccCs ||d<dS)Nrr)rrrrrrscCs |jdS)NrD)rE)rrrrrDszScatter3d.typecCsdS)NrFr)rrrrrGszScatter3d._parent_path_strcCsdS)Na( connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . error_x :class:`plotly.graph_objects.scatter3d.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.scatter3d.ErrorY` instance or dict with compatible properties error_z :class:`plotly.graph_objects.scatter3d.ErrorZ` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatter3d.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatter3d.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatter3d.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. projection :class:`plotly.graph_objects.scatter3d.Projection` instance or dict with compatible properties scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatter3d.Stream` instance or dict with compatible properties surfaceaxis If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively. surfacecolor Sets the surface fill color. text Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont :class:`plotly.graph_objects.scatter3d.Textfont` instance or dict with compatible properties textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates. zcalendar Sets the calendar system to use with `z` date data. zsrc Sets the source reference on plot.ly for z . r)rrrrrH!sWzScatter3d._prop_descriptionsNc26 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|2 dd|_ ddl m }3|3|jd<|3|jd <|3|jd <|3|jd <|3|jd <|3|jd <|3|jd<|3|jd<|3|jd<|3|jd<|3|jd<|3|jd<|3|jd<|3|jd<|3|jd<|3|jd<|3|jd<|3 |jd<|3!|jd<|3"|jd<|3#|jd<|3$|jd<|3%|jd<|3&|jd<|3'|jd <|3(|jd!<|3)|jd"<|3*|jd#<|3+|jd$<|3,|jd%<|3-|jd&<|3.|jd'<|3/|jd(<|30|jd)<|31|jd*<|32|jd+<|33|jd,<|34|jd-<|35|jd.<|36|jd/<|37|jd0<|38|jd1<|39|jd2<|3:|jd3<|3;|jd4<|3<|jd5<|3=|jd6<|3>|jd7<| dd}4|dk r&|n|4|d<| d d}4|dk rH|n|4|d <| d d}4|dk rj|n|4|d <| d d}4|dk r|n|4|d <| d d}4|dk r|n|4|d <| d d}4|dk r|n|4|d <| dd}4|dk r|n|4|d<| dd}4| dk r| n|4|d<| dd}4| dk r6| n|4|d<| dd}4| dk rX| n|4|d<| dd}4| dk rz| n|4|d<| dd}4| dk r| n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r$|n|4|d<| dd}4|dk rF|n|4|d<| dd}4|dk rh|n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r|n|4|d<| dd}4|dk r4|n|4|d<| d d}4|dk rV|n|4|d <| d!d}4|dk rx|n|4|d!<| d"d}4|dk r|n|4|d"<| d#d}4|dk r|n|4|d#<| d$d}4|dk r|n|4|d$<| d%d}4|dk r|n|4|d%<| d&d}4| dk r"| n|4|d&<| d'd}4|!dk rD|!n|4|d'<| d(d}4|"dk rf|"n|4|d(<| d)d}4|#dk r|#n|4|d)<| d*d}4|$dk r|$n|4|d*<| d+d}4|%dk r|%n|4|d+<| d,d}4|&dk r|&n|4|d,<| d-d}4|'dk r|'n|4|d-<| d.d}4|(dk r2|(n|4|d.<| d/d}4|)dk rT|)n|4|d/<| d0d}4|*dk rv|*n|4|d0<| d1d}4|+dk r|+n|4|d1<| d2d}4|,dk r|,n|4|d2<| d3d}4|-dk r|-n|4|d3<| d4d}4|.dk r|.n|4|d4<| d5d}4|/dk r |/n|4|d5<| d6d}4|0dk rB|0n|4|d6<| d7d}4|1dk rd|1n|4|d7<dd8l?m@}5d|jAd9<|5d9ddd:|jd9<| d9d|jBft|f|2d|_ dS);a7+ Construct a new Scatter3d object The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Scatter3d` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . error_x :class:`plotly.graph_objects.scatter3d.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.scatter3d.ErrorY` instance or dict with compatible properties error_z :class:`plotly.graph_objects.scatter3d.ErrorZ` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatter3d.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatter3d.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatter3d.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. projection :class:`plotly.graph_objects.scatter3d.Projection` instance or dict with compatible properties scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.scatter3d.Stream` instance or dict with compatible properties surfaceaxis If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively. surfacecolor Sets the surface fill color. text Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont :class:`plotly.graph_objects.scatter3d.Textfont` instance or dict with compatible properties textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates. zcalendar Sets the calendar system to use with `z` date data. zsrc Sets the source reference on plot.ly for z . Returns ------- Scatter3d scatter3dNzThe first argument to the plotly.graph_objs.Scatter3d constructor must be a dict or an instance of :class:`plotly.graph_objs.Scatter3d`rJFr)rrr rryrzrrrrrrrrrrrrrr!r"rKr#r'rrr+r,rrr-r/r1r2r3r4r5r7r8r9r<rr?r@rrCrrr)rKrD)rLrMr)CrNrrOrPrQrRrSrTrUrVrWrXrYrrr[r`rar|r}ZErrorZValidatorrerfrgrhrirjrkrlrmrqrrrrrsrTrtrxZProjectionValidatorrr|r}ZSurfaceaxisValidatorrr~rrrrrrrrrrrrrrrrr rrrKrEr)6rrrr rryrzrrrrrrrrrrrrrr!r"rKr#r'rrr+r,rrr-r/r1r2r3r4r5r7r8r9r<rr?r@rrCrrrrZ v_scatter3drrK)rQrrrOsH                                                        zScatter3d.__init__)1NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN):rrrrrrr rryrzrrrrrrrrrrrrrr!r"rKr#r'rrr+r,rrr-r/r1r2r3r4r5r7r8r9r<rr?r@rrCrrrrDrGrHrOrrr)rQrrs,    K K I   5 #       l             5  ,                    [rc>steZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZe>jddZ>eddZ?e?jddZ?eddZ@e@jddZ@eddZAeAjddZAeddZBeddZCeddZDdfdd ZEZFS)ScattercCs|dS)a Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. The 'cliponaxis' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr szScatter.cliponaxiscCs ||d<dS)Nr r)rrrrrr scCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrs zScatter.connectgapscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szScatter.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr%s zScatter.customdatasrccCs ||d<dS)Nrr)rrrrrr3scCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr9s z Scatter.dxcCs ||d<dS)Nrr)rrrrrrGscCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrMs z Scatter.dycCs ||d<dS)Nrr)rrrrrr[scCs|dS)a# The 'error_x' property is an instance of ErrorX that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. copy_ystyle symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.scatter.ErrorX ryr)rrrrryasIzScatter.error_xcCs ||d<dS)Nryr)rrrrrryscCs|dS)a The 'error_y' property is an instance of ErrorY that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.scatter.ErrorY rzr)rrrrrzsGzScatter.error_ycCs ||d<dS)Nrzr)rrrrrrzscCs|dS)a" Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill- linked traces are not already consecutive, the later ones will be pushed down in the drawing order. The 'fill' property is an enumeration that may be specified as: - One of the following enumeration values: ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', 'toself', 'tonext'] Returns ------- Any rJr)rrrrrJs z Scatter.fillcCs ||d<dS)NrJr)rrrrrrJ#scCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrr)s5zScatter.fillcolorcCs ||d<dS)Nrr)rrrrrr`scCs|dS)aI Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With "fraction", the value of each trace at each location is divided by the sum of all trace values at that location. "percent" is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set. The 'groupnorm' property is an enumeration that may be specified as: - One of the following enumeration values: ['', 'fraction', 'percent'] Returns ------- Any groupnormr)rrrrrfszScatter.groupnormcCs ||d<dS)Nrr)rrrrrr}scCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszScatter.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zScatter.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.scatter.Hoverlabel rr)rrrrrs3zScatter.hoverlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". The 'hoveron' property is a flaglist and may be specified as a string containing: - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns ------- Any rr)rrrrrszScatter.hoveroncCs ||d<dS)Nrr)rrrrrrscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrs!zScatter.hovertemplatecCs ||d<dS)Nrr)rrrrrr(scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr.s zScatter.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr<scCs|dS)ab Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrBszScatter.hovertextcCs ||d<dS)Nrr)rrrrrrVscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr\s zScatter.hovertextsrccCs ||d<dS)Nrr)rrrrrrjscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrpsz Scatter.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zScatter.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszScatter.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)aX The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the line color. dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). shape Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. simplify Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected. smoothing Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a "linear" shape). width Sets the line width (in px). Returns ------- plotly.graph_objs.scatter.Line rr)rrrrrs)z Scatter.linecCs ||d<dS)Nrr)rrrrrr܌scCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.scatter.marker.Col orBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . gradient :class:`plotly.graph_objects.scatter.marker.Gra dient` instance or dict with compatible properties line :class:`plotly.graph_objects.scatter.marker.Lin e` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. opacity Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. size Sets the marker size (in px). sizemin Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points. sizemode Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. sizeref Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. sizesrc Sets the source reference on plot.ly for size . symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.scatter.Marker rr)rrrrrszScatter.markercCs ||d<dS)Nrr)rrrrrrvscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!|sz Scatter.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zScatter.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any rKr)rrrrrKsz Scatter.modecCs ||d<dS)NrKr)rrrrrrKscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#ȍsz Scatter.namecCs ||d<dS)Nr#r)rrrrrr#؍scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'ލs zScatter.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)aF Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`. The 'orientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['v', 'h'] Returns ------- Any r(r)rrrrr(szScatter.orientationcCs ||d<dS)Nr(r)rrrrrr(scCs|dS)af r coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the radial coordinatesfor legacy polar chart only. The 'r' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rYr)rrrrrY sz Scatter.rcCs ||d<dS)NrYr)rrrrrrYscCs|dS)z Sets the source reference on plot.ly for r . The 'rsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r[r)rrrrr["s z Scatter.rsrccCs ||d<dS)Nr[r)rrrrrr[0scCs|dS)a The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatter.selected.M arker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatter.selected.T extfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatter.Selected rr)rrrrr6szScatter.selectedcCs ||d<dS)Nrr)rrrrrrPscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*VszScatter.selectedpointscCs ||d<dS)Nr*r)rrrrrr*hscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+ns zScatter.showlegendcCs ||d<dS)Nr+r)rrrrrr+}scCs|dS)a Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Determines how we handle locations at which other traces in this group have data but this one does not. With *infer zero* we insert a zero at these locations. With "interpolate" we linearly interpolate between existing values, and extrapolate a constant beyond the existing values. The 'stackgaps' property is an enumeration that may be specified as: - One of the following enumeration values: ['infer zero', 'interpolate'] Returns ------- Any stackgapsr)rrrrrszScatter.stackgapscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is "h"). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets the default `mode` to "lines" irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. The 'stackgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str stackgroupr)rrrrrszScatter.stackgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)ah The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.scatter.Stream r,r)rrrrr,szScatter.streamcCs ||d<dS)Nr,r)rrrrrr,ڎscCs|dS)ag t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the angular coordinatesfor legacy polar chart only. The 't' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray tr)rrrrrsz Scatter.tcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-sz Scatter.textcCs ||d<dS)Nr-r)rrrrrr- scCs|dS)a1 Sets the text font. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.scatter.Textfont r/r)rrrrr/s/zScatter.textfontcCs ||d<dS)Nr/r)rrrrrr/BscCs|dS)a/ Sets the positions of the `text` elements with respects to the (x,y) coordinates. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle left', 'middle center', 'middle right', 'bottom left', 'bottom center', 'bottom right'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1HszScatter.textpositioncCs ||d<dS)Nr1r)rrrrrr1[scCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2as zScatter.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2oscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3us zScatter.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4szScatter.texttemplatecCs ||d<dS)Nr4r)rrrrrr4scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5s zScatter.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5scCs|dS)z Sets the source reference on plot.ly for t . The 'tsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str tsrcr)rrrrrs z Scatter.tsrccCs ||d<dS)Nrr)rrrrrrΏscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7ԏsz Scatter.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szScatter.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.scatter.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.scatter.unselected .Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.scatter.unselected .Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.scatter.Unselected rr)rrrrr szScatter.unselectedcCs ||d<dS)Nrr)rrrrrr%scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9+szScatter.visiblecCs ||d<dS)Nr9r)rrrrrr9<scCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<Bs z Scatter.xcCs ||d<dS)Nr<r)rrrrrr<PscCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr=Vs z Scatter.x0cCs ||d<dS)Nr=r)rrrrrr=escCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>ksz Scatter.xaxiscCs ||d<dS)Nr>r)rrrrrr>~scCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszScatter.xcalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s z Scatter.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@s z Scatter.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAĐs z Scatter.y0cCs ||d<dS)NrAr)rrrrrrAӐscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBِsz Scatter.yaxiscCs ||d<dS)NrBr)rrrrrrBscCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszScatter.ycalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC s z Scatter.ysrccCs ||d<dS)NrCr)rrrrrrCscCs |jdS)NrD)rE)rrrrrDsz Scatter.typecCsdS)NrFr)rrrrrG$szScatter._parent_path_strcCsdS)Na? cliponaxis Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. error_x :class:`plotly.graph_objects.scatter.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.scatter.ErrorY` instance or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. groupnorm Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With "fraction", the value of each trace at each location is divided by the sum of all trace values at that location. "percent" is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatter.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatter.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatter.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. orientation Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`. r r coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the radial coordinatesfor legacy polar chart only. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.scatter.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stackgaps Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Determines how we handle locations at which other traces in this group have data but this one does not. With *infer zero* we insert a zero at these locations. With "interpolate" we linearly interpolate between existing values, and extrapolate a constant beyond the existing values. stackgroup Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is "h"). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets the default `mode` to "lines" irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. stream :class:`plotly.graph_objects.scatter.Stream` instance or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the angular coordinatesfor legacy polar chart only. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. texttemplatesrc Sets the source reference on plot.ly for texttemplate . tsrc Sets the source reference on plot.ly for t . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatter.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . r)rrrrrH*s?zScatter._prop_descriptionsNc?C s0 tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|? dd|_ ddl m }@|@|jd<|@|jd <|@|jd <|@|jd <|@|jd <|@|jd <|@|jd<|@|jd<|@|jd<|@|jd<|@|jd<|@|jd<|@|jd<|@|jd<|@|jd<|@|jd<|@|jd<|@ |jd<|@!|jd<|@"|jd<|@#|jd<|@$|jd<|@%|jd<|@&|jd<|@'|jd <|@(|jd!<|@)|jd"<|@*|jd#<|@+|jd$<|@,|jd%<|@-|jd&<|@.|jd'<|@/|jd(<|@0|jd)<|@1|jd*<|@2|jd+<|@3|jd,<|@4|jd-<|@5|jd.<|@6|jd/<|@7|jd0<|@8|jd1<|@9|jd2<|@:|jd3<|@;|jd4<|@<|jd5<|@=|jd6<|@>|jd7<|@?|jd8<|@@|jd9<|@A|jd:<|@B|jd;<|@C|jd<<|@D|jd=<|@E|jd><|@F|jd?<|@G|jd@<|@H|jdA<|@I|jdB<|@J|jdC<|@K|jdD<| dd}A|dk r|n|A|d<| d d}A|dk r|n|A|d <| d d}A|dk r |n|A|d <| d d}A|dk rB|n|A|d <| d d}A|dk rd|n|A|d <| d d}A|dk r|n|A|d <| dd}A|dk r|n|A|d<| dd}A| dk r| n|A|d<| dd}A| dk r| n|A|d<| dd}A| dk r| n|A|d<| dd}A| dk r0| n|A|d<| dd}A| dk rR| n|A|d<| dd}A|dk rt|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r@|n|A|d<| dd}A|dk rb|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r|n|A|d<| dd}A|dk r|n|A|d<| d d}A|dk r |n|A|d <| d!d}A|dk r.|n|A|d!<| d"d}A|dk rP|n|A|d"<| d#d}A|dk rr|n|A|d#<| d$d}A|dk r|n|A|d$<| d%d}A|dk r|n|A|d%<| d&d}A| dk r| n|A|d&<| d'd}A|!dk r|!n|A|d'<| d(d}A|"dk r|"n|A|d(<| d)d}A|#dk r>|#n|A|d)<| d*d}A|$dk r`|$n|A|d*<| d+d}A|%dk r|%n|A|d+<| d,d}A|&dk r|&n|A|d,<| d-d}A|'dk r|'n|A|d-<| d.d}A|(dk r|(n|A|d.<| d/d}A|)dk r |)n|A|d/<| d0d}A|*dk r,|*n|A|d0<| d1d}A|+dk rN|+n|A|d1<| d2d}A|,dk rp|,n|A|d2<| d3d}A|-dk r|-n|A|d3<| d4d}A|.dk r|.n|A|d4<| d5d}A|/dk r|/n|A|d5<| d6d}A|0dk r|0n|A|d6<| d7d}A|1dk r|1n|A|d7<| d8d}A|2dk r<|2n|A|d8<| d9d}A|3dk r^|3n|A|d9<| d:d}A|4dk r|4n|A|d:<| d;d}A|5dk r|5n|A|d;<| dd}A|8dk r|8n|A|d><| d?d}A|9dk r*|9n|A|d?<| d@d}A|:dk rL|:n|A|d@<| dAd}A|;dk rn|;n|A|dA<| dBd}A|dk r|>n|A|dD<ddElLmM}Bd|jNdF<|BdFdddG|jdF<| dFd|jOft|f|?d|_ dS)Ha+B Construct a new Scatter object The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in `x` and `y`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to numerical arrays. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Scatter` cliponaxis Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. error_x :class:`plotly.graph_objects.scatter.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.scatter.ErrorY` instance or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. groupnorm Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With "fraction", the value of each trace at each location is divided by the sum of all trace values at that location. "percent" is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.scatter.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points". hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.scatter.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.scatter.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines". name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. orientation Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`. r r coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the radial coordinatesfor legacy polar chart only. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.scatter.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stackgaps Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Determines how we handle locations at which other traces in this group have data but this one does not. With *infer zero* we insert a zero at these locations. With "interpolate" we linearly interpolate between existing values, and extrapolate a constant beyond the existing values. stackgroup Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is "h"). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets the default `mode` to "lines" irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. stream :class:`plotly.graph_objects.scatter.Stream` instance or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the angular coordinatesfor legacy polar chart only. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the text font. textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. texttemplatesrc Sets the source reference on plot.ly for texttemplate . tsrc Sets the source reference on plot.ly for t . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.scatter.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . Returns ------- Scatter scatterNzThe first argument to the plotly.graph_objs.Scatter constructor must be a dict or an instance of :class:`plotly.graph_objs.Scatter`rJFr)rr rr rrrryrzrJrrrrrrrrrrrrrrrr!r"rKr#r'r(rYr[rr*r+rrr,rr-r/r1r2r3r4r5rr7r8rr9r<r=r>rr?r@rArBrrC)rKrD)rLrMr)PrNrrOrPrQrRrSrTrUrVrWrXrYrr]r[rr`rarcrdr|r}rSrZGroupnormValidatorrerfrgrrhrirjrkrlrmrqrrrrrsrTrtrxryrcrerr{r|ZStackgapsValidatorZStackgroupValidatorr} TValidatorr~rrrrrr TsrcValidatorrrrrrrrrrrrrrrrrKrEr)Crrr rr rrrryrzrJrrrrrrrrrrrrrrrr!r"rKr#r'r(rYr[rr*r+rrr,rr-r/r1r2r3r4r5rr7r8rr9r<r=r>rr?r@rArBrrCrZ v_scatterrrK)rQrrrOis                                                                     zScatter.__init__)>NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Grrrrr rrr rrrryrzrJrrrrrrrrrrrrrrrr!r"rKr#r'r(rYr[rr*r+rrr,rr-r/r1r2r3r4r5rr7r8rr9r<r=r>rr?r@rArBrrCrDrGrHrOrrr)rQrrމs|       K I " 7    5  #       +                  1                       Crcs~eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZedEdFZedGdHZdLfdJdK ZZS)MSankeycCs|dS)a If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary. The 'arrangement' property is an enumeration that may be specified as: - One of the following enumeration values: ['snap', 'perpendicular', 'freeform', 'fixed'] Returns ------- Any arrangementr)rrrrrszSankey.arrangementcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szSankey.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zSankey.customdatasrccCs ||d<dS)Nrr)rrrrrr-scCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.sankey.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this sankey trace . row If there is a layout grid, use the domain for this row in the grid for this sankey trace . x Sets the horizontal domain of this sankey trace (in plot fraction). y Sets the vertical domain of this sankey trace (in plot fraction). Returns ------- plotly.graph_objs.sankey.Domain rr)rrrrr3sz Sankey.domaincCs ||d<dS)Nrr)rrrrrrQscCs|dS)a Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of [] joined with '+' characters (e.g. '') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') Returns ------- Any rr)rrrrrWszSankey.hoverinfocCs ||d<dS)Nrr)rrrrrrlscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.sankey.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.sankey.Hoverlabel rr)rrrrrrs3zSankey.hoverlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Sankey.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrÕs z Sankey.idssrccCs ||d<dS)Nrr)rrrrrrѕscCs|dS)a The links of the Sankey plot. The 'link' property is an instance of Link that may be specified as: - An instance of :class:`plotly.graph_objs.sankey.Link` - A dict of string/value properties that will be passed to the Link constructor Supported dict properties: color Sets the `link` color. It can be a single value, or an array for specifying color for each `link`. If `link.color` is omitted, then by default, a translucent grey link will be used. colorscales A tuple of :class:`plotly.graph_objects.sankey. link.Colorscale` instances or dicts with compatible properties colorscaledefaults When used in a template (as layout.template.dat a.sankey.link.colorscaledefaults), sets the default property values to use for elements of sankey.link.colorscales colorsrc Sets the source reference on plot.ly for color . hoverinfo Determines which trace information appear when hovering links. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverlabel :class:`plotly.graph_objects.sankey.link.Hoverl abel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs- events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . label The shown name of the link. labelsrc Sets the source reference on plot.ly for label . line :class:`plotly.graph_objects.sankey.link.Line` instance or dict with compatible properties source An integer number `[0..nodes.length - 1]` that represents the source node. sourcesrc Sets the source reference on plot.ly for source . target An integer number `[0..nodes.length - 1]` that represents the target node. targetsrc Sets the source reference on plot.ly for target . value A numeric value representing the flow volume value. valuesrc Sets the source reference on plot.ly for value . Returns ------- plotly.graph_objs.sankey.Link linkr)rrrrrוshz Sankey.linkcCs ||d<dS)Nrr)rrrrrrAscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!Gsz Sankey.metacCs ||d<dS)Nr!r)rrrrrr!]scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"cs zSankey.metasrccCs ||d<dS)Nr"r)rrrrrr"qscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#wsz Sankey.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)aj The nodes of the Sankey plot. The 'node' property is an instance of Node that may be specified as: - An instance of :class:`plotly.graph_objs.sankey.Node` - A dict of string/value properties that will be passed to the Node constructor Supported dict properties: color Sets the `node` color. It can be a single value, or an array for specifying color for each `node`. If `node.color` is omitted, then the default `Plotly` color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node. colorsrc Sets the source reference on plot.ly for color . groups Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified. hoverinfo Determines which trace information appear when hovering nodes. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverlabel :class:`plotly.graph_objects.sankey.node.Hoverl abel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs- events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . label The shown name of the node. labelsrc Sets the source reference on plot.ly for label . line :class:`plotly.graph_objects.sankey.node.Line` instance or dict with compatible properties pad Sets the padding (in px) between the `nodes`. thickness Sets the thickness (in px) of the `nodes`. x The normalized horizontal position of the node. xsrc Sets the source reference on plot.ly for x . y The normalized vertical position of the node. ysrc Sets the source reference on plot.ly for y . Returns ------- plotly.graph_objs.sankey.Node noder)rrrrrs_z Sankey.nodecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the orientation of the Sankey diagram. The 'orientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['v', 'h'] Returns ------- Any r(r)rrrrr(s zSankey.orientationcCs ||d<dS)Nr(r)rrrrrr(scCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr* szSankey.selectedpointscCs ||d<dS)Nr*r)rrrrrr*scCs|dS)af The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.sankey.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.sankey.Stream r,r)rrrrr,!sz Sankey.streamcCs ||d<dS)Nr,r)rrrrrr,<scCs|dS)a Sets the font for node labels The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.sankey.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.sankey.Textfont r/r)rrrrr/Bs%zSankey.textfontcCs ||d<dS)Nr/r)rrrrrr/iscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7osz Sankey.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szSankey.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Sets the value formatting rule using d3 formatting mini- language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'valueformat' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str valueformatr)rrrrrszSankey.valueformatcCs ||d<dS)Nrr)rrrrrrscCs|dS)aP Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value. The 'valuesuffix' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str valuesuffixr)rrrrrszSankey.valuesuffixcCs ||d<dS)Nrr)rrrrrrΗscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9ԗszSankey.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs |jdS)NrD)rE)rrrrrDsz Sankey.typecCsdS)NrFr)rrrrrGszSankey._parent_path_strcCsdS)Na arrangement If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . domain :class:`plotly.graph_objects.sankey.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. hoverlabel :class:`plotly.graph_objects.sankey.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . link The links of the Sankey plot. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. node The nodes of the Sankey plot. orientation Sets the orientation of the Sankey diagram. selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. stream :class:`plotly.graph_objects.sankey.Stream` instance or dict with compatible properties textfont Sets the font for node labels uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. valueformat Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format valuesuffix Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHsmzSankey._prop_descriptionsNc stt|d|dkri}n4t||jr4|}nt|trJt|}nt d| dd|_ ddl m }||jd<||jd <||jd <||jd <||jd <||jd <||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<| |jd<|!|jd<|"|jd<|#|jd<|$|jd<| dd}|dk r|n||d<| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r |n||d <| d d}|dk rB|n||d <| d d}|dk rd|n||d <| dd}|dk r|n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r0| n||d<| dd}|dk rR|n||d<| dd}|dk rt|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r@|n||d<| dd}|dk rb|n||d<| dd}|dk r|n||d<ddl%m&}d|j'd<|dddd |jd<| dd|j(ft|f|d|_ dS)!a Construct a new Sankey object Sankey plots for network flow data analysis. The nodes are specified in `nodes` and the links between sources and targets in `links`. The colors are set in `nodes[i].color` and `links[i].color`, otherwise defaults are used. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Sankey` arrangement If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . domain :class:`plotly.graph_objects.sankey.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. hoverlabel :class:`plotly.graph_objects.sankey.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . link The links of the Sankey plot. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. node The nodes of the Sankey plot. orientation Sets the orientation of the Sankey diagram. selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. stream :class:`plotly.graph_objects.sankey.Stream` instance or dict with compatible properties textfont Sets the font for node labels uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. valueformat Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format valuesuffix Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Sankey sankeyNzThe first argument to the plotly.graph_objs.Sankey constructor must be a dict or an instance of :class:`plotly.graph_objs.Sankey`rJFr)rrr rrrrrrrr!r"r#rr(r*r,r/r7r8rrr9)rKrD)rLrMr))rNrrOrPrQrRrSrTrUrVrWrXrYrArrangementValidatorr[r`rarrergrlrmZ LinkValidatorrrrsrtZ NodeValidatorryr{r}rrrZValueformatValidatorZValuesuffixValidatorrrrKrEr)rrrr rrrrrrrr!r"r#rr(r*r,r/r7r8rrr9rZv_sankeyrrK)rQrrrOfs                              zSankey.__init__)NNNNNNNNNNNNNNNNNNNNNNN) rrrrrrr rrrrrrrr!r"r#rr(r*r,r/r7r8rrr9rDrGrHrOrrr)rQrrs      5   j    a    '        qrc#seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'edidjZ(edkdlZ)dpfdndo Z*Z+S)q PointcloudcCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr zszPointcloud.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zPointcloud.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszPointcloud.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zPointcloud.hoverinfosrccCs ||d<dS)Nrr)rrrrrr͙scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.pointcloud.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.pointcloud.Hoverlabel rr)rrrrrәs3zPointcloud.hoverlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrszPointcloud.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr$s zPointcloud.idssrccCs ||d<dS)Nrr)rrrrrr2scCs|dS)a A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call. The 'indices' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray indicesr)rrrrr8szPointcloud.indicescCs ||d<dS)Nrr)rrrrrrLscCs|dS)z Sets the source reference on plot.ly for indices . The 'indicessrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str indicessrcr)rrrrrRs zPointcloud.indicessrccCs ||d<dS)Nrr)rrrrrr`scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrfszPointcloud.legendgroupcCs ||d<dS)Nrr)rrrrrrwscCs|dS)a# The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.pointcloud.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: blend Determines if colors are blended together for a translucency effect in case `opacity` is specified as a value less then `1`. Setting `blend` to `true` reduces zoom/pan speed if used with large numbers of points. border :class:`plotly.graph_objects.pointcloud.marker. Border` instance or dict with compatible properties color Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are hundreds of thousandsof points, it may cause slower zooming and panning. opacity Sets the marker opacity. The default value is `1` (fully opaque). If the markers are not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning. Opacity fades the color even if `blend` is left on `false` even if there is no translucency effect in that case. sizemax Sets the maximum size (in px) of the rendered marker points. Effective when the `pointcloud` shows only few points. sizemin Sets the minimum size (in px) of the rendered marker points, effective when the `pointcloud` shows a million or more points. Returns ------- plotly.graph_objs.pointcloud.Marker rr)rrrrr}s/zPointcloud.markercCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szPointcloud.metacCs ||d<dS)Nr!r)rrrrrr!ʚscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Кs zPointcloud.metasrccCs ||d<dS)Nr"r)rrrrrr"ޚscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#szPointcloud.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr's zPointcloud.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zPointcloud.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)an The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.pointcloud.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.pointcloud.Stream r,r)rrrrr,#szPointcloud.streamcCs ||d<dS)Nr,r)rrrrrr,>scCs|dS)a Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-DszPointcloud.textcCs ||d<dS)Nr-r)rrrrrr-YscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3_s zPointcloud.textsrccCs ||d<dS)Nr3r)rrrrrr3mscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7sszPointcloud.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szPointcloud.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szPointcloud.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<s z Pointcloud.xcCs ||d<dS)Nr<r)rrrrrr<ϛscCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>՛szPointcloud.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)a Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits. The 'xbounds' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray xboundsr)rrrrrszPointcloud.xboundscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for xbounds . The 'xboundssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str xboundssrcr)rrrrrs zPointcloud.xboundssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s zPointcloud.xsrccCs ||d<dS)Nr?r)rrrrrr?&scCs|dS)a Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]` The 'xy' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray xyr)rrrrr,sz Pointcloud.xycCs ||d<dS)Nrr)rrrrrr=scCs|dS)z Sets the source reference on plot.ly for xy . The 'xysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str xysrcr)rrrrrCs zPointcloud.xysrccCs ||d<dS)Nrr)rrrrrrQscCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@Ws z Pointcloud.ycCs ||d<dS)Nr@r)rrrrrr@escCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBkszPointcloud.yaxiscCs ||d<dS)NrBr)rrrrrrB~scCs|dS)a Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits. The 'ybounds' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray yboundsr)rrrrrszPointcloud.yboundscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ybounds . The 'yboundssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str yboundssrcr)rrrrrs zPointcloud.yboundssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs zPointcloud.ysrccCs ||d<dS)NrCr)rrrrrrCscCs |jdS)NrD)rE)rrrrrDœszPointcloud.typecCsdS)NrFr)rrrrrGȜszPointcloud._parent_path_strcCsdS)Nab customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.pointcloud.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . indices A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call. indicessrc Sets the source reference on plot.ly for indices . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.pointcloud.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.pointcloud.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbounds Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits. xboundssrc Sets the source reference on plot.ly for xbounds . xsrc Sets the source reference on plot.ly for x . xy Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]` xysrc Sets the source reference on plot.ly for xy . y Sets the y coordinates. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybounds Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits. yboundssrc Sets the source reference on plot.ly for ybounds . ysrc Sets the source reference on plot.ly for y . r)rrrrrHΜszPointcloud._prop_descriptionsNc$( s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|$ dd|_ ddl m }%|%|jd<|%|jd <|%|jd <|%|jd <|%|jd <|%|jd <|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|%|jd<|% |jd<|%!|jd<|%"|jd<|%#|jd<|%$|jd<|%%|jd<|%&|jd<|%'|jd <|%(|jd!<|%)|jd"<|%*|jd#<|%+|jd$<|%,|jd%<|%-|jd&<|%.|jd'<|%/|jd(<|%0|jd)<| dd}&|dk rb|n|&|d<| d d}&|dk r|n|&|d <| d d}&|dk r|n|&|d <| d d}&|dk r|n|&|d <| d d}&|dk r|n|&|d <| d d}&|dk r |n|&|d <| dd}&|dk r.|n|&|d<| dd}&| dk rP| n|&|d<| dd}&| dk rr| n|&|d<| dd}&| dk r| n|&|d<| dd}&| dk r| n|&|d<| dd}&| dk r| n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r>|n|&|d<| dd}&|dk r`|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r|n|&|d<| dd}&|dk r |n|&|d<| dd}&|dk r,|n|&|d<| dd}&|dk rN|n|&|d<| dd}&|dk rp|n|&|d<| d d}&|dk r|n|&|d <| d!d}&|dk r|n|&|d!<| d"d}&|dk r|n|&|d"<| d#d}&|dk r|n|&|d#<| d$d}&|dk r|n|&|d$<| d%d}&|dk r<|n|&|d%<| d&d}&| dk r^| n|&|d&<| d'd}&|!dk r|!n|&|d'<| d(d}&|"dk r|"n|&|d(<| d)d}&|#dk r|#n|&|d)<dd*l1m2}'d|j3d+<|'d+ddd,|jd+<| d+d|j4ft|f|$d|_ dS)-a Construct a new Pointcloud object The data visualized as a point cloud set in `x` and `y` using the WebGl plotting engine. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Pointcloud` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.pointcloud.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . indices A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call. indicessrc Sets the source reference on plot.ly for indices . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.pointcloud.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.pointcloud.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbounds Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits. xboundssrc Sets the source reference on plot.ly for xbounds . xsrc Sets the source reference on plot.ly for x . xy Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]` xysrc Sets the source reference on plot.ly for xy . y Sets the y coordinates. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybounds Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits. yboundssrc Sets the source reference on plot.ly for ybounds . ysrc Sets the source reference on plot.ly for y . Returns ------- Pointcloud pointcloudNzThe first argument to the plotly.graph_objs.Pointcloud constructor must be a dict or an instance of :class:`plotly.graph_objs.Pointcloud`rJFr)rr rrrrrrrrrrr!r"r#r'r+r,r-r3r7r8r9r<r>rrr?rrr@rBrrrC)rKrD)rLrMr)5rNrrOrPrQrRrSrTrUrVrWrXrYrr`r[rarerfrgrlrmZIndicesValidatorZIndicessrcValidatorrqrrrrsrtrxr|r}r~rrrrrrZXboundsValidatorZXboundssrcValidatorrZ XyValidatorZXysrcValidatorrrZYboundsValidatorZYboundssrcValidatorrrrKrEr)(rrr rrrrrrrrrrr!r"r#r'r+r,r-r3r7r8r9r<r>rrr?rrr@rBrrrCrZ v_pointcloudrrK)rQrrrObsG                                          zPointcloud.__init__)#NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN),rrrrr rrrrrrrrrrrr!r"r#r'r+r,r-r3r7r8r9r<r>rrr?rrr@rBrrrCrDrGrHrOrrr)rQrrvs     5      1                          rc4szeZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8eddZ9eddZ:dddZ;dfdd Z<Z=S)PiecCs|dS)z Determines whether outside text labels can push the margins. The 'automargin' property must be specified as a bool (either True, or False) Returns ------- bool automarginr)rrrrrɞs zPie.automargincCs ||d<dS)Nrr)rrrrrrמscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr ݞszPie.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zPie.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aG Specifies the direction at which succeeding sectors follow one another. The 'direction' property is an enumeration that may be specified as: - One of the following enumeration values: ['clockwise', 'counterclockwise'] Returns ------- Any directionr)rrrrrsz Pie.directioncCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the label step. See `label0` for more info. The 'dlabel' property is a number and may be specified as: - An int or float Returns ------- int|float dlabelr)rrrrrs z Pie.dlabelcCs ||d<dS)Nrr)rrrrrr,scCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this pie trace . row If there is a layout grid, use the domain for this row in the grid for this pie trace . x Sets the horizontal domain of this pie trace (in plot fraction). y Sets the vertical domain of this pie trace (in plot fraction). Returns ------- plotly.graph_objs.pie.Domain rr)rrrrr2sz Pie.domaincCs ||d<dS)Nrr)rrrrrrPscCs|dS)a Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. The 'hole' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float holer)rrrrrVs zPie.holecCs ||d<dS)Nrr)rrrrrrescCs|dS)au Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrksz Pie.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zPie.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.pie.Hoverlabel rr)rrrrrs3zPie.hoverlabelcCs ||d<dS)Nrr)rrrrrrΟscCs|dS)a` Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrԟs"zPie.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zPie.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr scCs|dS)aK Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrsz Pie.hovertextcCs ||d<dS)Nrr)rrrrrr&scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr,s zPie.hovertextsrccCs ||d<dS)Nrr)rrrrrr:scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr@szPie.idscCs ||d<dS)Nrr)rrrrrrPscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrVs z Pie.idssrccCs ||d<dS)Nrr)rrrrrrdscCs|dS)an Sets the font used for `textinfo` lying inside the sector. The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.pie.Insidetextfont rr)rrrrrjs/zPie.insidetextfontcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector. The 'insidetextorientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['horizontal', 'radial', 'tangential', 'auto'] Returns ------- Any r"r)rrrrr"szPie.insidetextorientationcCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a= Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step. The 'label0' property is a number and may be specified as: - An int or float Returns ------- int|float label0r)rrrrrsz Pie.label0cCs ||d<dS)Nrr)rrrrrr͠scCs|dS)a Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label. The 'labels' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrӠsz Pie.labelscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for labels . The 'labelssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Pie.labelssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszPie.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a\ The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: colors Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors. colorssrc Sets the source reference on plot.ly for colors . line :class:`plotly.graph_objects.pie.marker.Line` instance or dict with compatible properties Returns ------- plotly.graph_objs.pie.Marker rr)rrrrrsz Pie.markercCs ||d<dS)Nrr)rrrrrr2scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!8szPie.metacCs ||d<dS)Nr!r)rrrrrr!NscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Ts z Pie.metasrccCs ||d<dS)Nr"r)rrrrrr"bscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#hszPie.namecCs ||d<dS)Nr#r)rrrrrr#xscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'~s z Pie.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)at Sets the font used for `textinfo` lying outside the sector. The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.pie.Outsidetextfont r)r)rrrrr)s/zPie.outsidetextfontcCs ||d<dS)Nr)r)rrrrrr)áscCs|dS)a Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices. The 'pull' property is a number and may be specified as: - An int or float in the interval [0, 1] - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray pullr)rrrrrɡszPie.pullcCs ||d<dS)Nrr)rrrrrrۡscCs|dS)z Sets the source reference on plot.ly for pull . The 'pullsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str pullsrcr)rrrrrs z Pie.pullsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a Instead of the first slice starting at 12 o'clock, rotate to some other angle. The 'rotation' property is a number and may be specified as: - An int or float in the interval [-360, 360] Returns ------- int|float rotationr)rrrrrs z Pie.rotationcCs ||d<dS)Nrr)rrrrrrscCs|dS)a If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group. The 'scalegroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr szPie.scalegroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+!s zPie.showlegendcCs ||d<dS)Nr+r)rrrrrr+0scCs|dS)z Determines whether or not the sectors are reordered from largest to smallest. The 'sort' property must be specified as a bool (either True, or False) Returns ------- bool sortr)rrrrr6s zPie.sortcCs ||d<dS)Nrr)rrrrrrEscCs|dS)a` The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.pie.Stream r,r)rrrrr,Ksz Pie.streamcCs ||d<dS)Nr,r)rrrrrr,fscCs|dS)a Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-lszPie.textcCs ||d<dS)Nr-r)rrrrrr-~scCs|dS)a8 Sets the font used for `textinfo`. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.pie.Textfont r/r)rrrrr/s/z Pie.textfontcCs ||d<dS)Nr/r)rrrrrr/scCs|dS)a Determines which trace information appear on the graph. The 'textinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any r0r)rrrrr0sz Pie.textinfocCs ||d<dS)Nr0r)rrrrrr0̢scCs|dS)a} Specifies the location of the `textinfo`. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['inside', 'outside', 'auto', 'none'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1ҢszPie.textpositioncCs ||d<dS)Nr1r)rrrrrr1scCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2s zPie.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s z Pie.textsrccCs ||d<dS)Nr3r)rrrrrr3 scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4szPie.texttemplatecCs ||d<dS)Nr4r)rrrrrr4.scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr54s zPie.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5BscCs|dS)a The 'title' property is an instance of Title that may be specified as: - An instance of :class:`plotly.graph_objs.pie.Title` - A dict of string/value properties that will be passed to the Title constructor Supported dict properties: font Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute. position Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute. text Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated. Returns ------- plotly.graph_objs.pie.Title titler)rrrrrHsz Pie.titlecCs ||d<dS)Nrr)rrrrrrhscCs|dS)a Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute. The 'font' property is an instance of Font that may be specified as: - An instance of :class:`plotly.graph_objs.pie.title.Font` - A dict of string/value properties that will be passed to the Font constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- titlefontr)rrrrrns1z Pie.titlefontcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Deprecated: Please use pie.title.position instead. Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute. The 'position' property is an enumeration that may be specified as: - One of the following enumeration values: ['top left', 'top center', 'top right', 'middle center', 'bottom left', 'bottom center', 'bottom right'] Returns ------- titlepositionr)rrrrrszPie.titlepositioncCs ||d<dS)Nrr)rrrrrrscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7szPie.uidcCs ||d<dS)Nr7r)rrrrrr7ϣscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8գszPie.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Sets the values of the sectors. If omitted, we count occurrences of each label. The 'values' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs z Pie.valuescCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for values . The 'valuessrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr s z Pie.valuessrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9sz Pie.visiblecCs ||d<dS)Nr9r)rrrrrr90scCs |jdS)NrD)rE)rrrrrD6szPie.typecCsdS)NrFr)rrrrrG<szPie._parent_path_strcCsdS)Na- automargin Determines whether outside text labels can push the margins. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . direction Specifies the direction at which succeeding sectors follow one another. dlabel Sets the label step. See `label0` for more info. domain :class:`plotly.graph_objects.pie.Domain` instance or dict with compatible properties hole Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.pie.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. insidetextorientation Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector. label0 Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step. labels Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label. labelssrc Sets the source reference on plot.ly for labels . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.pie.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. outsidetextfont Sets the font used for `textinfo` lying outside the sector. pull Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices. pullsrc Sets the source reference on plot.ly for pull . rotation Instead of the first slice starting at 12 o'clock, rotate to some other angle. scalegroup If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. sort Determines whether or not the sectors are reordered from largest to smallest. stream :class:`plotly.graph_objects.pie.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textposition Specifies the location of the `textinfo`. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . title :class:`plotly.graph_objects.pie.Title` instance or dict with compatible properties titlefont Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleposition Deprecated: Please use pie.title.position instead. Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values of the sectors. If omitted, we count occurrences of each label. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHBsmzPie._prop_descriptions)rfont)rposition)rrNc59 sP tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|5 dd|_ ddl m }6|6|jd<|6|jd <|6|jd <|6|jd <|6|jd <|6|jd <|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6 |jd<|6!|jd<|6"|jd<|6#|jd<|6$|jd<|6%|jd<|6&|jd<|6'|jd <|6(|jd!<|6)|jd"<|6*|jd#<|6+|jd$<|6,|jd%<|6-|jd&<|6.|jd'<|6/|jd(<|60|jd)<|61|jd*<|62|jd+<|63|jd,<|64|jd-<|65|jd.<|66|jd/<|67|jd0<|68|jd1<|69|jd2<|6:|jd3<|6;|jd4<|6<|jd5<|6=|jd6<|6>|jd7<|6?|jd8<| dd}7|dk r4|n|7|d<| d d}7|dk rV|n|7|d <| d d}7|dk rx|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| dd}7|dk r|n|7|d<| dd}7| dk r"| n|7|d<| dd}7| dk rD| n|7|d<| dd}7| dk rf| n|7|d<| dd}7| dk r| n|7|d<| dd}7| dk r| n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r2|n|7|d<| dd}7|dk rT|n|7|d<| dd}7|dk rv|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r |n|7|d<| dd}7|dk rB|n|7|d<| d d}7|dk rd|n|7|d <| d!d}7|dk r|n|7|d!<| d"d}7|dk r|n|7|d"<| d#d}7|dk r|n|7|d#<| d$d}7|dk r|n|7|d$<| d%d}7|dk r|n|7|d%<| d&d}7| dk r0| n|7|d&<| d'd}7|!dk rR|!n|7|d'<| d(d}7|"dk rt|"n|7|d(<| d)d}7|#dk r|#n|7|d)<| d*d}7|$dk r|$n|7|d*<| d+d}7|%dk r|%n|7|d+<| d,d}7|&dk r|&n|7|d,<| d-d}7|'dk r|'n|7|d-<| d.d}7|(dk r@|(n|7|d.<| d/d}7|)dk rb|)n|7|d/<| d0d}7|*dk r|*n|7|d0<| d1d}7|+dk r|+n|7|d1<| d2d}7|,dk r|,n|7|d2<| d3d}7|-dk r|-n|7|d3<| d9d}7|.dk r |.n|7}7|7dk r"|7|d9<| d:d}7|/dk r<|/n|7}7|7dk rR|7|d:<| d4d}7|0dk rl|0n|7|d4<| d5d}7|1dk r|1n|7|d5<| d6d}7|2dk r|2n|7|d6<| d7d}7|3dk r|3n|7|d7<| d8d}7|4dk r|4n|7|d8<dd;l@mA}8d|jBd<<|8da. Construct a new Pie object A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors` Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Pie` automargin Determines whether outside text labels can push the margins. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . direction Specifies the direction at which succeeding sectors follow one another. dlabel Sets the label step. See `label0` for more info. domain :class:`plotly.graph_objects.pie.Domain` instance or dict with compatible properties hole Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.pie.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. insidetextorientation Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector. label0 Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step. labels Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label. labelssrc Sets the source reference on plot.ly for labels . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.pie.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. outsidetextfont Sets the font used for `textinfo` lying outside the sector. pull Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices. pullsrc Sets the source reference on plot.ly for pull . rotation Instead of the first slice starting at 12 o'clock, rotate to some other angle. scalegroup If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. sort Determines whether or not the sectors are reordered from largest to smallest. stream :class:`plotly.graph_objects.pie.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textposition Specifies the location of the `textinfo`. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . title :class:`plotly.graph_objects.pie.Title` instance or dict with compatible properties titlefont Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleposition Deprecated: Please use pie.title.position instead. Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values of the sectors. If omitted, we count occurrences of each label. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Pie pieNz}The first argument to the plotly.graph_objs.Pie constructor must be a dict or an instance of :class:`plotly.graph_objs.Pie`rJFr)rrr rrrrrrrrrrrrrrrr"rrrrrr!r"r#r'r)rrrrr+rr,r-r/r0r1r2r3r4r5rr7r8rrr9rr)rKrD)rLrMr)DrNrrOrPrQrRrSrTrUrVrWrXrYrZAutomarginValidatorr[r`raDirectionValidatorDlabelValidatorrZ HoleValidatorrerfrgrhrirjrkrlrmrpr%Label0ValidatorrrrqrrrrsrtrxrzZ PullValidatorZPullsrcValidatorZRotationValidatorrr|Z SortValidatorr}r~rrrrrrrTitleValidatorrrrr rrrKrEr)9rrrr rrrrrrrrrrrrrrrr"rrrrrr!r"r#r'r)rrrrr+rr,r-r/r0r1r2r3r4r5rrrr7r8rrr9rZv_pierrK)rQrrrO5s^4                                                             z Pie.__init__)4NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)>rrrrrrr rrrrrrrrrrrrrrrr"rrrrrr!r"r#r'r)rrrrr+rr,r-r/r0r1r2r3r4r5rrrr7r8rrr9rDrGrH_mapped_propertiesrOrrr)rQrrŞs@          5 $      1           1         1        3         prcsJeZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZed?d@ZedAdBZdFfdDdE ZZS)G ParcoordscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr CszParcoords.customdatacCs ||d<dS)Nr r)rrrrrr TscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrZs zParcoords.customdatasrccCs ||d<dS)Nrr)rrrrrrhscCs|dS)a# The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported. The 'dimensions' property is a tuple of instances of Dimension that may be specified as: - A list or tuple of instances of plotly.graph_objs.parcoords.Dimension - A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor Supported dict properties: constraintrange The domain range to which the filter on the dimension is constrained. Must be an array of `[fromValue, toValue]` with `fromValue <= toValue`, or if `multiselect` is not disabled, you may give an array of arrays, where each inner array is `[fromValue, toValue]`. label The shown name of the dimension. multiselect Do we allow multiple selection ranges or just a single range? name When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. range The domain range that represents the full, shown axis extent. Defaults to the `values` extent. Must be an array of `[fromValue, toValue]` with finite numbers as elements. templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ticktext Sets the text displayed at the ticks position via `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. tickvalssrc Sets the source reference on plot.ly for tickvals . values Dimension values. `values[n]` represents the value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated). Each value must be a finite number. valuessrc Sets the source reference on plot.ly for values . visible Shows the dimension when set to `true` (the default). Hides the dimension for `false`. Returns ------- tuple[plotly.graph_objs.parcoords.Dimension] r:r)rrrrr:ns`zParcoords.dimensionscCs ||d<dS)Nr:r)rrrrrr:ЧscCs|dS)aa When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - An instance of :class:`plotly.graph_objs.parcoords.Dimension` - A dict of string/value properties that will be passed to the Dimension constructor Supported dict properties: Returns ------- plotly.graph_objs.parcoords.Dimension r;r)rrrrr;֧szParcoords.dimensiondefaultscCs ||d<dS)Nr;r)rrrrrr;scCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.parcoords.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this parcoords trace . row If there is a layout grid, use the domain for this row in the grid for this parcoords trace . x Sets the horizontal domain of this parcoords trace (in plot fraction). y Sets the vertical domain of this parcoords trace (in plot fraction). Returns ------- plotly.graph_objs.parcoords.Domain rr)rrrrrszParcoords.domaincCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Parcoords.idscCs ||d<dS)Nrr)rrrrrr'scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr-s zParcoords.idssrccCs ||d<dS)Nrr)rrrrrr;scCs|dS)a@ Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom". The 'labelangle' property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90). Returns ------- int|float labelangler)rrrrrAszParcoords.labelanglecCs ||d<dS)Nrr)rrrrrrTscCs|dS)a Sets the font for the `dimension` labels. The 'labelfont' property is an instance of Labelfont that may be specified as: - An instance of :class:`plotly.graph_objs.parcoords.Labelfont` - A dict of string/value properties that will be passed to the Labelfont constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.parcoords.Labelfont labelfontr)rrrrrZs%zParcoords.labelfontcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Specifies the location of the `label`. "top" positions labels above, next to the title "bottom" positions labels below the graph Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom". The 'labelside' property is an enumeration that may be specified as: - One of the following enumeration values: ['top', 'bottom'] Returns ------- Any labelsider)rrrrrszParcoords.labelsidecCs ||d<dS)Nrr)rrrrrrscCs|dS)ah The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.parcoords.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well. color Sets thelinecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.parcoords.line.Col orBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri c,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . reversescale Reverses the color mapping if true. Has an effect only if in `line.color`is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array. Returns ------- plotly.graph_objs.parcoords.Line rr)rrrrrsfzParcoords.linecCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr! szParcoords.metacCs ||d<dS)Nr!r)rrrrrr!#scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr")s zParcoords.metasrccCs ||d<dS)Nr"r)rrrrrr"7scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#=szParcoords.namecCs ||d<dS)Nr#r)rrrrrr#MscCs|dS)a Sets the font for the `dimension` range values. The 'rangefont' property is an instance of Rangefont that may be specified as: - An instance of :class:`plotly.graph_objs.parcoords.Rangefont` - A dict of string/value properties that will be passed to the Rangefont constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.parcoords.Rangefont rangefontr)rrrrrSs%zParcoords.rangefontcCs ||d<dS)Nrr)rrrrrrzscCs|dS)al The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.parcoords.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.parcoords.Stream r,r)rrrrr,szParcoords.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a Sets the font for the `dimension` tick values. The 'tickfont' property is an instance of Tickfont that may be specified as: - An instance of :class:`plotly.graph_objs.parcoords.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.parcoords.Tickfont tickfontr)rrrrrs%zParcoords.tickfontcCs ||d<dS)Nrr)rrrrrrȩscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7Ωsz Parcoords.uidcCs ||d<dS)Nr7r)rrrrrr7ީscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szParcoords.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szParcoords.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs |jdS)NrD)rE)rrrrrDszParcoords.typecCsdS)NrFr)rrrrrG"szParcoords._parent_path_strcCsdS)Na* customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dimensions The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported. dimensiondefaults When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions domain :class:`plotly.graph_objects.parcoords.Domain` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . labelangle Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom". labelfont Sets the font for the `dimension` labels. labelside Specifies the location of the `label`. "top" positions labels above, next to the title "bottom" positions labels below the graph Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom". line :class:`plotly.graph_objects.parcoords.Line` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. rangefont Sets the font for the `dimension` range values. stream :class:`plotly.graph_objects.parcoords.Stream` instance or dict with compatible properties tickfont Sets the font for the `dimension` tick values. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrH(s`zParcoords._prop_descriptionsNc stt|d|dkri}n4t||jr4|}nt|trJt|}nt d| dd|_ ddl m }||jd<||jd <||jd <||jd <||jd <||jd <||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<| |jd<|!|jd<|"|jd<| dd}|dk r|n||d<| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r&|n||d <| d d}|dk rH|n||d <| dd}|dk rj|n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}|dk r6|n||d<| dd}|dk rX|n||d<| dd}|dk rz|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r$|n||d<ddl#m$}d|j%d<|dddd|jd<| dd|j&ft|f|d|_ dS)a Construct a new Parcoords object Parallel coordinates for multidimensional exploratory data analysis. The samples are specified in `dimensions`. The colors are set in `line.color`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Parcoords` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dimensions The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported. dimensiondefaults When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions domain :class:`plotly.graph_objects.parcoords.Domain` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . labelangle Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom". labelfont Sets the font for the `dimension` labels. labelside Specifies the location of the `label`. "top" positions labels above, next to the title "bottom" positions labels below the graph Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom". line :class:`plotly.graph_objects.parcoords.Line` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. rangefont Sets the font for the `dimension` range values. stream :class:`plotly.graph_objects.parcoords.Stream` instance or dict with compatible properties tickfont Sets the font for the `dimension` tick values. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Parcoords parcoordsNzThe first argument to the plotly.graph_objs.Parcoords constructor must be a dict or an instance of :class:`plotly.graph_objs.Parcoords`rJFr)rr rr:r;rrrrrrrr!r"r#rr,rr7r8r9)rKrD)rLrMr)'rNrrOrPrQrRrSrTrUrVrWrXrYrr`r[rarArBrrlrmZLabelangleValidatorLabelfontValidatorZLabelsideValidatorrrrrsrtZRangefontValidatorr}TickfontValidatorrrrrrKrEr)rrr rr:r;rrrrrrrr!r"r#rr,rr7r8r9rZ v_parcoordsrrK)rQrrrOs                            zParcoords.__init__)NNNNNNNNNNNNNNNNNNNNN)rrrrr rrr:r;rrrrrrrr!r"r#rr,rr7r8r9rDrGrHrOrrr)rQrr?s   b      '  h    '  '      drcsdeZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZedBdCZedDdEZdIfdGdH ZZS)JParcatscCs|dS)a, Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary. The 'arrangement' property is an enumeration that may be specified as: - One of the following enumeration values: ['perpendicular', 'freeform', 'fixed'] Returns ------- Any rr)rrrrrszParcats.arrangementcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sort paths so that like colors are bundled together within each category. The 'bundlecolors' property must be specified as a bool (either True, or False) Returns ------- bool bundlecolorsr)rrrrrs zParcats.bundlecolorscCs ||d<dS)Nrr)rrrrrrscCs|dS)a The number of observations represented by each state. Defaults to 1 so that each state represents one observation The 'counts' property is a number and may be specified as: - An int or float in the interval [0, inf] - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray countsr)rrrrrszParcats.countscCs ||d<dS)Nrr)rrrrrrȫscCs|dS)z Sets the source reference on plot.ly for counts . The 'countssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str countssrcr)rrrrrΫs zParcats.countssrccCs ||d<dS)Nrr)rrrrrrܫscCs|dS)aH The dimensions (variables) of the parallel categories diagram. The 'dimensions' property is a tuple of instances of Dimension that may be specified as: - A list or tuple of instances of plotly.graph_objs.parcats.Dimension - A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor Supported dict properties: categoryarray Sets the order in which categories in this dimension appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`. categoryarraysrc Sets the source reference on plot.ly for categoryarray . categoryorder Specifies the ordering logic for the categories in the dimension. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. displayindex The display index of dimension, from left to right, zero indexed, defaults to dimension index. label The shown name of the dimension. ticktext Sets alternative tick labels for the categories in this dimension. Only has an effect if `categoryorder` is set to "array". Should be an array the same length as `categoryarray` Used with `categoryorder`. ticktextsrc Sets the source reference on plot.ly for ticktext . values Dimension values. `values[n]` represents the category value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated). valuessrc Sets the source reference on plot.ly for values . visible Shows the dimension when set to `true` (the default). Hides the dimension for `false`. Returns ------- tuple[plotly.graph_objs.parcats.Dimension] r:r)rrrrr:sDzParcats.dimensionscCs ||d<dS)Nr:r)rrrrrr:(scCs|dS)aY When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - An instance of :class:`plotly.graph_objs.parcats.Dimension` - A dict of string/value properties that will be passed to the Dimension constructor Supported dict properties: Returns ------- plotly.graph_objs.parcats.Dimension r;r)rrrrr;.szParcats.dimensiondefaultscCs ||d<dS)Nr;r)rrrrrr;DscCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.parcats.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this parcats trace . row If there is a layout grid, use the domain for this row in the grid for this parcats trace . x Sets the horizontal domain of this parcats trace (in plot fraction). y Sets the vertical domain of this parcats trace (in plot fraction). Returns ------- plotly.graph_objs.parcats.Domain rr)rrrrrJszParcats.domaincCs ||d<dS)Nrr)rrrrrriscCs|dS)a0 Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['count', 'probability'] joined with '+' characters (e.g. 'count+probability') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') Returns ------- Any rr)rrrrroszParcats.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension. The 'hoveron' property is an enumeration that may be specified as: - One of the following enumeration values: ['category', 'color', 'dimension'] Returns ------- Any rr)rrrrrszParcats.hoveroncCs ||d<dS)Nrr)rrrrrrscCs|dS)a2 Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrs!zParcats.hovertemplatecCs ||d<dS)Nrr)rrrrrrĬscCs|dS)a Sets the font for the `dimension` labels. The 'labelfont' property is an instance of Labelfont that may be specified as: - An instance of :class:`plotly.graph_objs.parcats.Labelfont` - A dict of string/value properties that will be passed to the Labelfont constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.parcats.Labelfont rr)rrrrrʬs%zParcats.labelfontcCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.parcats.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well. color Sets thelinecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.parcats.line.Color Bar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri c,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs- events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `count` and `probability`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. reversescale Reverses the color mapping if true. Has an effect only if in `line.color`is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color. shape Sets the shape of the paths. If `linear`, paths are composed of straight lines. If `hspline`, paths are composed of horizontal curved splines showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array. Returns ------- plotly.graph_objs.parcats.Line rr)rrrrrsz Parcats.linecCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!sz Parcats.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zParcats.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#sz Parcats.namecCs ||d<dS)Nr#r)rrrrrr#ƭscCs|dS)a Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left. The 'sortpaths' property is an enumeration that may be specified as: - One of the following enumeration values: ['forward', 'backward'] Returns ------- Any sortpathsr)rrrrr̭szParcats.sortpathscCs ||d<dS)Nrr)rrrrrrݭscCs|dS)ah The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.parcats.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.parcats.Stream r,r)rrrrr,szParcats.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a Sets the font for the `category` labels. The 'tickfont' property is an instance of Tickfont that may be specified as: - An instance of :class:`plotly.graph_objs.parcats.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.parcats.Tickfont rr)rrrrrs%zParcats.tickfontcCs ||d<dS)Nrr)rrrrrr+scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr71sz Parcats.uidcCs ||d<dS)Nr7r)rrrrrr7AscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8GszParcats.uirevisioncCs ||d<dS)Nr8r)rrrrrr8bscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9hszParcats.visiblecCs ||d<dS)Nr9r)rrrrrr9yscCs |jdS)NrD)rE)rrrrrDsz Parcats.typecCsdS)NrFr)rrrrrGszParcats._parent_path_strcCsdS)Na arrangement Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary. bundlecolors Sort paths so that like colors are bundled together within each category. counts The number of observations represented by each state. Defaults to 1 so that each state represents one observation countssrc Sets the source reference on plot.ly for counts . dimensions The dimensions (variables) of the parallel categories diagram. dimensiondefaults When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions domain :class:`plotly.graph_objects.parcats.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoveron Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension. hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. labelfont Sets the font for the `dimension` labels. line :class:`plotly.graph_objects.parcats.Line` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. sortpaths Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left. stream :class:`plotly.graph_objects.parcats.Stream` instance or dict with compatible properties tickfont Sets the font for the `category` labels. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHszParcats._prop_descriptionsNc stt|d|dkri}n4t||jr4|}nt|trJt|}nt d| dd|_ ddl m }||jd<||jd <||jd <||jd <||jd <||jd <||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<| |jd<|!|jd<|"|jd<|#|jd<| dd}|dk r|n||d<| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r4|n||d <| d d}|dk rV|n||d <| dd}|dk rx|n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r"| n||d<| dd}|dk rD|n||d<| dd}|dk rf|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r2|n||d<| dd}|dk rT|n||d<ddl$m%}d|j&d<|dddd|jd<| dd|j'ft|f|d|_ dS) aA Construct a new Parcats object Parallel categories diagram for multidimensional categorical data. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Parcats` arrangement Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary. bundlecolors Sort paths so that like colors are bundled together within each category. counts The number of observations represented by each state. Defaults to 1 so that each state represents one observation countssrc Sets the source reference on plot.ly for counts . dimensions The dimensions (variables) of the parallel categories diagram. dimensiondefaults When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions domain :class:`plotly.graph_objects.parcats.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoveron Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension. hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. labelfont Sets the font for the `dimension` labels. line :class:`plotly.graph_objects.parcats.Line` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. sortpaths Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left. stream :class:`plotly.graph_objects.parcats.Stream` instance or dict with compatible properties tickfont Sets the font for the `category` labels. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Parcats parcatsNzThe first argument to the plotly.graph_objs.Parcats constructor must be a dict or an instance of :class:`plotly.graph_objs.Parcats`rJFr)rrrrrr:r;rrrrrrr!r"r#rr,rr7r8r9)rKrD)rLrMr)(rNrrOrPrQrRrSrTrUrVrWrXrYrrr[ZBundlecolorsValidatorZCountsValidatorZCountssrcValidatorrArBrrerrhrrrrrsrtZSortpathsValidatorr}rrrrrrKrEr)rrrrrrr:r;rrrrrrr!r"r#rr,rr7r8r9rZ v_parcatsrrK)rQrrrO s'                             zParcats.__init__)NNNNNNNNNNNNNNNNNNNNNN)rrrrrrrrrr:r;rrrrrrr!r"r#rr,rr7r8r9rDrGrHrOrrr)rQrrs     F     # '        '      rc(s8eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,edxdyZ-edzd{Z.dfd}d~ Z/Z0S)OhlccCs|dS)z Sets the close values. The 'close' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray closer)rrrrr.s z Ohlc.closecCs ||d<dS)Nrr)rrrrrr<scCs|dS)z Sets the source reference on plot.ly for close . The 'closesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str closesrcr)rrrrrBs z Ohlc.closesrccCs ||d<dS)Nrr)rrrrrrPscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr VszOhlc.customdatacCs ||d<dS)Nr r)rrrrrr gscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrms zOhlc.customdatasrccCs ||d<dS)Nrr)rrrrrr{scCs|dS)aA The 'decreasing' property is an instance of Decreasing that may be specified as: - An instance of :class:`plotly.graph_objs.ohlc.Decreasing` - A dict of string/value properties that will be passed to the Decreasing constructor Supported dict properties: line :class:`plotly.graph_objects.ohlc.decreasing.Li ne` instance or dict with compatible properties Returns ------- plotly.graph_objs.ohlc.Decreasing rr)rrrrrszOhlc.decreasingcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the high values. The 'high' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray highr)rrrrrs z Ohlc.highcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for high . The 'highsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str highsrcr)rrrrrs z Ohlc.highsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrİszOhlc.hoverinfocCs ||d<dS)Nrr)rrrrrrذscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrްs zOhlc.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a} The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.ohlc.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . split Show hover information (open, close, high, low) in separate labels. Returns ------- plotly.graph_objs.ohlc.Hoverlabel rr)rrrrrs6zOhlc.hoverlabelcCs ||d<dS)Nrr)rrrrrr*scCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr0szOhlc.hovertextcCs ||d<dS)Nrr)rrrrrr@scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrFs zOhlc.hovertextsrccCs ||d<dS)Nrr)rrrrrrTscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrZszOhlc.idscCs ||d<dS)Nrr)rrrrrrjscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrps z Ohlc.idssrccCs ||d<dS)Nrr)rrrrrr~scCs|dS)aA The 'increasing' property is an instance of Increasing that may be specified as: - An instance of :class:`plotly.graph_objs.ohlc.Increasing` - A dict of string/value properties that will be passed to the Increasing constructor Supported dict properties: line :class:`plotly.graph_objects.ohlc.increasing.Li ne` instance or dict with compatible properties Returns ------- plotly.graph_objs.ohlc.Increasing rr)rrrrrszOhlc.increasingcCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszOhlc.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a2 The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.ohlc.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`. width [object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`. Returns ------- plotly.graph_objs.ohlc.Line rr)rrrrrsz Ohlc.linecCs ||d<dS)Nrr)rrrrrrձscCs|dS)z Sets the low values. The 'low' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray lowr)rrrrr۱s zOhlc.lowcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for low . The 'lowsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str lowsrcr)rrrrrs z Ohlc.lowsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!sz Ohlc.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s z Ohlc.metasrccCs ||d<dS)Nr"r)rrrrrr"-scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#3sz Ohlc.namecCs ||d<dS)Nr#r)rrrrrr#CscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'Is z Ohlc.opacitycCs ||d<dS)Nr'r)rrrrrr'WscCs|dS)z Sets the open values. The 'open' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray openr)rrrrr]s z Ohlc.opencCs ||d<dS)Nrr)rrrrrrkscCs|dS)z Sets the source reference on plot.ly for open . The 'opensrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str opensrcr)rrrrrqs z Ohlc.opensrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*szOhlc.selectedpointscCs ||d<dS)Nr*r)rrrrrr*scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zOhlc.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)ab The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.ohlc.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.ohlc.Stream r,r)rrrrr,sz Ohlc.streamcCs ||d<dS)Nr,r)rrrrrr,ͲscCs|dS)a Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-Ӳsz Ohlc.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s z Ohlc.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)a Sets the width of the open/close tick marks relative to the "x" minimal interval. The 'tickwidth' property is a number and may be specified as: - An int or float in the interval [0, 0.5] Returns ------- int|float tickwidthr)rrrrrs zOhlc.tickwidthcCs ||d<dS)Nrr)rrrrrrscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7szOhlc.uidcCs ||d<dS)Nr7r)rrrrrr7%scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8+szOhlc.uirevisioncCs ||d<dS)Nr8r)rrrrrr8FscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9Lsz Ohlc.visiblecCs ||d<dS)Nr9r)rrrrrr9]scCs|dS)a Sets the x coordinates. If absent, linear coordinate will be generated. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<cs zOhlc.xcCs ||d<dS)Nr<r)rrrrrr<rscCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>xsz Ohlc.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszOhlc.xcalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s z Ohlc.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBsz Ohlc.yaxiscCs ||d<dS)NrBr)rrrrrrBгscCs |jdS)NrD)rE)rrrrrDֳsz Ohlc.typecCsdS)NrFr)rrrrrGܳszOhlc._parent_path_strcCsdS)NaP close Sets the close values. closesrc Sets the source reference on plot.ly for close . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . decreasing :class:`plotly.graph_objects.ohlc.Decreasing` instance or dict with compatible properties high Sets the high values. highsrc Sets the source reference on plot.ly for high . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.ohlc.Hoverlabel` instance or dict with compatible properties hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . increasing :class:`plotly.graph_objects.ohlc.Increasing` instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.ohlc.Line` instance or dict with compatible properties low Sets the low values. lowsrc Sets the source reference on plot.ly for low . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. open Sets the open values. opensrc Sets the source reference on plot.ly for open . selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.ohlc.Stream` instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points. textsrc Sets the source reference on plot.ly for text . tickwidth Sets the width of the open/close tick marks relative to the "x" minimal interval. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. If absent, linear coordinate will be generated. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. r)rrrrrHszOhlc._prop_descriptionsNc)- stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|) dd|_ ddl m }*|*|jd<|*|jd <|*|jd <|*|jd <|*|jd <|*|jd <|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|* |jd<|*!|jd<|*"|jd<|*#|jd<|*$|jd<|*%|jd<|*&|jd<|*'|jd <|*(|jd!<|*)|jd"<|**|jd#<|*+|jd$<|*,|jd%<|*-|jd&<|*.|jd'<|*/|jd(<|*0|jd)<|*1|jd*<|*2|jd+<|*3|jd,<|*4|jd-<|*5|jd.<| dd}+|dk r|n|+|d<| d d}+|dk r|n|+|d <| d d}+|dk r|n|+|d <| d d}+|dk r|n|+|d <| d d}+|dk r0|n|+|d <| d d}+|dk rR|n|+|d <| dd}+|dk rt|n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+|dk r@|n|+|d<| dd}+|dk rb|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r |n|+|d<| dd}+|dk r.|n|+|d<| dd}+|dk rP|n|+|d<| dd}+|dk rr|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| d d}+|dk r|n|+|d <| d!d}+|dk r|n|+|d!<| d"d}+|dk r|n|+|d"<| d#d}+|dk r>|n|+|d#<| d$d}+|dk r`|n|+|d$<| d%d}+|dk r|n|+|d%<| d&d}+| dk r| n|+|d&<| d'd}+|!dk r|!n|+|d'<| d(d}+|"dk r|"n|+|d(<| d)d}+|#dk r |#n|+|d)<| d*d}+|$dk r,|$n|+|d*<| d+d}+|%dk rN|%n|+|d+<| d,d}+|&dk rp|&n|+|d,<| d-d}+|'dk r|'n|+|d-<| d.d}+|(dk r|(n|+|d.<dd/l6m7},d|j8d0<|,d0ddd1|jd0<| d0d|j9ft|f|)d|_ dS)2a{ Construct a new Ohlc object The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The tip of the lines represent the `low` and `high` values and the horizontal segments represent the `open` and `close` values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Ohlc` close Sets the close values. closesrc Sets the source reference on plot.ly for close . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . decreasing :class:`plotly.graph_objects.ohlc.Decreasing` instance or dict with compatible properties high Sets the high values. highsrc Sets the source reference on plot.ly for high . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.ohlc.Hoverlabel` instance or dict with compatible properties hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . increasing :class:`plotly.graph_objects.ohlc.Increasing` instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.ohlc.Line` instance or dict with compatible properties low Sets the low values. lowsrc Sets the source reference on plot.ly for low . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. open Sets the open values. opensrc Sets the source reference on plot.ly for open . selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.ohlc.Stream` instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points. textsrc Sets the source reference on plot.ly for text . tickwidth Sets the width of the open/close tick marks relative to the "x" minimal interval. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. If absent, linear coordinate will be generated. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. Returns ------- Ohlc ohlcNzThe first argument to the plotly.graph_objs.Ohlc constructor must be a dict or an instance of :class:`plotly.graph_objs.Ohlc`rJFr)rrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr*r+r,r-r3rr7r8r9r<r>rr?rB)rKrD)rLrMr):rNrrOrPrQrRrSrTrUrVrWrXrYrCloseValidatorr[ClosesrcValidatorr`rarb HighValidatorHighsrcValidatorrerfrgrjrkrlrmrnrqr LowValidatorLowsrcValidatorrrrsrtrx OpenValidatorOpensrcValidatorr{r|r}r~rZTickwidthValidatorrrrrrrrrrrKrEr)-rrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr*r+r,r-r3rr7r8r9r<r>rr?rBrZv_ohlcrrK)rQrrrOvsR                                               z Ohlc.__init__)(NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)1rrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr*r+r,r-r3rr7r8r9r<r>rr?rBrDrGrHrOrrr)rQrr*s          8                                rc@seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZe>jddZ>eddZ?e?jddZ?eddZ@e@jddZ@eddZAeAjddZAeddZBeBjddZBeddZCeCjddZCeddZDeddZEeddÄZFdLJfddƄ ZGZHS)Mesh3dcCs|dS)a Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If "-1", Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull. The 'alphahull' property is a number and may be specified as: - An int or float Returns ------- int|float alphahullr)rrrrrszMesh3d.alphahullcCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszMesh3d.autocolorscalecCs ||d<dS)Nrr)rrrrrr-scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. The 'cauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr3sz Mesh3d.cautocCs ||d<dS)Nrr)rrrrrrDscCs|dS)a8 Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well. The 'cmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrJsz Mesh3d.cmaxcCs ||d<dS)Nrr)rrrrrrZscCs|dS)a~ Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`. The 'cmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr`sz Mesh3d.cmidcCs ||d<dS)Nrr)rrrrrrqscCs|dS)a8 Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well. The 'cmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrwsz Mesh3d.cmincCs ||d<dS)Nrr)rrrrrrscCs|dS)ay Sets the color of the whole mesh The 'color' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen - A number that will be interpreted as a color according to mesh3d.colorscale Returns ------- str colorr)rrrrrs5z Mesh3d.colorcCs ||d<dS)Nrr)rrrrrrĶscCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrʶszMesh3d.coloraxiscCs ||d<dS)Nrr)rrrrrr߶scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.mesh3d.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.mesh3d. colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.mesh3d.colorbar.tickformatstopdefaults), sets the default property values to use for elements of mesh3d.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.mesh3d.colorbar.Ti tle` instance or dict with compatible properties titlefont Deprecated: Please use mesh3d.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use mesh3d.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.mesh3d.ColorBar rr)rrrrrsdzMesh3d.colorbarcCs ||d<dS)Nrr)rrrrrrʷscCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrrзs,zMesh3d.colorscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'contour' property is an instance of Contour that may be specified as: - An instance of :class:`plotly.graph_objs.mesh3d.Contour` - A dict of string/value properties that will be passed to the Contour constructor Supported dict properties: color Sets the color of the contour lines. show Sets whether or not dynamic contours are shown on hover width Sets the width of the contour lines. Returns ------- plotly.graph_objs.mesh3d.Contour rr)rrrrrszMesh3d.contourcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr #szMesh3d.customdatacCs ||d<dS)Nr r)rrrrrr 4scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr:s zMesh3d.customdatasrccCs ||d<dS)Nrr)rrrrrrHscCs|dS)a Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation. The 'delaunayaxis' property is an enumeration that may be specified as: - One of the following enumeration values: ['x', 'y', 'z'] Returns ------- Any delaunayaxisr)rrrrrNszMesh3d.delaunayaxiscCs ||d<dS)Nrr)rrrrrr`scCs|dS)a Sets the color of each face Overrides "color" and "vertexcolor". The 'facecolor' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray facecolorr)rrrrrfs zMesh3d.facecolorcCs ||d<dS)Nrr)rrrrrruscCs|dS)z Sets the source reference on plot.ly for facecolor . The 'facecolorsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str facecolorsrcr)rrrrr{s zMesh3d.facecolorsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a= Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections. The 'flatshading' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszMesh3d.flatshadingcCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszMesh3d.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zMesh3d.hoverinfosrccCs ||d<dS)Nrr)rrrrrr͸scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.mesh3d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.mesh3d.Hoverlabel rr)rrrrrӸs3zMesh3d.hoverlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrs!zMesh3d.hovertemplatecCs ||d<dS)Nrr)rrrrrr1scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr7s zMesh3d.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrEscCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrKszMesh3d.hovertextcCs ||d<dS)Nrr)rrrrrr[scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrras zMesh3d.hovertextsrccCs ||d<dS)Nrr)rrrrrroscCs|dS)a A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "first" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle. The 'i' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray ir)rrrrruszMesh3d.icCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Mesh3d.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Mesh3d.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aM Sets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes. The 'intensity' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray intensityr)rrrrrs zMesh3d.intensitycCs ||d<dS)Nrr)rrrrrrȹscCs|dS)a Determines the source of `intensity` values. The 'intensitymode' property is an enumeration that may be specified as: - One of the following enumeration values: ['vertex', 'cell'] Returns ------- Any intensitymoder)rrrrrιs zMesh3d.intensitymodecCs ||d<dS)Nrr)rrrrrrݹscCs|dS)z Sets the source reference on plot.ly for intensity . The 'intensitysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str intensitysrcr)rrrrrs zMesh3d.intensitysrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for i . The 'isrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str isrcr)rrrrrs z Mesh3d.isrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "second" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle. The 'j' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray jr)rrrrr szMesh3d.jcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for j . The 'jsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str jsrcr)rrrrr%s z Mesh3d.jsrccCs ||d<dS)Nrr)rrrrrr3scCs|dS)a A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "third" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle. The 'k' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray kr)rrrrr9szMesh3d.kcCs ||d<dS)Nrr)rrrrrrMscCs|dS)z Sets the source reference on plot.ly for k . The 'ksrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str ksrcr)rrrrrSs z Mesh3d.ksrccCs ||d<dS)Nrr)rrrrrrascCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrgszMesh3d.legendgroupcCs ||d<dS)Nrr)rrrrrrxscCs|dS)ag The 'lighting' property is an instance of Lighting that may be specified as: - An instance of :class:`plotly.graph_objs.mesh3d.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor Supported dict properties: ambient Ambient light increases overall color visibility but can wash out the image. diffuse Represents the extent that incident rays are reflected in a range of angles. facenormalsepsilon Epsilon for face normals calculation avoids math issues arising from degenerate geometry. fresnel Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine. roughness Alters specular reflection; the rougher the surface, the wider and less contrasty the shine. specular Represents the level that incident rays are reflected in a single direction, causing shine. vertexnormalsepsilon Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry. Returns ------- plotly.graph_objs.mesh3d.Lighting rr)rrrrr~s(zMesh3d.lightingcCs ||d<dS)Nrr)rrrrrrscCs|dS)a" The 'lightposition' property is an instance of Lightposition that may be specified as: - An instance of :class:`plotly.graph_objs.mesh3d.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor Supported dict properties: x Numeric vector, representing the X coordinate for each vertex. y Numeric vector, representing the Y coordinate for each vertex. z Numeric vector, representing the Z coordinate for each vertex. Returns ------- plotly.graph_objs.mesh3d.Lightposition rr)rrrrrszMesh3d.lightpositioncCs ||d<dS)Nrr)rrrrrrɺscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!Ϻsz Mesh3d.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zMesh3d.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#sz Mesh3d.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)aS Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'szMesh3d.opacitycCs ||d<dS)Nr'r)rrrrrr'(scCs|dS)aF Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr.szMesh3d.reversescalecCs ||d<dS)Nrr)rrrrrr>scCs|dS)a7 Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular subplot, of type 'scene', that may be specified as the string 'scene' optionally followed by an integer >= 1 (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- str rr)rrrrrDsz Mesh3d.scenecCs ||d<dS)Nrr)rrrrrrWscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+]s zMesh3d.showlegendcCs ||d<dS)Nr+r)rrrrrr+lscCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrrs zMesh3d.showscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)af The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.mesh3d.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.mesh3d.Stream r,r)rrrrr,sz Mesh3d.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-sz Mesh3d.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zMesh3d.textsrccCs ||d<dS)Nr3r)rrrrrr3λscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7Իsz Mesh3d.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szMesh3d.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Sets the color of each vertex Overrides "color". While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1. The 'vertexcolor' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray vertexcolorr)rrrrr szMesh3d.vertexcolorcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for vertexcolor . The 'vertexcolorsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str vertexcolorsrcr)rrrrr"s zMesh3d.vertexcolorsrccCs ||d<dS)Nrr)rrrrrr0scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr96szMesh3d.visiblecCs ||d<dS)Nr9r)rrrrrr9GscCs|dS)ad Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<MszMesh3d.xcCs ||d<dS)Nr<r)rrrrrr<]scCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrcszMesh3d.xcalendarcCs ||d<dS)Nrr)rrrrrruscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?{s z Mesh3d.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)ad Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@szMesh3d.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszMesh3d.ycalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs z Mesh3d.ysrccCs ||d<dS)NrCr)rrrrrrC˼scCs|dS)ad Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrѼszMesh3d.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the calendar system to use with `z` date data. The 'zcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszMesh3d.zcalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Mesh3d.zsrccCs ||d<dS)Nrr)rrrrrr scCs |jdS)NrD)rE)rrrrrDsz Mesh3d.typecCsdS)NrFr)rrrrrGszMesh3d._parent_path_strcCsdS)Na!< alphahull Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If "-1", Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well. color Sets the color of the whole mesh coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.mesh3d.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour :class:`plotly.graph_objects.mesh3d.Contour` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . delaunayaxis Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation. facecolor Sets the color of each face Overrides "color" and "vertexcolor". facecolorsrc Sets the source reference on plot.ly for facecolor . flatshading Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.mesh3d.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . i A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "first" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle. ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . intensity Sets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes. intensitymode Determines the source of `intensity` values. intensitysrc Sets the source reference on plot.ly for intensity . isrc Sets the source reference on plot.ly for i . j A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "second" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle. jsrc Sets the source reference on plot.ly for j . k A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "third" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle. ksrc Sets the source reference on plot.ly for k . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.mesh3d.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.mesh3d.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.mesh3d.Stream` instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. vertexcolor Sets the color of each vertex Overrides "color". While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1. vertexcolorsrc Sets the source reference on plot.ly for vertexcolor . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. zcalendar Sets the calendar system to use with `z` date data. zsrc Sets the source reference on plot.ly for z . r)rrrrrHs2zMesh3d._prop_descriptionsNcAE s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|A dd|_ ddl m }B|B|jd<|B|jd <|B|jd <|B|jd <|B|jd <|B|jd <|B|jd<|B|jd<|B|jd<|B|jd<|B|jd<|B|jd<|B|jd<|B|jd<|B|jd<|B|jd<|B|jd<|B |jd<|B!|jd<|B"|jd<|B#|jd<|B$|jd<|B%|jd<|B&|jd<|B'|jd <|B(|jd!<|B)|jd"<|B*|jd#<|B+|jd$<|B,|jd%<|B-|jd&<|B.|jd'<|B/|jd(<|B0|jd)<|B1|jd*<|B2|jd+<|B3|jd,<|B4|jd-<|B5|jd.<|B6|jd/<|B7|jd0<|B8|jd1<|B9|jd2<|B:|jd3<|B;|jd4<|B<|jd5<|B=|jd6<|B>|jd7<|B?|jd8<|B@|jd9<|BA|jd:<|BB|jd;<|BC|jd<<|BD|jd=<|BE|jd><|BF|jd?<|BG|jd@<|BH|jdA<|BI|jdB<|BJ|jdC<|BK|jdD<|BL|jdE<|BM|jdF<| dd}C|dk r|n|C|d<| d d}C|dk r|n|C|d <| d d}C|dk r<|n|C|d <| d d}C|dk r^|n|C|d <| d d}C|dk r|n|C|d <| d d}C|dk r|n|C|d <| dd}C|dk r|n|C|d<| dd}C| dk r| n|C|d<| dd}C| dk r| n|C|d<| dd}C| dk r*| n|C|d<| dd}C| dk rL| n|C|d<| dd}C| dk rn| n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r:|n|C|d<| dd}C|dk r\|n|C|d<| dd}C|dk r~|n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r|n|C|d<| dd}C|dk r|n|C|d<| d d}C|dk r(|n|C|d <| d!d}C|dk rJ|n|C|d!<| d"d}C|dk rl|n|C|d"<| d#d}C|dk r|n|C|d#<| d$d}C|dk r|n|C|d$<| d%d}C|dk r|n|C|d%<| d&d}C| dk r| n|C|d&<| d'd}C|!dk r|!n|C|d'<| d(d}C|"dk r8|"n|C|d(<| d)d}C|#dk rZ|#n|C|d)<| d*d}C|$dk r||$n|C|d*<| d+d}C|%dk r|%n|C|d+<| d,d}C|&dk r|&n|C|d,<| d-d}C|'dk r|'n|C|d-<| d.d}C|(dk r|(n|C|d.<| d/d}C|)dk r&|)n|C|d/<| d0d}C|*dk rH|*n|C|d0<| d1d}C|+dk rj|+n|C|d1<| d2d}C|,dk r|,n|C|d2<| d3d}C|-dk r|-n|C|d3<| d4d}C|.dk r|.n|C|d4<| d5d}C|/dk r|/n|C|d5<| d6d}C|0dk r|0n|C|d6<| d7d}C|1dk r6|1n|C|d7<| d8d}C|2dk rX|2n|C|d8<| d9d}C|3dk rz|3n|C|d9<| d:d}C|4dk r|4n|C|d:<| d;d}C|5dk r|5n|C|d;<| dd}C|8dk r$|8n|C|d><| d?d}C|9dk rF|9n|C|d?<| d@d}C|:dk rh|:n|C|d@<| dAd}C|;dk r|;n|C|dA<| dBd}C|dk r|>n|C|dD<| dEd}C|?dk r|?n|C|dE<| dFd}C|@dk r4|@n|C|dF<ddGlNmO}Dd|jPdH<|DdHdddI|jdH<| dHd|jQft|f|Ad|_ dS)Ja8> Construct a new Mesh3d object Draws sets of triangles with coordinates given by three 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha- shape algorithm or (4) the Convex-hull algorithm Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Mesh3d` alphahull Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If "-1", Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well. color Sets the color of the whole mesh coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.mesh3d.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour :class:`plotly.graph_objects.mesh3d.Contour` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . delaunayaxis Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation. facecolor Sets the color of each face Overrides "color" and "vertexcolor". facecolorsrc Sets the source reference on plot.ly for facecolor . flatshading Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.mesh3d.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . i A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "first" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle. ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . intensity Sets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes. intensitymode Determines the source of `intensity` values. intensitysrc Sets the source reference on plot.ly for intensity . isrc Sets the source reference on plot.ly for i . j A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "second" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle. jsrc Sets the source reference on plot.ly for j . k A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "third" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle. ksrc Sets the source reference on plot.ly for k . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.mesh3d.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.mesh3d.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.mesh3d.Stream` instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. vertexcolor Sets the color of each vertex Overrides "color". While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1. vertexcolorsrc Sets the source reference on plot.ly for vertexcolor . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex. zcalendar Sets the calendar system to use with `z` date data. zsrc Sets the source reference on plot.ly for z . Returns ------- Mesh3d mesh3dNzThe first argument to the plotly.graph_objs.Mesh3d constructor must be a dict or an instance of :class:`plotly.graph_objs.Mesh3d`rJFr)rrrrrrrrrrrrr rrrrrrrrrrrrrrrrrrrrrrrrrrr!r"r#r'rrr+rr,r-r3r7r8rrr9r<rr?r@rrCrrr)rKrD)rLrMr)RrNrrOrPrQrRrSrTrUrVrWrXrYrZAlphahullValidatorr[rrrrrColorValidatorrrrrr`raZDelaunayaxisValidatorZFacecolorValidatorZFacecolorsrcValidatorrrerfrgrhrirjrkZ IValidatorrlrmZIntensityValidatorZIntensitymodeValidatorZIntensitysrcValidatorZ IsrcValidatorZ JValidatorZ JsrcValidatorZ KValidatorZ KsrcValidatorrqrrrrrsrtrxrrr|rr}r~rrrZVertexcolorValidatorZVertexcolorsrcValidatorrrrrrrrrr rrrKrEr)Errrrrrrrrrrrrr rrrrrrrrrrrrrrrrrrrrrrrrrrr!r"r#r'rrr+rr,r-r3r7r8rrr9r<rr?r@rrCrrrrZv_mesh3drrK)rQrrrOQs                                                                       zMesh3d.__init__)@NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Irrrrrrrrrrrrrrrrr rrrrrrrrrrrrrrrrrrrrrrrrrrr!r"r#r'rrr+rr,r-r3r7r8rrr9r<rr?r@rrCrrrrDrGrHrOrrr)rQrrs       7  f .          5 #                *                             6rc5seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9eddZ:eddZ;dfdd Z<Z=S) IsosurfacecCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszIsosurface.autocolorscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)aT The 'caps' property is an instance of Caps that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Caps` - A dict of string/value properties that will be passed to the Caps constructor Supported dict properties: x :class:`plotly.graph_objects.isosurface.caps.X` instance or dict with compatible properties y :class:`plotly.graph_objects.isosurface.caps.Y` instance or dict with compatible properties z :class:`plotly.graph_objects.isosurface.caps.Z` instance or dict with compatible properties Returns ------- plotly.graph_objs.isosurface.Caps rr)rrrrrszIsosurface.capscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. The 'cauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszIsosurface.cautocCs ||d<dS)Nrr)rrrrrrscCs|dS)a, Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well. The 'cmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zIsosurface.cmaxcCs ||d<dS)Nrr)rrrrrr.scCs|dS)ar Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`. The 'cmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr4szIsosurface.cmidcCs ||d<dS)Nrr)rrrrrrDscCs|dS)a, Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well. The 'cmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrJs zIsosurface.cmincCs ||d<dS)Nrr)rrrrrrYscCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrr_szIsosurface.coloraxiscCs ||d<dS)Nrr)rrrrrrtscCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.isosurf ace.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.isosurface.colorbar.tickformatstopdefaults), sets the default property values to use for elements of isosurface.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.isosurface.colorba r.Title` instance or dict with compatible properties titlefont Deprecated: Please use isosurface.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use isosurface.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.isosurface.ColorBar rr)rrrrrzsdzIsosurface.colorbarcCs ||d<dS)Nrr)rrrrrr_scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrres,zIsosurface.colorscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'contour' property is an instance of Contour that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Contour` - A dict of string/value properties that will be passed to the Contour constructor Supported dict properties: color Sets the color of the contour lines. show Sets whether or not dynamic contours are shown on hover width Sets the width of the contour lines. Returns ------- plotly.graph_objs.isosurface.Contour rr)rrrrrszIsosurface.contourcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szIsosurface.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIsosurface.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a= Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections. The 'flatshading' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszIsosurface.flatshadingcCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszIsosurface.hoverinfocCs ||d<dS)Nrr)rrrrrr scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIsosurface.hoverinfosrccCs ||d<dS)Nrr)rrrrrr!scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.isosurface.Hoverlabel rr)rrrrr's3zIsosurface.hoverlabelcCs ||d<dS)Nrr)rrrrrr\scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrbs!zIsosurface.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIsosurface.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrszIsosurface.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIsosurface.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrszIsosurface.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIsosurface.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the maximum boundary for iso-surface plot. The 'isomax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zIsosurface.isomaxcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the minimum boundary for iso-surface plot. The 'isomin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zIsosurface.isomincCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszIsosurface.legendgroupcCs ||d<dS)Nrr)rrrrrr,scCs|dS)ao The 'lighting' property is an instance of Lighting that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor Supported dict properties: ambient Ambient light increases overall color visibility but can wash out the image. diffuse Represents the extent that incident rays are reflected in a range of angles. facenormalsepsilon Epsilon for face normals calculation avoids math issues arising from degenerate geometry. fresnel Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine. roughness Alters specular reflection; the rougher the surface, the wider and less contrasty the shine. specular Represents the level that incident rays are reflected in a single direction, causing shine. vertexnormalsepsilon Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry. Returns ------- plotly.graph_objs.isosurface.Lighting rr)rrrrr2s(zIsosurface.lightingcCs ||d<dS)Nrr)rrrrrr\scCs|dS)a* The 'lightposition' property is an instance of Lightposition that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor Supported dict properties: x Numeric vector, representing the X coordinate for each vertex. y Numeric vector, representing the Y coordinate for each vertex. z Numeric vector, representing the Z coordinate for each vertex. Returns ------- plotly.graph_objs.isosurface.Lightposition rr)rrrrrbszIsosurface.lightpositioncCs ||d<dS)Nrr)rrrrrr}scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szIsosurface.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zIsosurface.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#szIsosurface.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)aS Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'szIsosurface.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)aF Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszIsosurface.reversescalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a7 Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular subplot, of type 'scene', that may be specified as the string 'scene' optionally followed by an integer >= 1 (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- str rr)rrrrrszIsosurface.scenecCs ||d<dS)Nrr)rrrrrr scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zIsosurface.showlegendcCs ||d<dS)Nr+r)rrrrrr+ scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr&s zIsosurface.showscalecCs ||d<dS)Nrr)rrrrrr5scCs|dS)ag The 'slices' property is an instance of Slices that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Slices` - A dict of string/value properties that will be passed to the Slices constructor Supported dict properties: x :class:`plotly.graph_objects.isosurface.slices. X` instance or dict with compatible properties y :class:`plotly.graph_objects.isosurface.slices. Y` instance or dict with compatible properties z :class:`plotly.graph_objects.isosurface.slices. Z` instance or dict with compatible properties Returns ------- plotly.graph_objs.isosurface.Slices rr)rrrrr;szIsosurface.slicescCs ||d<dS)Nrr)rrrrrrVscCs|dS)a The 'spaceframe' property is an instance of Spaceframe that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Spaceframe` - A dict of string/value properties that will be passed to the Spaceframe constructor Supported dict properties: fill Sets the fill ratio of the `spaceframe` elements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greater `fill` ratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1). show Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1. Returns ------- plotly.graph_objs.isosurface.Spaceframe rr)rrrrr\szIsosurface.spaceframecCs ||d<dS)Nrr)rrrrrr{scCs|dS)an The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.isosurface.Stream r,r)rrrrr,szIsosurface.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a/ The 'surface' property is an instance of Surface that may be specified as: - An instance of :class:`plotly.graph_objs.isosurface.Surface` - A dict of string/value properties that will be passed to the Surface constructor Supported dict properties: count Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn. fill Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. pattern Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest. show Hides/displays surfaces between minimum and maximum iso-values. Returns ------- plotly.graph_objs.isosurface.Surface rr)rrrrrs*zIsosurface.surfacecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-szIsosurface.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zIsosurface.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7szIsosurface.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szIsosurface.uirevisioncCs ||d<dS)Nr8r)rrrrrr81scCs|dS)z Sets the 4th dimension (value) of the vertices. The 'value' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr7s zIsosurface.valuecCs ||d<dS)Nrr)rrrrrrEscCs|dS)z Sets the source reference on plot.ly for value . The 'valuesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrKs zIsosurface.valuesrccCs ||d<dS)Nrr)rrrrrrYscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9_szIsosurface.visiblecCs ||d<dS)Nr9r)rrrrrr9pscCs|dS)z Sets the X coordinates of the vertices on X axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<vs z Isosurface.xcCs ||d<dS)Nr<r)rrrrrr<scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s zIsosurface.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)z Sets the Y coordinates of the vertices on Y axis. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@s z Isosurface.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs zIsosurface.ysrccCs ||d<dS)NrCr)rrrrrrCscCs|dS)z Sets the Z coordinates of the vertices on Z axis. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs z Isosurface.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIsosurface.zsrccCs ||d<dS)Nrr)rrrrrrscCs |jdS)NrD)rE)rrrrrDszIsosurface.typecCsdS)NrFr)rrrrrGszIsosurface._parent_path_strcCsdS)Na, autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps :class:`plotly.graph_objects.isosurface.Caps` instance or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.isosurface.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour :class:`plotly.graph_objects.isosurface.Contour` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . flatshading Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.isosurface.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . isomax Sets the maximum boundary for iso-surface plot. isomin Sets the minimum boundary for iso-surface plot. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.isosurface.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.isosurface.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. slices :class:`plotly.graph_objects.isosurface.Slices` instance or dict with compatible properties spaceframe :class:`plotly.graph_objects.isosurface.Spaceframe` instance or dict with compatible properties stream :class:`plotly.graph_objects.isosurface.Stream` instance or dict with compatible properties surface :class:`plotly.graph_objects.isosurface.Surface` instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. value Sets the 4th dimension (value) of the vertices. valuesrc Sets the source reference on plot.ly for value . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the X coordinates of the vertices on X axis. xsrc Sets the source reference on plot.ly for x . y Sets the Y coordinates of the vertices on Y axis. ysrc Sets the source reference on plot.ly for y . z Sets the Z coordinates of the vertices on Z axis. zsrc Sets the source reference on plot.ly for z . r)rrrrrHshzIsosurface._prop_descriptionsNc6: s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|6 dd|_ ddl m }7|7|jd<|7|jd <|7|jd <|7|jd <|7|jd <|7|jd <|7|jd<|7|jd<|7|jd<|7|jd<|7|jd<|7|jd<|7|jd<|7|jd<|7|jd<|7|jd<|7|jd<|7 |jd<|7!|jd<|7"|jd<|7#|jd<|7$|jd<|7%|jd<|7&|jd<|7'|jd <|7(|jd!<|7)|jd"<|7*|jd#<|7+|jd$<|7,|jd%<|7-|jd&<|7.|jd'<|7/|jd(<|70|jd)<|71|jd*<|72|jd+<|73|jd,<|74|jd-<|75|jd.<|76|jd/<|77|jd0<|78|jd1<|79|jd2<|7:|jd3<|7;|jd4<|7<|jd5<|7=|jd6<|7>|jd7<|7?|jd8<|7@|jd9<|7A|jd:<|7B|jd;<| dd}8|dk r^|n|8|d<| d d}8|dk r|n|8|d <| d d}8|dk r|n|8|d <| d d}8|dk r|n|8|d <| d d}8|dk r|n|8|d <| d d}8|dk r|n|8|d <| dd}8|dk r*|n|8|d<| dd}8| dk rL| n|8|d<| dd}8| dk rn| n|8|d<| dd}8| dk r| n|8|d<| dd}8| dk r| n|8|d<| dd}8| dk r| n|8|d<| dd}8|dk r|n|8|d<| dd}8|dk r|n|8|d<| dd}8|dk r:|n|8|d<| dd}8|dk r\|n|8|d<| dd}8|dk r~|n|8|d<| dd}8|dk r|n|8|d<| dd}8|dk r|n|8|d<| dd}8|dk r|n|8|d<| dd}8|dk r|n|8|d<| dd}8|dk r(|n|8|d<| dd}8|dk rJ|n|8|d<| dd}8|dk rl|n|8|d<| d d}8|dk r|n|8|d <| d!d}8|dk r|n|8|d!<| d"d}8|dk r|n|8|d"<| d#d}8|dk r|n|8|d#<| d$d}8|dk r|n|8|d$<| d%d}8|dk r8|n|8|d%<| d&d}8| dk rZ| n|8|d&<| d'd}8|!dk r||!n|8|d'<| d(d}8|"dk r|"n|8|d(<| d)d}8|#dk r|#n|8|d)<| d*d}8|$dk r|$n|8|d*<| d+d}8|%dk r|%n|8|d+<| d,d}8|&dk r&|&n|8|d,<| d-d}8|'dk rH|'n|8|d-<| d.d}8|(dk rj|(n|8|d.<| d/d}8|)dk r|)n|8|d/<| d0d}8|*dk r|*n|8|d0<| d1d}8|+dk r|+n|8|d1<| d2d}8|,dk r|,n|8|d2<| d3d}8|-dk r|-n|8|d3<| d4d}8|.dk r6|.n|8|d4<| d5d}8|/dk rX|/n|8|d5<| d6d}8|0dk rz|0n|8|d6<| d7d}8|1dk r|1n|8|d7<| d8d}8|2dk r|2n|8|d8<| d9d}8|3dk r|3n|8|d9<| d:d}8|4dk r|4n|8|d:<| d;d}8|5dk r$|5n|8|d;<dd|jd=<| d=d|jFft|f|6d|_ dS)?a/ Construct a new Isosurface object Draws isosurfaces between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non- uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Isosurface` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps :class:`plotly.graph_objects.isosurface.Caps` instance or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.isosurface.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour :class:`plotly.graph_objects.isosurface.Contour` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . flatshading Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.isosurface.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . isomax Sets the maximum boundary for iso-surface plot. isomin Sets the minimum boundary for iso-surface plot. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.isosurface.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.isosurface.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. slices :class:`plotly.graph_objects.isosurface.Slices` instance or dict with compatible properties spaceframe :class:`plotly.graph_objects.isosurface.Spaceframe` instance or dict with compatible properties stream :class:`plotly.graph_objects.isosurface.Stream` instance or dict with compatible properties surface :class:`plotly.graph_objects.isosurface.Surface` instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. value Sets the 4th dimension (value) of the vertices. valuesrc Sets the source reference on plot.ly for value . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the X coordinates of the vertices on X axis. xsrc Sets the source reference on plot.ly for x . y Sets the Y coordinates of the vertices on Y axis. ysrc Sets the source reference on plot.ly for y . z Sets the Z coordinates of the vertices on Z axis. zsrc Sets the source reference on plot.ly for z . Returns ------- Isosurface isosurfaceNzThe first argument to the plotly.graph_objs.Isosurface constructor must be a dict or an instance of :class:`plotly.graph_objs.Isosurface`rJFr)rrrrrrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr+rrrr,rr-r3r7r8rrr9r<r?r@rCrr)rKrD)rLrMr)GrNrrOrPrQrRrSrTrUrVrWrXrYrrr[rrrrrrrrrr`rarrerfrgrhrirjrkrlrmrrrqrrrrrsrtrxrrr|rrrr}rr~rrrrrrrrrrrrrrKrEr):rrrrrrrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr+rrrr,rr-r3r7r8rrr9r<r?r@rCrrrZ v_isosurfacerrK)rQrrrOs`3                                                            zIsosurface.__init__)5NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)>rrrrrrrrrrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr+rrrr,rr-r3r7r8rrr9r<r?r@rCrrrDrGrHrOrrr)rQrrsD        f .       5 #         *             ,                lrcs0eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;Zedd?ZdCfdAdB ZZS)D IndicatorcCs|dS)a Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered The 'align' property is an enumeration that may be specified as: - One of the following enumeration values: ['left', 'center', 'right'] Returns ------- Any alignr)rrrrrszIndicator.aligncCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szIndicator.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIndicator.customdatasrccCs ||d<dS)Nrr)rrrrrr)scCs|dS)a The 'delta' property is an instance of Delta that may be specified as: - An instance of :class:`plotly.graph_objs.indicator.Delta` - A dict of string/value properties that will be passed to the Delta constructor Supported dict properties: decreasing :class:`plotly.graph_objects.indicator.delta.De creasing` instance or dict with compatible properties font Set the font used to display the delta increasing :class:`plotly.graph_objects.indicator.delta.In creasing` instance or dict with compatible properties position Sets the position of delta with respect to the number. reference Sets the reference value to compute the delta. By default, it is set to the current value. relative Show relative change valueformat Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format Returns ------- plotly.graph_objs.indicator.Delta deltar)rrrrr/s(zIndicator.deltacCs ||d<dS)Nrr)rrrrrrYscCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.indicator.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this indicator trace . row If there is a layout grid, use the domain for this row in the grid for this indicator trace . x Sets the horizontal domain of this indicator trace (in plot fraction). y Sets the vertical domain of this indicator trace (in plot fraction). Returns ------- plotly.graph_objs.indicator.Domain rr)rrrrr_szIndicator.domaincCs ||d<dS)Nrr)rrrrrr~scCs|dS)a The gauge of the Indicator plot. The 'gauge' property is an instance of Gauge that may be specified as: - An instance of :class:`plotly.graph_objs.indicator.Gauge` - A dict of string/value properties that will be passed to the Gauge constructor Supported dict properties: axis :class:`plotly.graph_objects.indicator.gauge.Ax is` instance or dict with compatible properties bar Set the appearance of the gauge's value bgcolor Sets the gauge background color. bordercolor Sets the color of the border enclosing the gauge. borderwidth Sets the width (in px) of the border enclosing the gauge. shape Set the shape of the gauge steps A tuple of :class:`plotly.graph_objects.indicat or.gauge.Step` instances or dicts with compatible properties stepdefaults When used in a template (as layout.template.dat a.indicator.gauge.stepdefaults), sets the default property values to use for elements of indicator.gauge.steps threshold :class:`plotly.graph_objects.indicator.gauge.Th reshold` instance or dict with compatible properties Returns ------- plotly.graph_objs.indicator.Gauge gauger)rrrrrs.zIndicator.gaugecCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Indicator.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zIndicator.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szIndicator.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zIndicator.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis. The 'mode' property is a flaglist and may be specified as a string containing: - Any combination of ['number', 'delta', 'gauge'] joined with '+' characters (e.g. 'number+delta') Returns ------- Any rKr)rrrrrKszIndicator.modecCs ||d<dS)NrKr)rrrrrrK'scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#-szIndicator.namecCs ||d<dS)Nr#r)rrrrrr#=scCs|dS)a The 'number' property is an instance of Number that may be specified as: - An instance of :class:`plotly.graph_objs.indicator.Number` - A dict of string/value properties that will be passed to the Number constructor Supported dict properties: font Set the font used to display main number prefix Sets a prefix appearing before the number. suffix Sets a suffix appearing next to the number. valueformat Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format Returns ------- plotly.graph_objs.indicator.Number numberr)rrrrrCszIndicator.numbercCs ||d<dS)Nrr)rrrrrrascCs|dS)al The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.indicator.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.indicator.Stream r,r)rrrrr,gszIndicator.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)a The 'title' property is an instance of Title that may be specified as: - An instance of :class:`plotly.graph_objs.indicator.Title` - A dict of string/value properties that will be passed to the Title constructor Supported dict properties: align Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right. font Set the font used to display the title text Sets the title of this indicator. Returns ------- plotly.graph_objs.indicator.Title rr)rrrrrszIndicator.titlecCs ||d<dS)Nrr)rrrrrrscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7sz Indicator.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szIndicator.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)z Sets the number to be displayed. The 'value' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zIndicator.valuecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szIndicator.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs |jdS)NrD)rE)rrrrrD szIndicator.typecCsdS)NrFr)rrrrrGszIndicator._parent_path_strcCsdS)Na align Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . delta :class:`plotly.graph_objects.indicator.Delta` instance or dict with compatible properties domain :class:`plotly.graph_objects.indicator.Domain` instance or dict with compatible properties gauge The gauge of the Indicator plot. ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis. name Sets the trace name. The trace name appear as the legend item and on hover. number :class:`plotly.graph_objects.indicator.Number` instance or dict with compatible properties stream :class:`plotly.graph_objects.indicator.Stream` instance or dict with compatible properties title :class:`plotly.graph_objects.indicator.Title` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. value Sets the number to be displayed. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHs[zIndicator._prop_descriptionsNc sPtt|d|dkri}n4t||jr4|}nt|trJt|}nt d| dd|_ ddl m }||jd<||jd <||jd <||jd <||jd <||jd <||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<| |jd<|!|jd<| dd}|dk r|n||d<| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r:|n||d <| dd}|dk r\|n||d<| dd}| dk r~| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}|dk r(|n||d<| dd}|dk rJ|n||d<| dd}|dk rl|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<ddl"m#}d|j$d<|dddd|jd<| dd|j%ft|f|d|_ dS)ak Construct a new Indicator object An indicator is used to visualize a single `value` along with some contextual information such as `steps` or a `threshold`, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a `reference`. Gauges can be either angular or bullet (aka linear) gauges. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Indicator` align Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . delta :class:`plotly.graph_objects.indicator.Delta` instance or dict with compatible properties domain :class:`plotly.graph_objects.indicator.Domain` instance or dict with compatible properties gauge The gauge of the Indicator plot. ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . mode Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis. name Sets the trace name. The trace name appear as the legend item and on hover. number :class:`plotly.graph_objects.indicator.Number` instance or dict with compatible properties stream :class:`plotly.graph_objects.indicator.Stream` instance or dict with compatible properties title :class:`plotly.graph_objects.indicator.Title` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. value Sets the number to be displayed. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Indicator indicatorNzThe first argument to the plotly.graph_objs.Indicator constructor must be a dict or an instance of :class:`plotly.graph_objs.Indicator`rJFr)rrr rrrrrrr!r"rKr#rr,rr7r8rr9)rKrD)rLrMr)&rNrrOrPrQrRrSrTrUrVrWrXrYrZAlignValidatorr[r`raZDeltaValidatorrZGaugeValidatorrlrmrrrsrTrtZNumberValidatorr}rrrrrrrKrEr)rrrr rrrrrrr!r"rKr#rr,rr7r8rr9rZ v_indicatorrrK)rQrrrOss                           zIndicator.__init__)NNNNNNNNNNNNNNNNNNNN)rrrrrrr rrrrrrr!r"rKr#rr,rr7r8rr9rDrGrHrOrrr)rQrrsz    *  0                _rc!seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%edcddZ&ededfZ'djfdhdi Z(Z)S)kImagecCs|dS)aR Color model used to map the numerical color components described in `z` into colors. The 'colormodel' property is an enumeration that may be specified as: - One of the following enumeration values: ['rgb', 'rgba', 'hsl', 'hsla'] Returns ------- Any colormodelr)rrrrrkszImage.colormodelcCs ||d<dS)Nrr)rrrrrr{scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szImage.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zImage.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Set the pixel's horizontal size. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zImage.dxcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Set the pixel's vertical size The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zImage.dycCs ||d<dS)Nrr)rrrrrrscCs|dS)ai Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'color', 'name', 'text'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszImage.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zImage.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.image.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.image.Hoverlabel rr)rrrrrs3zImage.hoverlabelcCs ||d<dS)Nrr)rrrrrr7scCs|dS)aF Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `z`, `color` and `colormodel`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr=s!zImage.hovertemplatecCs ||d<dS)Nrr)rrrrrr`scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrfs zImage.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrtscCs|dS)z Same as `text`. The 'hovertext' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrzs zImage.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zImage.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Image.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Image.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!sz Image.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s z Image.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#sz Image.namecCs ||d<dS)Nr#r)rrrrrr# scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr's z Image.opacitycCs ||d<dS)Nr'r)rrrrrr' scCs|dS)ad The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.image.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.image.Stream r,r)rrrrr,&sz Image.streamcCs ||d<dS)Nr,r)rrrrrr,AscCs|dS)z Sets the text elements associated with each z value. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-Gs z Image.textcCs ||d<dS)Nr-r)rrrrrr-UscCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3[s z Image.textsrccCs ||d<dS)Nr3r)rrrrrr3iscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7osz Image.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szImage.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9sz Image.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs|dS)z Set the image's x position. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr=s zImage.x0cCs ||d<dS)Nr=r)rrrrrr=scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>sz Image.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)z Set the image's y position. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAs zImage.y0cCs ||d<dS)NrAr)rrrrrrAscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBsz Image.yaxiscCs ||d<dS)NrBr)rrrrrrBscCs|dS)a( A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs zImage.zcCs ||d<dS)Nrr)rrrrrr$scCs|dS)a Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1]. The 'zmax' property is an info array that may be specified as: * a list or tuple of 4 elements where: (0) The 'zmax[0]' property is a number and may be specified as: - An int or float (1) The 'zmax[1]' property is a number and may be specified as: - An int or float (2) The 'zmax[2]' property is a number and may be specified as: - An int or float (3) The 'zmax[3]' property is a number and may be specified as: - An int or float Returns ------- list zmaxr)rrrrr*sz Image.zmaxcCs ||d<dS)Nrr)rrrrrrFscCs|dS)a Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0]. The 'zmin' property is an info array that may be specified as: * a list or tuple of 4 elements where: (0) The 'zmin[0]' property is a number and may be specified as: - An int or float (1) The 'zmin[1]' property is a number and may be specified as: - An int or float (2) The 'zmin[2]' property is a number and may be specified as: - An int or float (3) The 'zmin[3]' property is a number and may be specified as: - An int or float Returns ------- list zminr)rrrrrLsz Image.zmincCs ||d<dS)Nrr)rrrrrrgscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrms z Image.zsrccCs ||d<dS)Nrr)rrrrrr{scCs |jdS)NrD)rE)rrrrrDsz Image.typecCsdS)NrFr)rrrrrGszImage._parent_path_strcCsdS)Na colormodel Color model used to map the numerical color components described in `z` into colors. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Set the pixel's horizontal size. dy Set the pixel's vertical size hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.image.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `z`, `color` and `colormodel`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. stream :class:`plotly.graph_objects.image.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x0 Set the image's x position. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. y0 Set the image's y position. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. z A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color. zmax Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1]. zmin Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0]. zsrc Sets the source reference on plot.ly for z . r)rrrrrHszImage._prop_descriptionsNc"& stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|" dd|_ ddl m }#|#|jd<|#|jd <|#|jd <|#|jd <|#|jd <|#|jd <|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|# |jd<|#!|jd<|#"|jd<|##|jd<|#$|jd<|#%|jd<|#&|jd<|#'|jd <|#(|jd!<|#)|jd"<|#*|jd#<|#+|jd$<|#,|jd%<|#-|jd&<|#.|jd'<| dd}$|dk rF|n|$|d<| d d}$|dk rh|n|$|d <| d d}$|dk r|n|$|d <| d d}$|dk r|n|$|d <| d d}$|dk r|n|$|d <| d d}$|dk r|n|$|d <| dd}$|dk r|n|$|d<| dd}$| dk r4| n|$|d<| dd}$| dk rV| n|$|d<| dd}$| dk rx| n|$|d<| dd}$| dk r| n|$|d<| dd}$| dk r| n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r"|n|$|d<| dd}$|dk rD|n|$|d<| dd}$|dk rf|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r2|n|$|d<| dd}$|dk rT|n|$|d<| d d}$|dk rv|n|$|d <| d!d}$|dk r|n|$|d!<| d"d}$|dk r|n|$|d"<| d#d}$|dk r|n|$|d#<| d$d}$|dk r|n|$|d$<| d%d}$|dk r |n|$|d%<| d&d}$| dk rB| n|$|d&<| d'd}$|!dk rd|!n|$|d'<dd(l/m0}%d|j1d)<|%d)ddd*|jd)<| d)d|j2ft|f|"d|_ dS)+a Construct a new Image object Display an image, i.e. data on a 2D regular raster. By default, when an image is displayed in a subplot, its y axis will be reversed (ie. `autorange: 'reversed'`), constrained to the domain (ie. `constrain: 'domain'`) and it will have the same scale as its x axis (ie. `scaleanchor: 'x,`) in order for pixels to be rendered as squares. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Image` colormodel Color model used to map the numerical color components described in `z` into colors. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Set the pixel's horizontal size. dy Set the pixel's vertical size hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.image.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `z`, `color` and `colormodel`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. stream :class:`plotly.graph_objects.image.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x0 Set the image's x position. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. y0 Set the image's y position. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. z A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color. zmax Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1]. zmin Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0]. zsrc Sets the source reference on plot.ly for z . Returns ------- Image imageNzThe first argument to the plotly.graph_objs.Image constructor must be a dict or an instance of :class:`plotly.graph_objs.Image`rJFr)rrr rrrrrrrrrrrrr!r"r#r'r,r-r3r7r8r9r=r>rArBrrrr)rKrD)rLrMr)3rNrrOrPrQrRrSrTrUrVrWrXrYrZColormodelValidatorr[r`rarcrdrerfrgrhrirjrkrlrmrrrsrtrxr}r~rrrrrrrrr ZmaxValidator ZminValidatorrrrKrEr)&rrrr rrrrrrrrrrrrr!r"r#r'r,r-r3r7r8r9r=r>rArBrrrrrZv_imagerrK)rQrrrO'sO                                        zImage.__init__)!NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)*rrrrrrr rrrrrrrrrrrrr!r"r#r'r,r-r3r7r8r9r=r>rArBrrrrrDrGrHrOrrr)rQrrgs        5 #                          rc9seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZeddZ?dfdd Z@ZAS)Histogram2dContourcCs|dS)a Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. The 'autobinx' property must be specified as a bool (either True, or False) Returns ------- bool autobinxr)rrrrr szHistogram2dContour.autobinxcCs ||d<dS)Nr r)rrrrrr scCs|dS)a Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. The 'autobiny' property must be specified as a bool (either True, or False) Returns ------- bool autobinyr)rrrrr szHistogram2dContour.autobinycCs ||d<dS)Nr r)rrrrrr scCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrsz!Histogram2dContour.autocolorscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. The 'autocontour' property must be specified as a bool (either True, or False) Returns ------- bool autocontourr)rrrrr szHistogram2dContour.autocontourcCs ||d<dS)Nr r)rrrrrr scCs|dS)a Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. The 'bingroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str bingroupr)rrrrr szHistogram2dContour.bingroupcCs ||d<dS)Nr r)rrrrrr scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrszHistogram2dContour.coloraxiscCs ||d<dS)Nrr)rrrrrrscCs|dS)aT- The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.histogr am2dcontour.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram2dcontour.colorbar.tickformatstopdef aults), sets the default property values to use for elements of histogram2dcontour.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.histogram2dcontour .colorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use histogram2dcontour.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use histogram2dcontour.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.histogram2dcontour.ColorBar rr)rrrrr"sezHistogram2dContour.colorbarcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrrs,zHistogram2dContour.colorscalecCs ||d<dS)Nrr)rrrrrr<scCs|dS)a The 'contours' property is an instance of Contours that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.Contours` - A dict of string/value properties that will be passed to the Contours constructor Supported dict properties: coloring Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace. end Sets the end contour level value. Must be more than `contours.start` labelfont Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`. labelformat Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format operation Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms. showlabels Determines whether to label the contour lines with their values. showlines Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill". size Sets the step between each contour level. Must be positive. start Sets the starting contour level value. Must be less than `contours.end` type If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters. value Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound. Returns ------- plotly.graph_objs.histogram2dcontour.Contours rr)rrrrrBsOzHistogram2dContour.contourscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szHistogram2dContour.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Histogram2dContour.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ap Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively. The 'histfunc' property is an enumeration that may be specified as: - One of the following enumeration values: ['count', 'sum', 'avg', 'min', 'max'] Returns ------- Any histfuncr)rrrrrszHistogram2dContour.histfunccCs ||d<dS)Nrr)rrrrrrscCs|dS)a Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1). The 'histnorm' property is an enumeration that may be specified as: - One of the following enumeration values: ['', 'percent', 'probability', 'density', 'probability density'] Returns ------- Any histnormr)rrrrrszHistogram2dContour.histnormcCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszHistogram2dContour.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram2dContour.hoverinfosrccCs ||d<dS)Nrr)rrrrrr(scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.histogram2dcontour.Hoverlabel rr)rrrrr.s3zHistogram2dContour.hoverlabelcCs ||d<dS)Nrr)rrrrrrcscCs|dS)a* Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variable `z` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrris!z Histogram2dContour.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z#Histogram2dContour.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrszHistogram2dContour.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram2dContour.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszHistogram2dContour.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)aQ The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines". dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). smoothing Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing. width Sets the contour line width in (in px) Returns ------- plotly.graph_objs.histogram2dcontour.Line rr)rrrrrszHistogram2dContour.linecCs ||d<dS)Nrr)rrrrrrscCs|dS)ad The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: color Sets the aggregation data. colorsrc Sets the source reference on plot.ly for color . Returns ------- plotly.graph_objs.histogram2dcontour.Marker rr)rrrrr szHistogram2dContour.markercCs ||d<dS)Nrr)rrrrrr$scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!*szHistogram2dContour.metacCs ||d<dS)Nr!r)rrrrrr!@scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Fs zHistogram2dContour.metasrccCs ||d<dS)Nr"r)rrrrrr"TscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#ZszHistogram2dContour.namecCs ||d<dS)Nr#r)rrrrrr#jscCs|dS)a Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. The 'nbinsx' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns ------- int nbinsxr)rrrrrpszHistogram2dContour.nbinsxcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. The 'nbinsy' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns ------- int nbinsyr)rrrrrszHistogram2dContour.nbinsycCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. The 'ncontours' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns ------- int ncontoursr)rrrrrszHistogram2dContour.ncontourscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr's zHistogram2dContour.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszHistogram2dContour.reversescalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zHistogram2dContour.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrs zHistogram2dContour.showscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a~ The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.histogram2dcontour.Stream r,r)rrrrr, szHistogram2dContour.streamcCs ||d<dS)Nr,r)rrrrrr,'scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7-szHistogram2dContour.uidcCs ||d<dS)Nr7r)rrrrrr7=scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8CszHistogram2dContour.uirevisioncCs ||d<dS)Nr8r)rrrrrr8^scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9dszHistogram2dContour.visiblecCs ||d<dS)Nr9r)rrrrrr9uscCs|dS)z Sets the sample data to be binned on the x axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<{s zHistogram2dContour.xcCs ||d<dS)Nr<r)rrrrrr<scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>szHistogram2dContour.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)a Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` The 'xbingroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str xbingroupr)rrrrrszHistogram2dContour.xbingroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'xbins' property is an instance of XBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.XBins` - A dict of string/value properties that will be passed to the XBins constructor Supported dict properties: end Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers. size Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). start Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. Returns ------- plotly.graph_objs.histogram2dcontour.XBins xbinsr)rrrrrs2zHistogram2dContour.xbinscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszHistogram2dContour.xcalendarcCs ||d<dS)Nrr)rrrrrr scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s zHistogram2dContour.xsrccCs ||d<dS)Nr?r)rrrrrr?!scCs|dS)z Sets the sample data to be binned on the y axis. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@'s zHistogram2dContour.ycCs ||d<dS)Nr@r)rrrrrr@5scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrB;szHistogram2dContour.yaxiscCs ||d<dS)NrBr)rrrrrrBNscCs|dS)a Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` The 'ybingroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str ybingroupr)rrrrrTszHistogram2dContour.ybingroupcCs ||d<dS)Nrr)rrrrrrgscCs|dS)a The 'ybins' property is an instance of YBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2dcontour.YBins` - A dict of string/value properties that will be passed to the YBins constructor Supported dict properties: end Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers. size Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). start Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. Returns ------- plotly.graph_objs.histogram2dcontour.YBins ybinsr)rrrrrms2zHistogram2dContour.ybinscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszHistogram2dContour.ycalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs zHistogram2dContour.ysrccCs ||d<dS)NrCr)rrrrrrCscCs|dS)z Sets the aggregation data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs zHistogram2dContour.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool zautor)rrrrrszHistogram2dContour.zautocCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'zhoverformat' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str zhoverformatr)rrrrrszHistogram2dContour.zhoverformatcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zHistogram2dContour.zmaxcCs ||d<dS)Nrr)rrrrrr%scCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float zmidr)rrrrr+szHistogram2dContour.zmidcCs ||d<dS)Nrr)rrrrrr;scCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrAs zHistogram2dContour.zmincCs ||d<dS)Nrr)rrrrrrPscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrVs zHistogram2dContour.zsrccCs ||d<dS)Nrr)rrrrrrdscCs |jdS)NrD)rE)rrrrrDjszHistogram2dContour.typecCsdS)NrFr)rrrrrGpsz#Histogram2dContour._parent_path_strcCsdS)Nax9 autobinx Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. autobiny Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. autocontour Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. bingroup Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.histogram2dcontour.ColorBa r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours :class:`plotly.graph_objects.histogram2dcontour.Contour s` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively. histnorm Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1). hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.histogram2dcontour.Hoverla bel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `z` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.histogram2dcontour.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.histogram2dcontour.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. nbinsx Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. nbinsy Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. ncontours Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.histogram2dcontour.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the sample data to be binned on the x axis. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbingroup Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins :class:`plotly.graph_objects.histogram2dcontour.XBins` instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the sample data to be binned on the y axis. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybingroup Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins :class:`plotly.graph_objects.histogram2dcontour.YBins` instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the aggregation data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . r)rrrrrHvs#z%Histogram2dContour._prop_descriptionsNc:> s@ tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|: dd|_ ddl m };|;|jd<|;|jd <|;|jd <|;|jd <|;|jd <|;|jd <|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|; |jd<|;!|jd<|;"|jd<|;#|jd<|;$|jd<|;%|jd<|;&|jd<|;'|jd <|;(|jd!<|;)|jd"<|;*|jd#<|;+|jd$<|;,|jd%<|;-|jd&<|;.|jd'<|;/|jd(<|;0|jd)<|;1|jd*<|;2|jd+<|;3|jd,<|;4|jd-<|;5|jd.<|;6|jd/<|;7|jd0<|;8|jd1<|;9|jd2<|;:|jd3<|;;|jd4<|;<|jd5<|;=|jd6<|;>|jd7<|;?|jd8<|;@|jd9<|;A|jd:<|;B|jd;<|;C|jd<<|;D|jd=<|;E|jd><|;F|jd?<| dd}<|dk r|n|<|d<| d d}<|dk r|n|<|d <| d d}<|dk r|n|<|d <| d d}<|dk r|n|<|d <| d d}<|dk r|n|<|d <| d d}<|dk r@|n|<|d <| dd}<|dk rb|n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r | n|<|d<| dd}<|dk r.|n|<|d<| dd}<|dk rP|n|<|d<| dd}<|dk rr|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r>|n|<|d<| dd}<|dk r`|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| d d}<|dk r|n|<|d <| d!d}<|dk r|n|<|d!<| d"d}<|dk r |n|<|d"<| d#d}<|dk r,|n|<|d#<| d$d}<|dk rN|n|<|d$<| d%d}<|dk rp|n|<|d%<| d&d}<| dk r| n|<|d&<| d'd}<|!dk r|!n|<|d'<| d(d}<|"dk r|"n|<|d(<| d)d}<|#dk r|#n|<|d)<| d*d}<|$dk r|$n|<|d*<| d+d}<|%dk r<|%n|<|d+<| d,d}<|&dk r^|&n|<|d,<| d-d}<|'dk r|'n|<|d-<| d.d}<|(dk r|(n|<|d.<| d/d}<|)dk r|)n|<|d/<| d0d}<|*dk r|*n|<|d0<| d1d}<|+dk r|+n|<|d1<| d2d}<|,dk r*|,n|<|d2<| d3d}<|-dk rL|-n|<|d3<| d4d}<|.dk rn|.n|<|d4<| d5d}<|/dk r|/n|<|d5<| d6d}<|0dk r|0n|<|d6<| d7d}<|1dk r|1n|<|d7<| d8d}<|2dk r|2n|<|d8<| d9d}<|3dk r|3n|<|d9<| d:d}<|4dk r:|4n|<|d:<| d;d}<|5dk r\|5n|<|d;<| dd}<|8dk r|8n|<|d><| d?d}<|9dk r|9n|<|d?<dd@lGmH}=d|jIdA<|=dAdddB|jdA<| dAd|jJft|f|:d|_ dS)CaG< Construct a new Histogram2dContour object The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Histogram2dContour` autobinx Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. autobiny Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. autocontour Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. bingroup Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.histogram2dcontour.ColorBa r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours :class:`plotly.graph_objects.histogram2dcontour.Contour s` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively. histnorm Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1). hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.histogram2dcontour.Hoverla bel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `z` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.histogram2dcontour.Line` instance or dict with compatible properties marker :class:`plotly.graph_objects.histogram2dcontour.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. nbinsx Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. nbinsy Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. ncontours Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.histogram2dcontour.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the sample data to be binned on the x axis. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbingroup Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins :class:`plotly.graph_objects.histogram2dcontour.XBins` instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the sample data to be binned on the y axis. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybingroup Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins :class:`plotly.graph_objects.histogram2dcontour.YBins` instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . z Sets the aggregation data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . Returns ------- Histogram2dContour histogram2dcontourNzThe first argument to the plotly.graph_objs.Histogram2dContour constructor must be a dict or an instance of :class:`plotly.graph_objs.Histogram2dContour`rJFr)rr r rr r rrrrr rrrrrrrrrrrrrr!r"r#rrrr'rr+rr,r7r8r9r<r>rrrr?r@rBrrrrCrrrrrrr)rKrD)rLrMr)KrNr rOrPrQrRrSrTrUrVrWrXrYrAutobinxValidatorr[AutobinyValidatorrAutocontourValidatorBingroupValidatorrrrrr`raHistfuncValidatorHistnormValidatorrerfrgrhrirlrmrqrrrrrsrtNbinsxValidatorNbinsyValidatorNcontoursValidatorrxrr|rr}rrrrrXbingroupValidatorXBinsValidatorrrrrYbingroupValidatorYBinsValidatorrrrZautoValidatorZhoverformatValidatorr ZmidValidatorrrrrKrEr)>rrr r rr r rrrrr rrrrrrrrrrrrrr!r"r#rrrr'rr+rr,r7r8r9r<r>rrrr?r@rBrrrrCrrrrrrrrZv_histogram2dcontourrrK)rQrrrOs|r                                                                zHistogram2dContour.__init__)9NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Brrrrr rr rr r rrrrr rrrrrrrrrrrrrr!r"r#rrrr'rr+rr,r7r8r9r<r>rrrr?r@rBrrrrCrrrrrrrrDrGrHrOrrr)rQrr s^       g . Q       5 #                        4      4            'r c8seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZdfdd Z?Z@S) Histogram2dcCs|dS)a Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. The 'autobinx' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr szHistogram2d.autobinxcCs ||d<dS)Nr r)rrrrrr  scCs|dS)a Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. The 'autobiny' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr szHistogram2d.autobinycCs ||d<dS)Nr r)rrrrrr  scCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr&szHistogram2d.autocolorscalecCs ||d<dS)Nrr)rrrrrr9scCs|dS)a Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. The 'bingroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r r)rrrrr ?szHistogram2d.bingroupcCs ||d<dS)Nr r)rrrrrr PscCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrVszHistogram2d.coloraxiscCs ||d<dS)Nrr)rrrrrrkscCs|dS)a- The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.histogr am2d.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram2d.colorbar.tickformatstopdefaults), sets the default property values to use for elements of histogram2d.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.histogram2d.colorb ar.Title` instance or dict with compatible properties titlefont Deprecated: Please use histogram2d.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use histogram2d.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.histogram2d.ColorBar rr)rrrrrqsezHistogram2d.colorbarcCs ||d<dS)Nrr)rrrrrrWscCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrr]s,zHistogram2d.colorscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szHistogram2d.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram2d.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ap Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively. The 'histfunc' property is an enumeration that may be specified as: - One of the following enumeration values: ['count', 'sum', 'avg', 'min', 'max'] Returns ------- Any rr)rrrrrszHistogram2d.histfunccCs ||d<dS)Nrr)rrrrrrscCs|dS)a Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1). The 'histnorm' property is an enumeration that may be specified as: - One of the following enumeration values: ['', 'percent', 'probability', 'density', 'probability density'] Returns ------- Any rr)rrrrrszHistogram2d.histnormcCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszHistogram2d.hoverinfocCs ||d<dS)Nrr)rrrrrr scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram2d.hoverinfosrccCs ||d<dS)Nrr)rrrrrr scCs|dS)a  The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.histogram2d.Hoverlabel rr)rrrrr&s3zHistogram2d.hoverlabelcCs ||d<dS)Nrr)rrrrrr[scCs|dS)a* Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variable `z` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrras!zHistogram2d.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram2d.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrszHistogram2d.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram2d.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszHistogram2d.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)aV The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: color Sets the aggregation data. colorsrc Sets the source reference on plot.ly for color . Returns ------- plotly.graph_objs.histogram2d.Marker rr)rrrrrszHistogram2d.markercCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szHistogram2d.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zHistogram2d.metasrccCs ||d<dS)Nr"r)rrrrrr"&scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#,szHistogram2d.namecCs ||d<dS)Nr#r)rrrrrr#<scCs|dS)a Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. The 'nbinsx' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns ------- int rr)rrrrrBszHistogram2d.nbinsxcCs ||d<dS)Nrr)rrrrrrTscCs|dS)a Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. The 'nbinsy' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns ------- int rr)rrrrrZszHistogram2d.nbinsycCs ||d<dS)Nrr)rrrrrrlscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'rs zHistogram2d.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszHistogram2d.reversescalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zHistogram2d.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrs zHistogram2d.showscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)ap The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.histogram2d.Stream r,r)rrrrr,szHistogram2d.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7szHistogram2d.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szHistogram2d.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szHistogram2d.visiblecCs ||d<dS)Nr9r)rrrrrr9/scCs|dS)z Sets the sample data to be binned on the x axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<5s z Histogram2d.xcCs ||d<dS)Nr<r)rrrrrr<CscCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>IszHistogram2d.xaxiscCs ||d<dS)Nr>r)rrrrrr>\scCs|dS)a Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` The 'xbingroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrbszHistogram2d.xbingroupcCs ||d<dS)Nrr)rrrrrruscCs|dS)a The 'xbins' property is an instance of XBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.XBins` - A dict of string/value properties that will be passed to the XBins constructor Supported dict properties: end Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers. size Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). start Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. Returns ------- plotly.graph_objs.histogram2d.XBins rr)rrrrr{s2zHistogram2d.xbinscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszHistogram2d.xcalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the horizontal gap (in pixels) between bricks. The 'xgap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float xgapr)rrrrr,s zHistogram2d.xgapcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s zHistogram2d.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)z Sets the sample data to be binned on the y axis. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@s z Histogram2d.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrB szHistogram2d.yaxiscCs ||d<dS)NrBr)rrrrrrBscCs|dS)a Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` The 'ybingroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr"szHistogram2d.ybingroupcCs ||d<dS)Nrr)rrrrrr5scCs|dS)a The 'ybins' property is an instance of YBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.YBins` - A dict of string/value properties that will be passed to the YBins constructor Supported dict properties: end Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers. size Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). start Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. Returns ------- plotly.graph_objs.histogram2d.YBins rr)rrrrr;s2zHistogram2d.ybinscCs ||d<dS)Nrr)rrrrrroscCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrruszHistogram2d.ycalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the vertical gap (in pixels) between bricks. The 'ygap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float ygapr)rrrrr-s zHistogram2d.ygapcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs zHistogram2d.ysrccCs ||d<dS)NrCr)rrrrrrCscCs|dS)z Sets the aggregation data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs z Histogram2d.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszHistogram2d.zautocCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'zhoverformat' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszHistogram2d.zhoverformatcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zHistogram2d.zmaxcCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr szHistogram2d.zmidcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr#s zHistogram2d.zmincCs ||d<dS)Nrr)rrrrrr2scCs|dS)a Picks a smoothing algorithm use to smooth `z` data. The 'zsmooth' property is an enumeration that may be specified as: - One of the following enumeration values: ['fast', 'best', False] Returns ------- Any zsmoothr)rrrrr.8s zHistogram2d.zsmoothcCs ||d<dS)Nr.r)rrrrrr.GscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrMs zHistogram2d.zsrccCs ||d<dS)Nrr)rrrrrr[scCs |jdS)NrD)rE)rrrrrDaszHistogram2d.typecCsdS)NrFr)rrrrrGgszHistogram2d._parent_path_strcCsdS)Na6 autobinx Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. autobiny Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. bingroup Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.histogram2d.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively. histnorm Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1). hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.histogram2d.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `z` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.histogram2d.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. nbinsx Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. nbinsy Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.histogram2d.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the sample data to be binned on the x axis. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbingroup Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins :class:`plotly.graph_objects.histogram2d.XBins` instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xgap Sets the horizontal gap (in pixels) between bricks. xsrc Sets the source reference on plot.ly for x . y Sets the sample data to be binned on the y axis. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybingroup Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins :class:`plotly.graph_objects.histogram2d.YBins` instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ygap Sets the vertical gap (in pixels) between bricks. ysrc Sets the source reference on plot.ly for y . z Sets the aggregation data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsmooth Picks a smoothing algorithm use to smooth `z` data. zsrc Sets the source reference on plot.ly for z . r)rrrrrHmszHistogram2d._prop_descriptionsNc9= s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|9 dd|_ ddl m }:|:|jd<|:|jd <|:|jd <|:|jd <|:|jd <|:|jd <|:|jd<|:|jd<|:|jd<|:|jd<|:|jd<|:|jd<|:|jd<|:|jd<|:|jd<|:|jd<|:|jd<|: |jd<|:!|jd<|:"|jd<|:#|jd<|:$|jd<|:%|jd<|:&|jd<|:'|jd <|:(|jd!<|:)|jd"<|:*|jd#<|:+|jd$<|:,|jd%<|:-|jd&<|:.|jd'<|:/|jd(<|:0|jd)<|:1|jd*<|:2|jd+<|:3|jd,<|:4|jd-<|:5|jd.<|:6|jd/<|:7|jd0<|:8|jd1<|:9|jd2<|::|jd3<|:;|jd4<|:<|jd5<|:=|jd6<|:>|jd7<|:?|jd8<|:@|jd9<|:A|jd:<|:B|jd;<|:C|jd<<|:D|jd=<|:E|jd><| dd};|dk r|n|;|d<| d d};|dk r|n|;|d <| d d};|dk r|n|;|d <| d d};|dk r|n|;|d <| d d};|dk r|n|;|d <| d d};|dk r2|n|;|d <| dd};|dk rT|n|;|d<| dd};| dk rv| n|;|d<| dd};| dk r| n|;|d<| dd};| dk r| n|;|d<| dd};| dk r| n|;|d<| dd};| dk r| n|;|d<| dd};|dk r |n|;|d<| dd};|dk rB|n|;|d<| dd};|dk rd|n|;|d<| dd};|dk r|n|;|d<| dd};|dk r|n|;|d<| dd};|dk r|n|;|d<| dd};|dk r|n|;|d<| dd};|dk r|n|;|d<| dd};|dk r0|n|;|d<| dd};|dk rR|n|;|d<| dd};|dk rt|n|;|d<| dd};|dk r|n|;|d<| d d};|dk r|n|;|d <| d!d};|dk r|n|;|d!<| d"d};|dk r|n|;|d"<| d#d};|dk r|n|;|d#<| d$d};|dk r@|n|;|d$<| d%d};|dk rb|n|;|d%<| d&d};| dk r| n|;|d&<| d'd};|!dk r|!n|;|d'<| d(d};|"dk r|"n|;|d(<| d)d};|#dk r|#n|;|d)<| d*d};|$dk r |$n|;|d*<| d+d};|%dk r.|%n|;|d+<| d,d};|&dk rP|&n|;|d,<| d-d};|'dk rr|'n|;|d-<| d.d};|(dk r|(n|;|d.<| d/d};|)dk r|)n|;|d/<| d0d};|*dk r|*n|;|d0<| d1d};|+dk r|+n|;|d1<| d2d};|,dk r|,n|;|d2<| d3d};|-dk r>|-n|;|d3<| d4d};|.dk r`|.n|;|d4<| d5d};|/dk r|/n|;|d5<| d6d};|0dk r|0n|;|d6<| d7d};|1dk r|1n|;|d7<| d8d};|2dk r|2n|;|d8<| d9d};|3dk r |3n|;|d9<| d:d};|4dk r,|4n|;|d:<| d;d};|5dk rN|5n|;|d;<| dd};|8dk r|8n|;|d><dd?lFmG}<d|jHd@<|` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.histogram2d.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. nbinsx Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. nbinsy Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.histogram2d.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the sample data to be binned on the x axis. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbingroup Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins :class:`plotly.graph_objects.histogram2d.XBins` instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xgap Sets the horizontal gap (in pixels) between bricks. xsrc Sets the source reference on plot.ly for x . y Sets the sample data to be binned on the y axis. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybingroup Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins :class:`plotly.graph_objects.histogram2d.YBins` instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ygap Sets the vertical gap (in pixels) between bricks. ysrc Sets the source reference on plot.ly for y . z Sets the aggregation data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsmooth Picks a smoothing algorithm use to smooth `z` data. zsrc Sets the source reference on plot.ly for z . Returns ------- Histogram2d histogram2dNzThe first argument to the plotly.graph_objs.Histogram2d constructor must be a dict or an instance of :class:`plotly.graph_objs.Histogram2d`rJFr)r/r r rr rrrr rrrrrrrrrrrrr!r"r#rrr'rr+rr,r7r8r9r<r>rrrr,r?r@rBrrrr-rCrrrrrrr.r)rKrD)rLrMr)JrNr+rOrPrQrRrSrTrUrVrWrXrYr/rr[rrrrrrr`rarr rerfrgrhrirlrmrqrrrrsrtr!r"rxrr|rr}rrrrrr$r%r XgapValidatorrrrr&r'r YgapValidatorrrr(r)rr*rZsmoothValidatorrrrKrEr)=rrr r rr rrrr rrrrrrrrrrrrr!r"r#rrr'rr+rr,r7r8r9r<r>rrrr,r?r@rBrrrr-rCrrrrrrr.rrZ v_histogram2drrK)rQrrrOsre                                                               zHistogram2d.__init__)8NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Arrrrr rr rr rrrr rrrrrrrrrrrrr!r"r#rrr'rr+rr,r7r8r9r<r>rrrr,r?r@rBrrrr-rCrrrrrrr.rrDrGrHrOrrr)rQrr+sX      g .       5 #                      4       4              r+c3sVeZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7eddZ8eddZ9dfdd Z:Z;S) HistogramcCs|dS)a Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. The 'alignmentgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszHistogram.alignmentgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. The 'autobinx' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr szHistogram.autobinxcCs ||d<dS)Nr r)rrrrrr scCs|dS)a Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. The 'autobiny' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr szHistogram.autobinycCs ||d<dS)Nr r)rrrrrr  scCs|dS)a Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same "orientation" under `barmode` "stack", "relative" and "group" are forced into the same bingroup, Using `bingroup`, traces under `barmode` "overlay" and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup` The 'bingroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r r)rrrrr szHistogram.bingroupcCs ||d<dS)Nr r)rrrrrr $scCs|dS)a The 'cumulative' property is an instance of Cumulative that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.Cumulative` - A dict of string/value properties that will be passed to the Cumulative constructor Supported dict properties: currentbin Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. "include" is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. "exclude" makes the opposite half- bin bias, and "half" removes it. direction Only applies if cumulative is enabled. If "increasing" (default) we sum all prior bins, so the result increases from left to right. If "decreasing" we sum later bins so the result decreases from left to right. enabled If true, display the cumulative distribution by summing the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the same as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and *probability density* both rise to the number of sample points. Returns ------- plotly.graph_objs.histogram.Cumulative cumulativer)rrrrr4*s*zHistogram.cumulativecCs ||d<dS)Nr4r)rrrrrr4VscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr \szHistogram.customdatacCs ||d<dS)Nr r)rrrrrr mscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrss zHistogram.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a' The 'error_x' property is an instance of ErrorX that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. copy_ystyle symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.histogram.ErrorX ryr)rrrrrysIzHistogram.error_xcCs ||d<dS)Nryr)rrrrrryscCs|dS)a The 'error_y' property is an instance of ErrorY that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.histogram.ErrorY rzr)rrrrrzsGzHistogram.error_ycCs ||d<dS)Nrzr)rrrrrrz!scCs|dS)ap Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively. The 'histfunc' property is an enumeration that may be specified as: - One of the following enumeration values: ['count', 'sum', 'avg', 'min', 'max'] Returns ------- Any rr)rrrrr'szHistogram.histfunccCs ||d<dS)Nrr)rrrrrr;scCs|dS)a Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1). The 'histnorm' property is an enumeration that may be specified as: - One of the following enumeration values: ['', 'percent', 'probability', 'density', 'probability density'] Returns ------- Any rr)rrrrrAszHistogram.histnormcCs ||d<dS)Nrr)rrrrrr]scCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrcszHistogram.hoverinfocCs ||d<dS)Nrr)rrrrrrwscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr}s zHistogram.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.histogram.Hoverlabel rr)rrrrrs3zHistogram.hoverlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)a2 Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variable `binNumber` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrs!zHistogram.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr szHistogram.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHistogram.hovertextsrccCs ||d<dS)Nrr)rrrrrr-scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr3sz Histogram.idscCs ||d<dS)Nrr)rrrrrrCscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrIs zHistogram.idssrccCs ||d<dS)Nrr)rrrrrrWscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr]szHistogram.legendgroupcCs ||d<dS)Nrr)rrrrrrnscCs|dS)a3 The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.histogram.marker.C olorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . line :class:`plotly.graph_objects.histogram.marker.L ine` instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. Returns ------- plotly.graph_objs.histogram.Marker rr)rrrrrtspzHistogram.markercCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szHistogram.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zHistogram.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#szHistogram.namecCs ||d<dS)Nr#r)rrrrrr#,scCs|dS)a Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. The 'nbinsx' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns ------- int rr)rrrrr2szHistogram.nbinsxcCs ||d<dS)Nrr)rrrrrrDscCs|dS)a Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. The 'nbinsy' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns ------- int rr)rrrrrJszHistogram.nbinsycCs ||d<dS)Nrr)rrrrrr\scCs|dS)a Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. The 'offsetgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r%r)rrrrr%bszHistogram.offsetgroupcCs ||d<dS)Nr%r)rrrrrr%sscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'ys zHistogram.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)a] Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). The 'orientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['v', 'h'] Returns ------- Any r(r)rrrrr(szHistogram.orientationcCs ||d<dS)Nr(r)rrrrrr(scCs|dS)a The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.histogram.selected .Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.histogram.selected .Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.histogram.Selected rr)rrrrrszHistogram.selectedcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*szHistogram.selectedpointscCs ||d<dS)Nr*r)rrrrrr*scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zHistogram.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)al The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.histogram.Stream r,r)rrrrr,szHistogram.streamcCs ||d<dS)Nr,r)rrrrrr, scCs|dS)a Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-szHistogram.textcCs ||d<dS)Nr-r)rrrrrr-$scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3*s zHistogram.textsrccCs ||d<dS)Nr3r)rrrrrr38scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7>sz Histogram.uidcCs ||d<dS)Nr7r)rrrrrr7NscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8TszHistogram.uirevisioncCs ||d<dS)Nr8r)rrrrrr8oscCs|dS)a& The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.histogram.unselect ed.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.histogram.unselect ed.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.histogram.Unselected rr)rrrrruszHistogram.unselectedcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szHistogram.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs|dS)z Sets the sample data to be binned on the x axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<s z Histogram.xcCs ||d<dS)Nr<r)rrrrrr<scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>szHistogram.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)a The 'xbins' property is an instance of XBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.XBins` - A dict of string/value properties that will be passed to the XBins constructor Supported dict properties: end Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers. size Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above. start Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non- overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins. Returns ------- plotly.graph_objs.histogram.XBins rr)rrrrrs= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrB]szHistogram.yaxiscCs ||d<dS)NrBr)rrrrrrBpscCs|dS)a The 'ybins' property is an instance of YBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram.YBins` - A dict of string/value properties that will be passed to the YBins constructor Supported dict properties: end Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers. size Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above. start Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non- overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins. Returns ------- plotly.graph_objs.histogram.YBins rr)rrrrrvs` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.histogram.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. nbinsx Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. nbinsy Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). selected :class:`plotly.graph_objects.histogram.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.histogram.Stream` instance or dict with compatible properties text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.histogram.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the sample data to be binned on the x axis. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbins :class:`plotly.graph_objects.histogram.XBins` instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the sample data to be binned on the y axis. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybins :class:`plotly.graph_objects.histogram.YBins` instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . r)rrrrrHsvzHistogram._prop_descriptionsNc48 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|4 dd|_ ddl m }5|5|jd<|5|jd <|5|jd <|5|jd <|5|jd <|5|jd <|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5|jd<|5 |jd<|5!|jd<|5"|jd<|5#|jd<|5$|jd<|5%|jd<|5&|jd<|5'|jd <|5(|jd!<|5)|jd"<|5*|jd#<|5+|jd$<|5,|jd%<|5-|jd&<|5.|jd'<|5/|jd(<|50|jd)<|51|jd*<|52|jd+<|53|jd,<|54|jd-<|55|jd.<|56|jd/<|57|jd0<|58|jd1<|59|jd2<|5:|jd3<|5;|jd4<|5<|jd5<|5=|jd6<|5>|jd7<|5?|jd8<|5@|jd9<| dd}6|dk rB|n|6|d<| d d}6|dk rd|n|6|d <| d d}6|dk r|n|6|d <| d d}6|dk r|n|6|d <| d d}6|dk r|n|6|d <| d d}6|dk r|n|6|d <| dd}6|dk r|n|6|d<| dd}6| dk r0| n|6|d<| dd}6| dk rR| n|6|d<| dd}6| dk rt| n|6|d<| dd}6| dk r| n|6|d<| dd}6| dk r| n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r@|n|6|d<| dd}6|dk rb|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r|n|6|d<| dd}6|dk r |n|6|d<| dd}6|dk r.|n|6|d<| dd}6|dk rP|n|6|d<| d d}6|dk rr|n|6|d <| d!d}6|dk r|n|6|d!<| d"d}6|dk r|n|6|d"<| d#d}6|dk r|n|6|d#<| d$d}6|dk r|n|6|d$<| d%d}6|dk r|n|6|d%<| d&d}6| dk r>| n|6|d&<| d'd}6|!dk r`|!n|6|d'<| d(d}6|"dk r|"n|6|d(<| d)d}6|#dk r|#n|6|d)<| d*d}6|$dk r|$n|6|d*<| d+d}6|%dk r|%n|6|d+<| d,d}6|&dk r |&n|6|d,<| d-d}6|'dk r,|'n|6|d-<| d.d}6|(dk rN|(n|6|d.<| d/d}6|)dk rp|)n|6|d/<| d0d}6|*dk r|*n|6|d0<| d1d}6|+dk r|+n|6|d1<| d2d}6|,dk r|,n|6|d2<| d3d}6|-dk r|-n|6|d3<| d4d}6|.dk r|.n|6|d4<| d5d}6|/dk r<|/n|6|d5<| d6d}6|0dk r^|0n|6|d6<| d7d}6|1dk r|1n|6|d7<| d8d}6|2dk r|2n|6|d8<| d9d}6|3dk r|3n|6|d9<dd:lAmB}7d|jCd;<|7d;ddd<|jd;<| d;d|jDft|f|4d|_ dS)=aQ2 Construct a new Histogram object The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Histogram` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. autobinx Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. autobiny Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. bingroup Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same "orientation" under `barmode` "stack", "relative" and "group" are forced into the same bingroup, Using `bingroup`, traces under `barmode` "overlay" and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup` cumulative :class:`plotly.graph_objects.histogram.Cumulative` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . error_x :class:`plotly.graph_objects.histogram.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.histogram.ErrorY` instance or dict with compatible properties histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively. histnorm Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1). hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.histogram.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `binNumber` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.histogram.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. nbinsx Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. nbinsy Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). selected :class:`plotly.graph_objects.histogram.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.histogram.Stream` instance or dict with compatible properties text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.histogram.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the sample data to be binned on the x axis. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbins :class:`plotly.graph_objects.histogram.XBins` instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the sample data to be binned on the y axis. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybins :class:`plotly.graph_objects.histogram.YBins` instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . Returns ------- Histogram histogramNzThe first argument to the plotly.graph_objs.Histogram constructor must be a dict or an instance of :class:`plotly.graph_objs.Histogram`rJFr)r5rr r r r4r rryrzrrrrrrrrrrrrrr!r"r#rrr%r'r(rr*r+r,r-r3r7r8rr9r<r>rrr?r@rBrrrC)rKrD)rLrMr)ErNr3rOrPrQrRrSrTrUrVrWrXrYr5rZr[rrrZCumulativeValidatorr`rar|r}rr rerfrgrhrirjrkrlrmrqrrrrsrtr!r"rvrxryrr{r|r}r~rrrrrrrr%rrrrr'rrrrKrEr)8rrrr r r r4r rryrzrrrrrrrrrrrrrr!r"r#rrr%r'r(rr*r+r,r-r3r7r8rr9r<r>rrr?r@rBrrrCrZ v_histogramrrK)rQrrrOsT>                                                          zHistogram.__init__)3NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)rrr?r@rBrrrCrDrGrHrOrrr)rQrr3s6     ,   K I     5 #       r                     >     >     zr3c+seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/eddZ0eddZ1dfdd Z2Z3S) HeatmapglcCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszHeatmapgl.autocolorscalecCs ||d<dS)Nrr)rrrrrr scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrszHeatmapgl.coloraxiscCs ||d<dS)Nrr)rrrrrr&scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.heatmapgl.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.heatmap gl.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.heatmapgl.colorbar.tickformatstopdefaults), sets the default property values to use for elements of heatmapgl.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.heatmapgl.colorbar .Title` instance or dict with compatible properties titlefont Deprecated: Please use heatmapgl.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use heatmapgl.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.heatmapgl.ColorBar rr)rrrrr,sdzHeatmapgl.colorbarcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrrs,zHeatmapgl.colorscalecCs ||d<dS)Nrr)rrrrrrEscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr KszHeatmapgl.customdatacCs ||d<dS)Nr r)rrrrrr \scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrbs zHeatmapgl.customdatasrccCs ||d<dS)Nrr)rrrrrrpscCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrvs z Heatmapgl.dxcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs z Heatmapgl.dycCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszHeatmapgl.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmapgl.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.heatmapgl.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.heatmapgl.Hoverlabel rr)rrrrrs3zHeatmapgl.hoverlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Heatmapgl.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmapgl.idssrccCs ||d<dS)Nrr)rrrrrr+scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!1szHeatmapgl.metacCs ||d<dS)Nr!r)rrrrrr!GscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Ms zHeatmapgl.metasrccCs ||d<dS)Nr"r)rrrrrr"[scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#aszHeatmapgl.namecCs ||d<dS)Nr#r)rrrrrr#qscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'ws zHeatmapgl.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszHeatmapgl.reversescalecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrs zHeatmapgl.showscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)al The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.heatmapgl.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.heatmapgl.Stream r,r)rrrrr,szHeatmapgl.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)z Sets the text elements associated with each z value. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-s zHeatmapgl.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zHeatmapgl.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)z Transposes the z data. The 'transpose' property must be specified as a bool (either True, or False) Returns ------- bool transposer)rrrrr7s zHeatmapgl.transposecCs ||d<dS)Nr7r)rrrrrr7 scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7sz Heatmapgl.uidcCs ||d<dS)Nr7r)rrrrrr7#scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8)szHeatmapgl.uirevisioncCs ||d<dS)Nr8r)rrrrrr8DscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9JszHeatmapgl.visiblecCs ||d<dS)Nr9r)rrrrrr9[scCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<as z Heatmapgl.xcCs ||d<dS)Nr<r)rrrrrr<oscCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr=us z Heatmapgl.x0cCs ||d<dS)Nr=r)rrrrrr=scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>szHeatmapgl.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s zHeatmapgl.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)a If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). The 'xtype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any xtyper)rrrrr8szHeatmapgl.xtypecCs ||d<dS)Nr8r)rrrrrr8scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@s z Heatmapgl.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAs z Heatmapgl.y0cCs ||d<dS)NrAr)rrrrrrAscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBszHeatmapgl.yaxiscCs ||d<dS)NrBr)rrrrrrB scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCs zHeatmapgl.ysrccCs ||d<dS)NrCr)rrrrrrCscCs|dS)a If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) The 'ytype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any ytyper)rrrrr9%szHeatmapgl.ytypecCs ||d<dS)Nr9r)rrrrrr97scCs|dS)z Sets the z data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr=s z Heatmapgl.zcCs ||d<dS)Nrr)rrrrrrKscCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrQszHeatmapgl.zautocCs ||d<dS)Nrr)rrrrrrbscCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrhs zHeatmapgl.zmaxcCs ||d<dS)Nrr)rrrrrrwscCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr}szHeatmapgl.zmidcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zHeatmapgl.zmincCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmapgl.zsrccCs ||d<dS)Nrr)rrrrrrscCs |jdS)NrD)rE)rrrrrDszHeatmapgl.typecCsdS)NrFr)rrrrrGszHeatmapgl._parent_path_strcCsdS)Na " autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.heatmapgl.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.heatmapgl.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.heatmapgl.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . transpose Transposes the z data. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . xtype If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . ytype If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) z Sets the z data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . r)rrrrrHs7zHeatmapgl._prop_descriptionsNc,0 stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|, dd|_ ddl m }-|-|jd<|-|jd <|-|jd <|-|jd <|-|jd <|-|jd <|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|- |jd<|-!|jd<|-"|jd<|-#|jd<|-$|jd<|-%|jd<|-&|jd<|-'|jd <|-(|jd!<|-)|jd"<|-*|jd#<|-+|jd$<|-,|jd%<|--|jd&<|-.|jd'<|-/|jd(<|-0|jd)<|-1|jd*<|-2|jd+<|-3|jd,<|-4|jd-<|-5|jd.<|-6|jd/<|-7|jd0<|-8|jd1<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d d}.|dk r|n|.|d <| d d}.|dk r8|n|.|d <| d d}.|dk rZ|n|.|d <| d d}.|dk r||n|.|d <| dd}.|dk r|n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r&| n|.|d<| dd}.| dk rH| n|.|d<| dd}.|dk rj|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r6|n|.|d<| dd}.|dk rX|n|.|d<| dd}.|dk rz|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d!d}.|dk r$|n|.|d!<| d"d}.|dk rF|n|.|d"<| d#d}.|dk rh|n|.|d#<| d$d}.|dk r|n|.|d$<| d%d}.|dk r|n|.|d%<| d&d}.| dk r| n|.|d&<| d'd}.|!dk r|!n|.|d'<| d(d}.|"dk r|"n|.|d(<| d)d}.|#dk r4|#n|.|d)<| d*d}.|$dk rV|$n|.|d*<| d+d}.|%dk rx|%n|.|d+<| d,d}.|&dk r|&n|.|d,<| d-d}.|'dk r|'n|.|d-<| d.d}.|(dk r|(n|.|d.<| d/d}.|)dk r|)n|.|d/<| d0d}.|*dk r"|*n|.|d0<| d1d}.|+dk rD|+n|.|d1<dd2l9m:}/d|j;d3<|/d3ddd4|jd3<| d3d|jr?r8r@rArBrCr9rrrrrr)rKrD)rLrMr)=rNr6rOrPrQrRrSrTrUrVrWrXrYr:rr[rrrr`rarcrdrerfrgrlrmrrrsrtrxrrr}r~rTransposeValidatorrrrrrrrXtypeValidatorrrrrYtypeValidatorrr(rr*rrrrKrEr)0rrrrrrr rrrrrrrrr!r"r#r'rrr,r-r3r7r7r8r9r<r=r>r?r8r@rArBrCr9rrrrrrrZ v_heatmapglrrK)rQrrrOs"r                                                  zHeatmapgl.__init__)+NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)4rrrrrrrrrr rrrrrrrrr!r"r#r'rrr,r-r3r7r7r8r9r<r=r>r?r8r@rArBrCr9rrrrrrrDrGrHrOrrr)rQrr6s   f .       5                                  ;r6c9seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZeddZ?dfdd Z@ZAS)HeatmapcCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr*szHeatmap.autocolorscalecCs ||d<dS)Nrr)rrrrrr=scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrCszHeatmap.coloraxiscCs ||d<dS)Nrr)rrrrrrXscCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.heatmap.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.heatmap .colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.heatmap.colorbar.tickformatstopdefaults), sets the default property values to use for elements of heatmap.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.heatmap.colorbar.T itle` instance or dict with compatible properties titlefont Deprecated: Please use heatmap.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use heatmap.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.heatmap.ColorBar rr)rrrrr^sdzHeatmap.colorbarcCs ||d<dS)Nrr)rrrrrrCscCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrrIs,zHeatmap.colorscalecCs ||d<dS)Nrr)rrrrrrwscCs|dS)a Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr}szHeatmap.connectgapscCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szHeatmap.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmap.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs z Heatmap.dxcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs z Heatmap.dycCs ||d<dS)Nrr)rrrrrrscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszHeatmap.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmap.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.heatmap.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.heatmap.Hoverlabel rr)rrrrrs3zHeatmap.hoverlabelcCs ||d<dS)Nrr)rrrrrrJscCs|dS)a! Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. The 'hoverongaps' property must be specified as a bool (either True, or False) Returns ------- bool hoverongapsr)rrrrr?Ps zHeatmap.hoverongapscCs ||d<dS)Nr?r)rrrrrr?_scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrres!zHeatmap.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmap.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Same as `text`. The 'hovertext' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs zHeatmap.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmap.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Heatmap.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zHeatmap.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszHeatmap.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr! sz Heatmap.metacCs ||d<dS)Nr!r)rrrrrr!!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"'s zHeatmap.metasrccCs ||d<dS)Nr"r)rrrrrr"5scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#;sz Heatmap.namecCs ||d<dS)Nr#r)rrrrrr#KscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'Qs zHeatmap.opacitycCs ||d<dS)Nr'r)rrrrrr'_scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrreszHeatmap.reversescalecCs ||d<dS)Nrr)rrrrrruscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+{s zHeatmap.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrs zHeatmap.showscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)ah The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.heatmap.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.heatmap.Stream r,r)rrrrr,szHeatmap.streamcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)z Sets the text elements associated with each z value. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-s z Heatmap.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zHeatmap.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)z Transposes the z data. The 'transpose' property must be specified as a bool (either True, or False) Returns ------- bool r7r)rrrrr7s zHeatmap.transposecCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7sz Heatmap.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szHeatmap.uirevisioncCs ||d<dS)Nr8r)rrrrrr83scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr99szHeatmap.visiblecCs ||d<dS)Nr9r)rrrrrr9JscCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<Ps z Heatmap.xcCs ||d<dS)Nr<r)rrrrrr<^scCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr=ds z Heatmap.x0cCs ||d<dS)Nr=r)rrrrrr=sscCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>ysz Heatmap.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrszHeatmap.xcalendarcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the horizontal gap (in pixels) between bricks. The 'xgap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float r,r)rrrrr,s z Heatmap.xgapcCs ||d<dS)Nr,r)rrrrrr,scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?s z Heatmap.xsrccCs ||d<dS)Nr?r)rrrrrr?scCs|dS)a If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). The 'xtype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any r8r)rrrrr8sz Heatmap.xtypecCs ||d<dS)Nr8r)rrrrrr8scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@s z Heatmap.ycCs ||d<dS)Nr@r)rrrrrr@scCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAs z Heatmap.y0cCs ||d<dS)NrAr)rrrrrrA scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBsz Heatmap.yaxiscCs ||d<dS)NrBr)rrrrrrB&scCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrr,szHeatmap.ycalendarcCs ||d<dS)Nrr)rrrrrr>scCs|dS)z Sets the vertical gap (in pixels) between bricks. The 'ygap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float r-r)rrrrr-Ds z Heatmap.ygapcCs ||d<dS)Nr-r)rrrrrr-RscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCXs z Heatmap.ysrccCs ||d<dS)NrCr)rrrrrrCfscCs|dS)a If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) The 'ytype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any r9r)rrrrr9lsz Heatmap.ytypecCs ||d<dS)Nr9r)rrrrrr9~scCs|dS)z Sets the z data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs z Heatmap.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrsz Heatmap.zautocCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'zhoverformat' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszHeatmap.zhoverformatcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs z Heatmap.zmaxcCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrsz Heatmap.zmidcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs z Heatmap.zmincCs ||d<dS)Nrr)rrrrrrscCs|dS)a Picks a smoothing algorithm use to smooth `z` data. The 'zsmooth' property is an enumeration that may be specified as: - One of the following enumeration values: ['fast', 'best', False] Returns ------- Any r.r)rrrrr.s zHeatmap.zsmoothcCs ||d<dS)Nr.r)rrrrrr.scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Heatmap.zsrccCs ||d<dS)Nrr)rrrrrr*scCs |jdS)NrD)rE)rrrrrD0sz Heatmap.typecCsdS)NrFr)rrrrrG6szHeatmap._parent_path_strcCsdS)Na. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.heatmap.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.heatmap.Hoverlabel` instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.heatmap.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . transpose Transposes the z data. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xgap Sets the horizontal gap (in pixels) between bricks. xsrc Sets the source reference on plot.ly for x . xtype If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ygap Sets the vertical gap (in pixels) between bricks. ysrc Sets the source reference on plot.ly for y . ytype If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) z Sets the z data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsmooth Picks a smoothing algorithm use to smooth `z` data. zsrc Sets the source reference on plot.ly for z . r)rrrrrH<stzHeatmap._prop_descriptionsNc:> s@ tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|: dd|_ ddl m };|;|jd<|;|jd <|;|jd <|;|jd <|;|jd <|;|jd <|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|;|jd<|; |jd<|;!|jd<|;"|jd<|;#|jd<|;$|jd<|;%|jd<|;&|jd<|;'|jd <|;(|jd!<|;)|jd"<|;*|jd#<|;+|jd$<|;,|jd%<|;-|jd&<|;.|jd'<|;/|jd(<|;0|jd)<|;1|jd*<|;2|jd+<|;3|jd,<|;4|jd-<|;5|jd.<|;6|jd/<|;7|jd0<|;8|jd1<|;9|jd2<|;:|jd3<|;;|jd4<|;<|jd5<|;=|jd6<|;>|jd7<|;?|jd8<|;@|jd9<|;A|jd:<|;B|jd;<|;C|jd<<|;D|jd=<|;E|jd><|;F|jd?<| dd}<|dk r|n|<|d<| d d}<|dk r|n|<|d <| d d}<|dk r|n|<|d <| d d}<|dk r|n|<|d <| d d}<|dk r|n|<|d <| d d}<|dk r@|n|<|d <| dd}<|dk rb|n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r| n|<|d<| dd}<| dk r | n|<|d<| dd}<|dk r.|n|<|d<| dd}<|dk rP|n|<|d<| dd}<|dk rr|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r>|n|<|d<| dd}<|dk r`|n|<|d<| dd}<|dk r|n|<|d<| dd}<|dk r|n|<|d<| d d}<|dk r|n|<|d <| d!d}<|dk r|n|<|d!<| d"d}<|dk r |n|<|d"<| d#d}<|dk r,|n|<|d#<| d$d}<|dk rN|n|<|d$<| d%d}<|dk rp|n|<|d%<| d&d}<| dk r| n|<|d&<| d'd}<|!dk r|!n|<|d'<| d(d}<|"dk r|"n|<|d(<| d)d}<|#dk r|#n|<|d)<| d*d}<|$dk r|$n|<|d*<| d+d}<|%dk r<|%n|<|d+<| d,d}<|&dk r^|&n|<|d,<| d-d}<|'dk r|'n|<|d-<| d.d}<|(dk r|(n|<|d.<| d/d}<|)dk r|)n|<|d/<| d0d}<|*dk r|*n|<|d0<| d1d}<|+dk r|+n|<|d1<| d2d}<|,dk r*|,n|<|d2<| d3d}<|-dk rL|-n|<|d3<| d4d}<|.dk rn|.n|<|d4<| d5d}<|/dk r|/n|<|d5<| d6d}<|0dk r|0n|<|d6<| d7d}<|1dk r|1n|<|d7<| d8d}<|2dk r|2n|<|d8<| d9d}<|3dk r|3n|<|d9<| d:d}<|4dk r:|4n|<|d:<| d;d}<|5dk r\|5n|<|d;<| dd}<|8dk r|8n|<|d><| d?d}<|9dk r|9n|<|d?<dd@lGmH}=d|jIdA<|=dAdddB|jdA<| dAd|jJft|f|:d|_ dS)Ca3 Construct a new Heatmap object The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a 2D list of values (ragged or not) or a 1D array of values. In the case where `z` is a 2D list, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements. If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D list, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Heatmap` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.heatmap.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.heatmap.Hoverlabel` instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.heatmap.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . transpose Transposes the z data. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xgap Sets the horizontal gap (in pixels) between bricks. xsrc Sets the source reference on plot.ly for x . xtype If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ygap Sets the vertical gap (in pixels) between bricks. ysrc Sets the source reference on plot.ly for y . ytype If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) z Sets the z data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsmooth Picks a smoothing algorithm use to smooth `z` data. zsrc Sets the source reference on plot.ly for z . Returns ------- Heatmap heatmapNzThe first argument to the plotly.graph_objs.Heatmap constructor must be a dict or an instance of :class:`plotly.graph_objs.Heatmap`rJFr)r@rrrrrr rrrrrrr?rrrrrrrr!r"r#r'rr+rr,r-r3r7r7r8r9r<r=r>rr,r?r8r@rArBrr-rCr9rrrrrrr.r)rKrD)rLrMr)KrNr>rOrPrQrRrSrTrUrVrWrXrYr@rr[rrrrr`rarcrdrerfrgHoverongapsValidatorrhrirjrkrlrmrqrrrsrtrxrr|rr}r~rr;rrrrrrrr0rr<rrrrr1rr=rr(r)rr*rr2rrrKrEr)>rrrrrrrr rrrrrrr?rrrrrrrr!r"r#r'rr+rr,r-r3r7r7r8r9r<r=r>rr,r?r8r@rArBrr-rCr9rrrrrrr.rrZ v_heatmaprrK)rQrrrO1sxN                                                                zHeatmap.__init__)9NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Brrrrrrrrrrr rrrrrrr?rrrrrrrr!r"r#r'rr+rr,r-r3r7r7r8r9r<r=r>rr,r?r8r@rArBrr-rCr9rrrrrrr.rrDrGrHrOrrr)rQrr>&s\   f .        5  #                                             xr>c+seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/eddZ0eddZ1dfdd Z2Z3S) FunnelareacCs|dS)z Sets the ratio between height and width The 'aspectratio' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float aspectratior)rrrrrCbs zFunnelarea.aspectratiocCs ||d<dS)NrCr)rrrrrrCpscCs|dS)z Sets the ratio between bottom length and maximum top length. The 'baseratio' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float baseratior)rrrrrDvs zFunnelarea.baseratiocCs ||d<dS)NrDr)rrrrrrDscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szFunnelarea.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnelarea.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the label step. See `label0` for more info. The 'dlabel' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zFunnelarea.dlabelcCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'domain' property is an instance of Domain that may be specified as: - An instance of :class:`plotly.graph_objs.funnelarea.Domain` - A dict of string/value properties that will be passed to the Domain constructor Supported dict properties: column If there is a layout grid, use the domain for this column in the grid for this funnelarea trace . row If there is a layout grid, use the domain for this row in the grid for this funnelarea trace . x Sets the horizontal domain of this funnelarea trace (in plot fraction). y Sets the vertical domain of this funnelarea trace (in plot fraction). Returns ------- plotly.graph_objs.funnelarea.Domain rr)rrrrrszFunnelarea.domaincCs ||d<dS)Nrr)rrrrrrscCs|dS)au Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszFunnelarea.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr s zFunnelarea.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.funnelarea.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.funnelarea.Hoverlabel rr)rrrrrs3zFunnelarea.hoverlabelcCs ||d<dS)Nrr)rrrrrrRscCs|dS)a` Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrXs"zFunnelarea.hovertemplatecCs ||d<dS)Nrr)rrrrrr|scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnelarea.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aK Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrszFunnelarea.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnelarea.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrszFunnelarea.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnelarea.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a| Sets the font used for `textinfo` lying inside the sector. The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.funnelarea.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.funnelarea.Insidetextfont rr)rrrrrs/zFunnelarea.insidetextfontcCs ||d<dS)Nrr)rrrrrrscCs|dS)a= Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step. The 'label0' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr%szFunnelarea.label0cCs ||d<dS)Nrr)rrrrrr5scCs|dS)a Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label. The 'labels' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr;szFunnelarea.labelscCs ||d<dS)Nrr)rrrrrrMscCs|dS)z Sets the source reference on plot.ly for labels . The 'labelssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrSs zFunnelarea.labelssrccCs ||d<dS)Nrr)rrrrrrascCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrgszFunnelarea.legendgroupcCs ||d<dS)Nrr)rrrrrrxscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.funnelarea.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: colors Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors. colorssrc Sets the source reference on plot.ly for colors . line :class:`plotly.graph_objects.funnelarea.marker. Line` instance or dict with compatible properties Returns ------- plotly.graph_objs.funnelarea.Marker rr)rrrrr~szFunnelarea.markercCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szFunnelarea.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zFunnelarea.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#szFunnelarea.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr's zFunnelarea.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)a If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group. The 'scalegroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszFunnelarea.scalegroupcCs ||d<dS)Nrr)rrrrrr scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zFunnelarea.showlegendcCs ||d<dS)Nr+r)rrrrrr+!scCs|dS)an The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.funnelarea.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.funnelarea.Stream r,r)rrrrr,'szFunnelarea.streamcCs ||d<dS)Nr,r)rrrrrr,BscCs|dS)a Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-HszFunnelarea.textcCs ||d<dS)Nr-r)rrrrrr-ZscCs|dS)aF Sets the font used for `textinfo`. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.funnelarea.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.funnelarea.Textfont r/r)rrrrr/`s/zFunnelarea.textfontcCs ||d<dS)Nr/r)rrrrrr/scCs|dS)a Determines which trace information appear on the graph. The 'textinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any r0r)rrrrr0szFunnelarea.textinfocCs ||d<dS)Nr0r)rrrrrr0scCs|dS)aj Specifies the location of the `textinfo`. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['inside', 'none'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1szFunnelarea.textpositioncCs ||d<dS)Nr1r)rrrrrr1scCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2s zFunnelarea.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zFunnelarea.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4szFunnelarea.texttemplatecCs ||d<dS)Nr4r)rrrrrr4 scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5s zFunnelarea.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5scCs|dS)a The 'title' property is an instance of Title that may be specified as: - An instance of :class:`plotly.graph_objs.funnelarea.Title` - A dict of string/value properties that will be passed to the Title constructor Supported dict properties: font Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute. position Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute. text Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated. Returns ------- plotly.graph_objs.funnelarea.Title rr)rrrrr$szFunnelarea.titlecCs ||d<dS)Nrr)rrrrrrDscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7JszFunnelarea.uidcCs ||d<dS)Nr7r)rrrrrr7ZscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8`szFunnelarea.uirevisioncCs ||d<dS)Nr8r)rrrrrr8{scCs|dS)a Sets the values of the sectors. If omitted, we count occurrences of each label. The 'values' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs zFunnelarea.valuescCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for values . The 'valuessrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnelarea.valuessrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szFunnelarea.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs |jdS)NrD)rE)rrrrrDszFunnelarea.typecCsdS)NrFr)rrrrrGszFunnelarea._parent_path_strcCsdS)Na% aspectratio Sets the ratio between height and width baseratio Sets the ratio between bottom length and maximum top length. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dlabel Sets the label step. See `label0` for more info. domain :class:`plotly.graph_objects.funnelarea.Domain` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.funnelarea.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. label0 Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step. labels Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label. labelssrc Sets the source reference on plot.ly for labels . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.funnelarea.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. scalegroup If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.funnelarea.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textposition Specifies the location of the `textinfo`. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . title :class:`plotly.graph_objects.funnelarea.Title` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values of the sectors. If omitted, we count occurrences of each label. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrHsEzFunnelarea._prop_descriptionsNc,0 stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|, dd|_ ddl m }-|-|jd<|-|jd <|-|jd <|-|jd <|-|jd <|-|jd <|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|-|jd<|- |jd<|-!|jd<|-"|jd<|-#|jd<|-$|jd<|-%|jd<|-&|jd<|-'|jd <|-(|jd!<|-)|jd"<|-*|jd#<|-+|jd$<|-,|jd%<|--|jd&<|-.|jd'<|-/|jd(<|-0|jd)<|-1|jd*<|-2|jd+<|-3|jd,<|-4|jd-<|-5|jd.<|-6|jd/<|-7|jd0<|-8|jd1<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d d}.|dk r|n|.|d <| d d}.|dk r8|n|.|d <| d d}.|dk rZ|n|.|d <| d d}.|dk r||n|.|d <| dd}.|dk r|n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r| n|.|d<| dd}.| dk r&| n|.|d<| dd}.| dk rH| n|.|d<| dd}.|dk rj|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r6|n|.|d<| dd}.|dk rX|n|.|d<| dd}.|dk rz|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| dd}.|dk r|n|.|d<| d d}.|dk r|n|.|d <| d!d}.|dk r$|n|.|d!<| d"d}.|dk rF|n|.|d"<| d#d}.|dk rh|n|.|d#<| d$d}.|dk r|n|.|d$<| d%d}.|dk r|n|.|d%<| d&d}.| dk r| n|.|d&<| d'd}.|!dk r|!n|.|d'<| d(d}.|"dk r|"n|.|d(<| d)d}.|#dk r4|#n|.|d)<| d*d}.|$dk rV|$n|.|d*<| d+d}.|%dk rx|%n|.|d+<| d,d}.|&dk r|&n|.|d,<| d-d}.|'dk r|'n|.|d-<| d.d}.|(dk r|(n|.|d.<| d/d}.|)dk r|)n|.|d/<| d0d}.|*dk r"|*n|.|d0<| d1d}.|+dk rD|+n|.|d1<dd2l9m:}/d|j;d3<|/d3ddd4|jd3<| d3d|j` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextfont Sets the font used for `textinfo` lying inside the sector. label0 Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step. labels Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label. labelssrc Sets the source reference on plot.ly for labels . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.funnelarea.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. scalegroup If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.funnelarea.Stream` instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont Sets the font used for `textinfo`. textinfo Determines which trace information appear on the graph. textposition Specifies the location of the `textinfo`. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . title :class:`plotly.graph_objects.funnelarea.Title` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. values Sets the values of the sectors. If omitted, we count occurrences of each label. valuessrc Sets the source reference on plot.ly for values . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Funnelarea funnelareaNzThe first argument to the plotly.graph_objs.Funnelarea constructor must be a dict or an instance of :class:`plotly.graph_objs.Funnelarea`rJFr)rErCrDr rrrrrrrrrrrrrrrrrrr!r"r#r'rr+r,r-r/r0r1r2r3r4r5rr7r8rrr9)rKrD)rLrMr)=rNrBrOrPrQrRrSrTrUrVrWrXrYrEZAspectratioValidatorr[ZBaseratioValidatorr`rarrrerfrgrhrirjrkrlrmrprrrrqrrrrsrtrxrr|r}r~rrrrrrrrrrrr rrrKrEr)0rrrCrDr rrrrrrrrrrrrrrrrrrr!r"r#r'rr+r,r-r/r0r1r2r3r4r5rr7r8rrr9rZ v_funnelarearrK)rQrrrOs$                                                  zFunnelarea.__init__)+NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)4rrrrrCrrDr rrrrrrrrrrrrrrrrrrr!r"r#r'rr+r,r-r/r0r1r2r3r4r5rr7r8rrr9rDrGrHrOrrr)rQrrB^s         5 $      1              1               IrBc6seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:eddZ;eddZS)FunnelcCs|dS)a Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. The 'alignmentgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrQszFunnel.alignmentgroupcCs ||d<dS)Nrr)rrrrrrbscCs|dS)a} Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. The 'cliponaxis' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr hszFunnel.cliponaxiscCs ||d<dS)Nr r)rrrrrr yscCs|dS)a  The 'connector' property is an instance of Connector that may be specified as: - An instance of :class:`plotly.graph_objs.funnel.Connector` - A dict of string/value properties that will be passed to the Connector constructor Supported dict properties: fillcolor Sets the fill color. line :class:`plotly.graph_objects.funnel.connector.L ine` instance or dict with compatible properties visible Determines if connector regions and lines are drawn. Returns ------- plotly.graph_objs.funnel.Connector r r)rrrrr szFunnel.connectorcCs ||d<dS)Nr r)rrrrrr scCs|dS)a_ Constrain the size of text inside or outside a bar to be no larger than the bar itself. The 'constraintext' property is an enumeration that may be specified as: - One of the following enumeration values: ['inside', 'outside', 'both', 'none'] Returns ------- Any r r)rrrrr szFunnel.constraintextcCs ||d<dS)Nr r)rrrrrr scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szFunnel.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnel.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs z Funnel.dxcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs z Funnel.dycCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['name', 'x', 'y', 'text', 'percent initial', 'percent previous', 'percent total'] joined with '+' characters (e.g. 'name+x') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr szFunnel.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr#s zFunnel.hoverinfosrccCs ||d<dS)Nrr)rrrrrr1scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.funnel.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.funnel.Hoverlabel rr)rrrrr7s3zFunnel.hoverlabelcCs ||d<dS)Nrr)rrrrrrlscCs|dS)ag Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious` and `percentTotal`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrrs"zFunnel.hovertemplatecCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnel.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ab Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrszFunnel.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zFunnel.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrsz Funnel.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs z Funnel.idssrccCs ||d<dS)Nrr)rrrrrr scCs|dS)a[ Determines if texts are kept at center or start/end points in `textposition` "inside" mode. The 'insidetextanchor' property is an enumeration that may be specified as: - One of the following enumeration values: ['end', 'middle', 'start'] Returns ------- Any rr)rrrrr szFunnel.insidetextanchorcCs ||d<dS)Nrr)rrrrrr scCs|dS)am Sets the font used for `text` lying inside the bar. The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.funnel.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.funnel.Insidetextfont rr)rrrrr s/zFunnel.insidetextfontcCs ||d<dS)Nrr)rrrrrrO scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrU szFunnel.legendgroupcCs ||d<dS)Nrr)rrrrrrf scCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.funnel.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.funnel.marker.Colo rBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . line :class:`plotly.graph_objects.funnel.marker.Line ` instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. Returns ------- plotly.graph_objs.funnel.Marker rr)rrrrrl soz Funnel.markercCs ||d<dS)Nrr)rrrrrr scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr! sz Funnel.metacCs ||d<dS)Nr!r)rrrrrr! scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr" s zFunnel.metasrccCs ||d<dS)Nr"r)rrrrrr" scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr# sz Funnel.namecCs ||d<dS)Nr#r)rrrrrr## scCs|dS)a` Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. The 'offset' property is a number and may be specified as: - An int or float Returns ------- int|float r$r)rrrrr$) sz Funnel.offsetcCs ||d<dS)Nr$r)rrrrrr$9 scCs|dS)a Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. The 'offsetgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r%r)rrrrr%? szFunnel.offsetgroupcCs ||d<dS)Nr%r)rrrrrr%P scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'V s zFunnel.opacitycCs ||d<dS)Nr'r)rrrrrr'd scCs|dS)ah Sets the orientation of the funnels. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only "y" array is presented or orientation is set to "v". Also regarding graphs including only 'horizontal' funnels, "autorange" on the "y-axis" are set to "reversed". The 'orientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['v', 'h'] Returns ------- Any r(r)rrrrr(j szFunnel.orientationcCs ||d<dS)Nr(r)rrrrrr(~ scCs|dS)as Sets the font used for `text` lying outside the bar. The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - An instance of :class:`plotly.graph_objs.funnel.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.funnel.Outsidetextfont r)r)rrrrr) s/zFunnel.outsidetextfontcCs ||d<dS)Nr)r)rrrrrr) scCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr* szFunnel.selectedpointscCs ||d<dS)Nr*r)rrrrrr* scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+ s zFunnel.showlegendcCs ||d<dS)Nr+r)rrrrrr+ scCs|dS)af The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.funnel.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.funnel.Stream r,r)rrrrr, sz Funnel.streamcCs ||d<dS)Nr,r)rrrrrr, scCs|dS)a Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr- sz Funnel.textcCs ||d<dS)Nr-r)rrrrrr- scCs|dS)a* Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. The 'textangle' property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90). Returns ------- int|float r.r)rrrrr.$ szFunnel.textanglecCs ||d<dS)Nr.r)rrrrrr.7 scCs|dS)a: Sets the font used for `text`. The 'textfont' property is an instance of Textfont that may be specified as: - An instance of :class:`plotly.graph_objs.funnel.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor Supported dict properties: color colorsrc Sets the source reference on plot.ly for color . family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". familysrc Sets the source reference on plot.ly for family . size sizesrc Sets the source reference on plot.ly for size . Returns ------- plotly.graph_objs.funnel.Textfont r/r)rrrrr/= s/zFunnel.textfontcCs ||d<dS)Nr/r)rrrrrr/n scCs|dS)a2 Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace). The 'textinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['label', 'text', 'percent initial', 'percent previous', 'percent total', 'value'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') Returns ------- Any r0r)rrrrr0t szFunnel.textinfocCs ||d<dS)Nr0r)rrrrrr0 scCs|dS)a' Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. The 'textposition' property is an enumeration that may be specified as: - One of the following enumeration values: ['inside', 'outside', 'auto', 'none'] - A tuple, list, or one-dimensional numpy array of the above Returns ------- Any|numpy.ndarray r1r)rrrrr1 szFunnel.textpositioncCs ||d<dS)Nr1r)rrrrrr1 scCs|dS)z Sets the source reference on plot.ly for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r2r)rrrrr2 s zFunnel.textpositionsrccCs ||d<dS)Nr2r)rrrrrr2 scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3 s zFunnel.textsrccCs ||d<dS)Nr3r)rrrrrr3 scCs|dS)a Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`. The 'texttemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r4r)rrrrr4 szFunnel.texttemplatecCs ||d<dS)Nr4r)rrrrrr4 scCs|dS)z Sets the source reference on plot.ly for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r5r)rrrrr5 s zFunnel.texttemplatesrccCs ||d<dS)Nr5r)rrrrrr5 scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7 sz Funnel.uidcCs ||d<dS)Nr7r)rrrrrr7 scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8 szFunnel.uirevisioncCs ||d<dS)Nr8r)rrrrrr8: scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9@ szFunnel.visiblecCs ||d<dS)Nr9r)rrrrrr9Q scCs|dS)z Sets the bar width (in position axis units). The 'width' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float r:r)rrrrr:W s z Funnel.widthcCs ||d<dS)Nr:r)rrrrrr:e scCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<k s zFunnel.xcCs ||d<dS)Nr<r)rrrrrr<y scCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr= s z Funnel.x0cCs ||d<dS)Nr=r)rrrrrr= scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr> sz Funnel.xaxiscCs ||d<dS)Nr>r)rrrrrr> scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr? s z Funnel.xsrccCs ||d<dS)Nr?r)rrrrrr? scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@ s zFunnel.ycCs ||d<dS)Nr@r)rrrrrr@ scCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrA s z Funnel.y0cCs ||d<dS)NrAr)rrrrrrA scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrB sz Funnel.yaxiscCs ||d<dS)NrBr)rrrrrrB scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC s z Funnel.ysrccCs ||d<dS)NrCr)rrrrrrC scCs |jdS)NrD)rE)rrrrrD sz Funnel.typecCsdS)NrFr)rrrrrG szFunnel._parent_path_strcCsdS)Na!2 alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. cliponaxis Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector :class:`plotly.graph_objects.funnel.Connector` instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.funnel.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious` and `percentTotal`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. insidetextfont Sets the font used for `text` lying inside the bar. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.funnel.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the funnels. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only "y" array is presented or orientation is set to "v". Also regarding graphs including only 'horizontal' funnels, "autorange" on the "y-axis" are set to "reversed". outsidetextfont Sets the font used for `text` lying outside the bar. selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.funnel.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textangle Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. textfont Sets the font used for `text`. textinfo Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace). textposition Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar width (in position axis units). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . r)rrrrrH# szFunnel._prop_descriptionsNc7; s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|7 dd|_ ddl m }8|8|jd<|8|jd <|8|jd <|8|jd <|8|jd <|8|jd <|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8|jd<|8 |jd<|8!|jd<|8"|jd<|8#|jd<|8$|jd<|8%|jd<|8&|jd<|8'|jd <|8(|jd!<|8)|jd"<|8*|jd#<|8+|jd$<|8,|jd%<|8-|jd&<|8.|jd'<|8/|jd(<|80|jd)<|81|jd*<|82|jd+<|83|jd,<|84|jd-<|85|jd.<|86|jd/<|87|jd0<|88|jd1<|89|jd2<|8:|jd3<|8;|jd4<|8<|jd5<|8=|jd6<|8>|jd7<|8?|jd8<|8@|jd9<|8A|jd:<|8B|jd;<|8C|jd<<| dd}9|dk rl|n|9|d<| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| d d}9|dk r|n|9|d <| dd}9|dk r8|n|9|d<| dd}9| dk rZ| n|9|d<| dd}9| dk r|| n|9|d<| dd}9| dk r| n|9|d<| dd}9| dk r| n|9|d<| dd}9| dk r| n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r&|n|9|d<| dd}9|dk rH|n|9|d<| dd}9|dk rj|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r|n|9|d<| dd}9|dk r6|n|9|d<| dd}9|dk rX|n|9|d<| dd}9|dk rz|n|9|d<| d d}9|dk r|n|9|d <| d!d}9|dk r|n|9|d!<| d"d}9|dk r|n|9|d"<| d#d}9|dk r|n|9|d#<| d$d}9|dk r$|n|9|d$<| d%d}9|dk rF|n|9|d%<| d&d}9| dk rh| n|9|d&<| d'd}9|!dk r|!n|9|d'<| d(d}9|"dk r|"n|9|d(<| d)d}9|#dk r|#n|9|d)<| d*d}9|$dk r|$n|9|d*<| d+d}9|%dk r|%n|9|d+<| d,d}9|&dk r4|&n|9|d,<| d-d}9|'dk rV|'n|9|d-<| d.d}9|(dk rx|(n|9|d.<| d/d}9|)dk r|)n|9|d/<| d0d}9|*dk r|*n|9|d0<| d1d}9|+dk r|+n|9|d1<| d2d}9|,dk r|,n|9|d2<| d3d}9|-dk r"|-n|9|d3<| d4d}9|.dk rD|.n|9|d4<| d5d}9|/dk rf|/n|9|d5<| d6d}9|0dk r|0n|9|d6<| d7d}9|1dk r|1n|9|d7<| d8d}9|2dk r|2n|9|d8<| d9d}9|3dk r|3n|9|d9<| d:d}9|4dk r|4n|9|d:<| d;d}9|5dk r2|5n|9|d;<| d<|:d>ddd?|jd><| d>d|jGft|f|7d|_ dS)@a4 Construct a new Funnel object Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a "drop-off" representation wherein each item appears in each stage it traversed. See also the "funnelarea" trace type for a different approach to visualizing funnel data. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Funnel` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. cliponaxis Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector :class:`plotly.graph_objects.funnel.Connector` instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.funnel.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious` and `percentTotal`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. insidetextfont Sets the font used for `text` lying inside the bar. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.funnel.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the funnels. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only "y" array is presented or orientation is set to "v". Also regarding graphs including only 'horizontal' funnels, "autorange" on the "y-axis" are set to "reversed". outsidetextfont Sets the font used for `text` lying outside the bar. selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.funnel.Stream` instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textangle Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. textfont Sets the font used for `text`. textinfo Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace). textposition Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar width (in position axis units). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . Returns ------- Funnel funnelNzThe first argument to the plotly.graph_objs.Funnel constructor must be a dict or an instance of :class:`plotly.graph_objs.Funnel`rJFr)rGrr r r r rrrrrrrrrrrrrrrrr!r"r#r$r%r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r7r8r9r:r<r=r>r?r@rArBrC)rKrD)rLrMr)HrNrFrOrPrQrRrSrTrUrVrWrXrYrGrZr[r]r^r_r`rarcrdrerfrgrhrirjrkrlrmrorprqrrrrsrtrurvrxryrzr{r|r}r~rrrrrrrrrrrrrrrrrrrrrrKrEr);rrrr r r r rrrrrrrrrrrrrrrrr!r"r#r$r%r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r7r8r9r:r<r=r>r?r@rArBrCrZv_funnelrrK)rQrrrO&sfN                                                             zFunnel.__init__)6NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)?rrrrrrr r r r rrrrrrrrrrrrrrrrr!r"r#r$r%r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r7r8r9r:r<r=r>r?r@rArBrCrDrGrHrOrrr)rQrrFMsJ           5 $       1  q        1      1                     rFc,seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0eddZ1eddZ2dfdd Z3Z4S) DensitymapboxcCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrPszDensitymapbox.autocolorscalecCs ||d<dS)Nrr)rrrrrrcscCs|dS)a Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer. The 'below' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rmr)rrrrrmiszDensitymapbox.belowcCs ||d<dS)Nrmr)rrrrrrm{scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrszDensitymapbox.coloraxiscCs ||d<dS)Nrr)rrrrrrscCs|dS)a,- The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.densitymapbox.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.density mapbox.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.densitymapbox.colorbar.tickformatstopdefaults ), sets the default property values to use for elements of densitymapbox.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.densitymapbox.colo rbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use densitymapbox.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use densitymapbox.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.densitymapbox.ColorBar rr)rrrrrsezDensitymapbox.colorbarcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrrs,zDensitymapbox.colorscalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr szDensitymapbox.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zDensitymapbox.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ah Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters (e.g. 'lon+lat') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrszDensitymapbox.hoverinfocCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zDensitymapbox.hoverinfosrccCs ||d<dS)Nrr)rrrrrrscCs|dS)a  The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.densitymapbox.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.densitymapbox.Hoverlabel rr)rrrrrs3zDensitymapbox.hoverlabelcCs ||d<dS)Nrr)rrrrrrJscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrPs!zDensitymapbox.hovertemplatecCs ||d<dS)Nrr)rrrrrrsscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrys zDensitymapbox.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrscCs|dS)ai Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrszDensitymapbox.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zDensitymapbox.hovertextsrccCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrszDensitymapbox.idscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zDensitymapbox.idssrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the latitude coordinates (in degrees North). The 'lat' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rnr)rrrrrns zDensitymapbox.latcCs ||d<dS)Nrnr)rrrrrrnscCs|dS)z Sets the source reference on plot.ly for lat . The 'latsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str ror)rrrrros zDensitymapbox.latsrccCs ||d<dS)Nror)rrrrrroscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr szDensitymapbox.legendgroupcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the longitude coordinates (in degrees East). The 'lon' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rpr)rrrrrp$s zDensitymapbox.loncCs ||d<dS)Nrpr)rrrrrrp2scCs|dS)z Sets the source reference on plot.ly for lon . The 'lonsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rqr)rrrrrq8s zDensitymapbox.lonsrccCs ||d<dS)Nrqr)rrrrrrqFscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!LszDensitymapbox.metacCs ||d<dS)Nr!r)rrrrrr!bscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"hs zDensitymapbox.metasrccCs ||d<dS)Nr"r)rrrrrr"vscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#|szDensitymapbox.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr's zDensitymapbox.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)a Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed. The 'radius' property is a number and may be specified as: - An int or float in the interval [1, inf] - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray radiusr)rrrrrIszDensitymapbox.radiuscCs ||d<dS)NrIr)rrrrrrIscCs|dS)z Sets the source reference on plot.ly for radius . The 'radiussrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str radiussrcr)rrrrrJs zDensitymapbox.radiussrccCs ||d<dS)NrJr)rrrrrrJscCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszDensitymapbox.reversescalecCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+s zDensitymapbox.showlegendcCs ||d<dS)Nr+r)rrrrrr+scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrs zDensitymapbox.showscalecCs ||d<dS)Nrr)rrrrrr scCs|dS)at The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.densitymapbox.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.densitymapbox.Stream r,r)rrrrr,szDensitymapbox.streamcCs ||d<dS)Nr,r)rrrrrr,,scCs|dS)a' Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. The 'subplot' property is an identifier of a particular subplot, of type 'mapbox', that may be specified as the string 'mapbox' optionally followed by an integer >= 1 (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) Returns ------- str rLr)rrrrrL2szDensitymapbox.subplotcCs ||d<dS)NrLr)rrrrrrLEscCs|dS)a Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-KszDensitymapbox.textcCs ||d<dS)Nr-r)rrrrrr-`scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3fs zDensitymapbox.textsrccCs ||d<dS)Nr3r)rrrrrr3tscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7zszDensitymapbox.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szDensitymapbox.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szDensitymapbox.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs|dS)aA Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs zDensitymapbox.zcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszDensitymapbox.zautocCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zDensitymapbox.zmaxcCs ||d<dS)Nrr)rrrrrrscCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr szDensitymapbox.zmidcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zDensitymapbox.zmincCs ||d<dS)Nrr)rrrrrr.scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr4s zDensitymapbox.zsrccCs ||d<dS)Nrr)rrrrrrBscCs |jdS)NrD)rE)rrrrrDHszDensitymapbox.typecCsdS)NrFr)rrrrrGNszDensitymapbox._parent_path_strcCsdS)Na* autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. below Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.densitymapbox.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.densitymapbox.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . lat Sets the latitude coordinates (in degrees North). latsrc Sets the source reference on plot.ly for lat . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. radius Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed. radiussrc Sets the source reference on plot.ly for radius . reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.densitymapbox.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. text Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). z Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . r)rrrrrHTsVz Densitymapbox._prop_descriptionsNc-1 stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|- dd|_ ddl m }.|.|jd<|.|jd <|.|jd <|.|jd <|.|jd <|.|jd <|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|. |jd<|.!|jd<|."|jd<|.#|jd<|.$|jd<|.%|jd<|.&|jd<|.'|jd <|.(|jd!<|.)|jd"<|.*|jd#<|.+|jd$<|.,|jd%<|.-|jd&<|..|jd'<|./|jd(<|.0|jd)<|.1|jd*<|.2|jd+<|.3|jd,<|.4|jd-<|.5|jd.<|.6|jd/<|.7|jd0<|.8|jd1<|.9|jd2<| dd}/|dk r|n|/|d<| d d}/|dk r|n|/|d <| d d}/|dk r$|n|/|d <| d d}/|dk rF|n|/|d <| d d}/|dk rh|n|/|d <| d d}/|dk r|n|/|d <| dd}/|dk r|n|/|d<| dd}/| dk r| n|/|d<| dd}/| dk r| n|/|d<| dd}/| dk r| n|/|d<| dd}/| dk r4| n|/|d<| dd}/| dk rV| n|/|d<| dd}/|dk rx|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r"|n|/|d<| dd}/|dk rD|n|/|d<| dd}/|dk rf|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| d d}/|dk r|n|/|d <| d!d}/|dk r2|n|/|d!<| d"d}/|dk rT|n|/|d"<| d#d}/|dk rv|n|/|d#<| d$d}/|dk r|n|/|d$<| d%d}/|dk r|n|/|d%<| d&d}/| dk r| n|/|d&<| d'd}/|!dk r|!n|/|d'<| d(d}/|"dk r |"n|/|d(<| d)d}/|#dk rB|#n|/|d)<| d*d}/|$dk rd|$n|/|d*<| d+d}/|%dk r|%n|/|d+<| d,d}/|&dk r|&n|/|d,<| d-d}/|'dk r|'n|/|d-<| d.d}/|(dk r|(n|/|d.<| d/d}/|)dk r|)n|/|d/<| d0d}/|*dk r0|*n|/|d0<| d1d}/|+dk rR|+n|/|d1<| d2d}/|,dk rt|,n|/|d2<dd3l:m;}0d|j` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . lat Sets the latitude coordinates (in degrees North). latsrc Sets the source reference on plot.ly for lat . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. radius Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed. radiussrc Sets the source reference on plot.ly for radius . reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.densitymapbox.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. text Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). z Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . Returns ------- Densitymapbox densitymapboxNzThe first argument to the plotly.graph_objs.Densitymapbox constructor must be a dict or an instance of :class:`plotly.graph_objs.Densitymapbox`rJFr)rKrrmrrrr rrrrrrrrrrrnrorrprqr!r"r#r'rIrJrr+rr,rLr-r3r7r8r9rrrrrr)rKrD)rLrMr)>rNrHrOrPrQrRrSrTrUrVrWrXrYrKrr[rsrrrr`rarerfrgrhrirjrkrlrmrtrurqrvrwrrrsrtrxZRadiusValidatorZRadiussrcValidatorrr|rr}rUr~rrrrrr(rr*rrrrKrEr)1rrrrmrrrr rrrrrrrrrrrnrorrprqr!r"r#r'rIrJrr+rr,rLr-r3r7r8r9rrrrrrrZv_densitymapboxrrK)rQrrrO+s*                                                   zDensitymapbox.__init__),NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)5rrrrrrrmrrrr rrrrrrrrrrrnrorrprqr!r"r#r'rIrJrr+rr,rLr-r3r7r8r9rrrrrrrDrGrHrOrrr)rQrrHLs    g .     5 #                                   ZrHc2s<eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6eddZ7eddZ8dfdd Z9Z:S) ContourcarpetcCs|dS)z Sets the x coordinates. The 'a' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rDr)rrrrrDs zContourcarpet.acCs ||d<dS)NrDr)rrrrrrD scCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'a0' property accepts values of any type Returns ------- Any a0r)rrrrrMs zContourcarpet.a0cCs ||d<dS)NrMr)rrrrrrM!scCs|dS)z Sets the source reference on plot.ly for a . The 'asrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rEr)rrrrrE's zContourcarpet.asrccCs ||d<dS)NrEr)rrrrrrE5scCs|dS)a If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). The 'atype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any atyper)rrrrrN;szContourcarpet.atypecCs ||d<dS)NrNr)rrrrrrNMscCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrSszContourcarpet.autocolorscalecCs ||d<dS)Nrr)rrrrrrfscCs|dS)a Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. The 'autocontour' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr lszContourcarpet.autocontourcCs ||d<dS)Nr r)rrrrrr }scCs|dS)z Sets the y coordinates. The 'b' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rFr)rrrrrFs zContourcarpet.bcCs ||d<dS)NrFr)rrrrrrFscCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'b0' property accepts values of any type Returns ------- Any b0r)rrrrrOs zContourcarpet.b0cCs ||d<dS)NrOr)rrrrrrOscCs|dS)z Sets the source reference on plot.ly for b . The 'bsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rGr)rrrrrGs zContourcarpet.bsrccCs ||d<dS)NrGr)rrrrrrGscCs|dS)a If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) The 'btype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any btyper)rrrrrPszContourcarpet.btypecCs ||d<dS)NrPr)rrrrrrPscCs|dS)a The `carpet` of the carpet axes on which this contour trace lies The 'carpet' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrszContourcarpet.carpetcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrszContourcarpet.coloraxiscCs ||d<dS)Nrr)rrrrrrscCs|dS)a,- The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.contourcarpet.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.contour carpet.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.contourcarpet.colorbar.tickformatstopdefaults ), sets the default property values to use for elements of contourcarpet.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.contourcarpet.colo rbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use contourcarpet.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use contourcarpet.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.contourcarpet.ColorBar rr)rrrrr sezContourcarpet.colorbarcCs ||d<dS)Nrr)rrrrrrscCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrrs,zContourcarpet.colorscalecCs ||d<dS)Nrr)rrrrrr#scCs|dS)aO The 'contours' property is an instance of Contours that may be specified as: - An instance of :class:`plotly.graph_objs.contourcarpet.Contours` - A dict of string/value properties that will be passed to the Contours constructor Supported dict properties: coloring Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace. end Sets the end contour level value. Must be more than `contours.start` labelfont Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`. labelformat Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format operation Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms. showlabels Determines whether to label the contour lines with their values. showlines Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill". size Sets the step between each contour level. Must be positive. start Sets the starting contour level value. Must be less than `contours.end` type If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters. value Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound. Returns ------- plotly.graph_objs.contourcarpet.Contours rr)rrrrr)sMzContourcarpet.contourscCs ||d<dS)Nrr)rrrrrrxscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr ~szContourcarpet.customdatacCs ||d<dS)Nr r)rrrrrr scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zContourcarpet.customdatasrccCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'da' property is a number and may be specified as: - An int or float Returns ------- int|float dar)rrrrrQs zContourcarpet.dacCs ||d<dS)NrQr)rrrrrrQscCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'db' property is a number and may be specified as: - An int or float Returns ------- int|float dbr)rrrrrRs zContourcarpet.dbcCs ||d<dS)NrRr)rrrrrrRscCs|dS)a! Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen - A number that will be interpreted as a color according to contourcarpet.colorscale Returns ------- str rr)rrrrrs7zContourcarpet.fillcolorcCs ||d<dS)Nrr)rrrrrr scCs|dS)z Same as `text`. The 'hovertext' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrs zContourcarpet.hovertextcCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr$s zContourcarpet.hovertextsrccCs ||d<dS)Nrr)rrrrrr2scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr8szContourcarpet.idscCs ||d<dS)Nrr)rrrrrrHscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrNs zContourcarpet.idssrccCs ||d<dS)Nrr)rrrrrr\scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrbszContourcarpet.legendgroupcCs ||d<dS)Nrr)rrrrrrsscCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.contourcarpet.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines". dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). smoothing Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing. width Sets the contour line width in (in px) Defaults to 0.5 when `contours.type` is "levels". Defaults to 2 when `contour.type` is "constraint". Returns ------- plotly.graph_objs.contourcarpet.Line rr)rrrrrys!zContourcarpet.linecCs ||d<dS)Nrr)rrrrrrscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!szContourcarpet.metacCs ||d<dS)Nr!r)rrrrrr!scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"s zContourcarpet.metasrccCs ||d<dS)Nr"r)rrrrrr"scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#szContourcarpet.namecCs ||d<dS)Nr#r)rrrrrr#scCs|dS)a Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. The 'ncontours' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns ------- int rr)rrrrrszContourcarpet.ncontourscCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr's zContourcarpet.opacitycCs ||d<dS)Nr'r)rrrrrr'scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrszContourcarpet.reversescalecCs ||d<dS)Nrr)rrrrrr$scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+*s zContourcarpet.showlegendcCs ||d<dS)Nr+r)rrrrrr+9scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr?s zContourcarpet.showscalecCs ||d<dS)Nrr)rrrrrrNscCs|dS)at The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.contourcarpet.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.contourcarpet.Stream r,r)rrrrr,TszContourcarpet.streamcCs ||d<dS)Nr,r)rrrrrr,oscCs|dS)z Sets the text elements associated with each z value. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-us zContourcarpet.textcCs ||d<dS)Nr-r)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3s zContourcarpet.textsrccCs ||d<dS)Nr3r)rrrrrr3scCs|dS)z Transposes the z data. The 'transpose' property must be specified as a bool (either True, or False) Returns ------- bool r7r)rrrrr7s zContourcarpet.transposecCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7szContourcarpet.uidcCs ||d<dS)Nr7r)rrrrrr7scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8szContourcarpet.uirevisioncCs ||d<dS)Nr8r)rrrrrr8scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9szContourcarpet.visiblecCs ||d<dS)Nr9r)rrrrrr9scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>szContourcarpet.xaxiscCs ||d<dS)Nr>r)rrrrrr>scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBszContourcarpet.yaxiscCs ||d<dS)NrBr)rrrrrrB+scCs|dS)z Sets the z data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr1s zContourcarpet.zcCs ||d<dS)Nrr)rrrrrr?scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrEszContourcarpet.zautocCs ||d<dS)Nrr)rrrrrrVscCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr\s zContourcarpet.zmaxcCs ||d<dS)Nrr)rrrrrrkscCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrqszContourcarpet.zmidcCs ||d<dS)Nrr)rrrrrrscCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrs zContourcarpet.zmincCs ||d<dS)Nrr)rrrrrrscCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrs zContourcarpet.zsrccCs ||d<dS)Nrr)rrrrrrscCs |jdS)NrD)rE)rrrrrDszContourcarpet.typecCsdS)NrFr)rrrrrGszContourcarpet._parent_path_strcCsdS)Na& a Sets the x coordinates. a0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. asrc Sets the source reference on plot.ly for a . atype If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. autocontour Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. b Sets the y coordinates. b0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. bsrc Sets the source reference on plot.ly for b . btype If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) carpet The `carpet` of the carpet axes on which this contour trace lies coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.contourcarpet.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours :class:`plotly.graph_objects.contourcarpet.Contours` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . da Sets the x coordinate step. See `x0` for more info. db Sets the y coordinate step. See `y0` for more info. fillcolor Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.contourcarpet.Line` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. ncontours Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.contourcarpet.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . transpose Transposes the z data. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. z Sets the z data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . r)rrrrrHsQz Contourcarpet._prop_descriptionsNc37 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|3 dd|_ ddl m }4|4|jd<|4|jd <|4|jd <|4|jd <|4|jd <|4|jd <|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4|jd<|4 |jd<|4!|jd<|4"|jd<|4#|jd<|4$|jd<|4%|jd<|4&|jd<|4'|jd <|4(|jd!<|4)|jd"<|4*|jd#<|4+|jd$<|4,|jd%<|4-|jd&<|4.|jd'<|4/|jd(<|40|jd)<|41|jd*<|42|jd+<|43|jd,<|44|jd-<|45|jd.<|46|jd/<|47|jd0<|48|jd1<|49|jd2<|4:|jd3<|4;|jd4<|4<|jd5<|4=|jd6<|4>|jd7<|4?|jd8<| dd}5|dk r4|n|5|d<| d d}5|dk rV|n|5|d <| d d}5|dk rx|n|5|d <| d d}5|dk r|n|5|d <| d d}5|dk r|n|5|d <| d d}5|dk r|n|5|d <| dd}5|dk r|n|5|d<| dd}5| dk r"| n|5|d<| dd}5| dk rD| n|5|d<| dd}5| dk rf| n|5|d<| dd}5| dk r| n|5|d<| dd}5| dk r| n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r2|n|5|d<| dd}5|dk rT|n|5|d<| dd}5|dk rv|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r|n|5|d<| dd}5|dk r |n|5|d<| dd}5|dk rB|n|5|d<| d d}5|dk rd|n|5|d <| d!d}5|dk r|n|5|d!<| d"d}5|dk r|n|5|d"<| d#d}5|dk r|n|5|d#<| d$d}5|dk r|n|5|d$<| d%d}5|dk r|n|5|d%<| d&d}5| dk r0| n|5|d&<| d'd}5|!dk rR|!n|5|d'<| d(d}5|"dk rt|"n|5|d(<| d)d}5|#dk r|#n|5|d)<| d*d}5|$dk r|$n|5|d*<| d+d}5|%dk r|%n|5|d+<| d,d}5|&dk r|&n|5|d,<| d-d}5|'dk r|'n|5|d-<| d.d}5|(dk r@|(n|5|d.<| d/d}5|)dk rb|)n|5|d/<| d0d}5|*dk r|*n|5|d0<| d1d}5|+dk r|+n|5|d1<| d2d}5|,dk r|,n|5|d2<| d3d}5|-dk r|-n|5|d3<| d4d}5|.dk r |.n|5|d4<| d5d}5|/dk r.|/n|5|d5<| d6d}5|0dk rP|0n|5|d6<| d7d}5|1dk rr|1n|5|d7<| d8d}5|2dk r|2n|5|d8<dd9l@mA}6d|jBd:<|6d:ddd;|jd:<| d:d|jCft|f|3d|_ dS)rBrrrrrr)rKrD)rLrMr)DrNrLrOrPrQrRrSrTrUrVrWrXrYrSrOr[ A0ValidatorrPZAtypeValidatorrrrQ B0ValidatorrRZBtypeValidatorrrrrrr`ra DaValidator DbValidatorrrjrkrlrmrqrrrrsrtr#rxrr|rr}r~rr;rrrrrrr(rr*rrrrKrEr)7rrrDrMrErNrr rFrOrGrPrrrrrr rrQrRrrrrrrrr!r"r#rr'rr+rr,r-r3r7r7r8r9r>rBrrrrrrrZv_contourcarpetrrK)rQrrrOsN                                                         zContourcarpet.__init__)2NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN);rrrrrDrrMrErNrr rFrOrGrPrrrrrr rrQrRrrrrrrrr!r"r#rr'rr+rr,r-r3r7r7r8r9r>rBrrrrrrrDrGrHrOrrr)rQrrLs2             g . O     9      #                          UrLc;s&eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZe>jddZ>eddZ?eddZ@eddZAdfdd ZBZCS)ContourcCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrp szContour.autocolorscalecCs ||d<dS)Nrr)rrrrrr scCs|dS)a Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. The 'autocontour' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr  szContour.autocontourcCs ||d<dS)Nr r)rrrrrr  scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrr szContour.coloraxiscCs ||d<dS)Nrr)rrrrrr scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.contour.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.contour .colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.contour.colorbar.tickformatstopdefaults), sets the default property values to use for elements of contour.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.contour.colorbar.T itle` instance or dict with compatible properties titlefont Deprecated: Please use contour.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use contour.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.contour.ColorBar rr)rrrrr sdzContour.colorbarcCs ||d<dS)Nrr)rrrrrr!scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrr!s,zContour.colorscalecCs ||d<dS)Nrr)rrrrrr!scCs|dS)an Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false. The 'connectgaps' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr!szContour.connectgapscCs ||d<dS)Nrr)rrrrrr!scCs|dS)a The 'contours' property is an instance of Contours that may be specified as: - An instance of :class:`plotly.graph_objs.contour.Contours` - A dict of string/value properties that will be passed to the Contours constructor Supported dict properties: coloring Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace. end Sets the end contour level value. Must be more than `contours.start` labelfont Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`. labelformat Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format operation Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms. showlabels Determines whether to label the contour lines with their values. showlines Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill". size Sets the step between each contour level. Must be positive. start Sets the starting contour level value. Must be less than `contours.end` type If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters. value Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound. Returns ------- plotly.graph_objs.contour.Contours rr)rrrrr!sOzContour.contourscCs ||d<dS)Nrr)rrrrrrA"scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr G"szContour.customdatacCs ||d<dS)Nr r)rrrrrr X"scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr^"s zContour.customdatasrccCs ||d<dS)Nrr)rrrrrrl"scCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrr"s z Contour.dxcCs ||d<dS)Nrr)rrrrrr"scCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr"s z Contour.dycCs ||d<dS)Nrr)rrrrrr"scCs|dS)a Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen - A number that will be interpreted as a color according to contour.colorscale Returns ------- str rr)rrrrr"s7zContour.fillcolorcCs ||d<dS)Nrr)rrrrrr"scCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr"szContour.hoverinfocCs ||d<dS)Nrr)rrrrrr"scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr"s zContour.hoverinfosrccCs ||d<dS)Nrr)rrrrrr#scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.contour.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.contour.Hoverlabel rr)rrrrr#s3zContour.hoverlabelcCs ||d<dS)Nrr)rrrrrr<#scCs|dS)a! Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. The 'hoverongaps' property must be specified as a bool (either True, or False) Returns ------- bool r?r)rrrrr?B#s zContour.hoverongapscCs ||d<dS)Nr?r)rrrrrr?Q#scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrW#s!zContour.hovertemplatecCs ||d<dS)Nrr)rrrrrrz#scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr#s zContour.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr#scCs|dS)z Same as `text`. The 'hovertext' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr#s zContour.hovertextcCs ||d<dS)Nrr)rrrrrr#scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr#s zContour.hovertextsrccCs ||d<dS)Nrr)rrrrrr#scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr#sz Contour.idscCs ||d<dS)Nrr)rrrrrr#scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr#s zContour.idssrccCs ||d<dS)Nrr)rrrrrr#scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr#szContour.legendgroupcCs ||d<dS)Nrr)rrrrrr#scCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.contour.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines". dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). smoothing Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing. width Sets the contour line width in (in px) Defaults to 0.5 when `contours.type` is "levels". Defaults to 2 when `contour.type` is "constraint". Returns ------- plotly.graph_objs.contour.Line rr)rrrrr#s!z Contour.linecCs ||d<dS)Nrr)rrrrrr $scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!&$sz Contour.metacCs ||d<dS)Nr!r)rrrrrr!<$scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"B$s zContour.metasrccCs ||d<dS)Nr"r)rrrrrr"P$scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#V$sz Contour.namecCs ||d<dS)Nr#r)rrrrrr#f$scCs|dS)a Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. The 'ncontours' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns ------- int rr)rrrrrl$szContour.ncontourscCs ||d<dS)Nrr)rrrrrr~$scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'$s zContour.opacitycCs ||d<dS)Nr'r)rrrrrr'$scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr$szContour.reversescalecCs ||d<dS)Nrr)rrrrrr$scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+$s zContour.showlegendcCs ||d<dS)Nr+r)rrrrrr+$scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr$s zContour.showscalecCs ||d<dS)Nrr)rrrrrr$scCs|dS)ah The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.contour.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.contour.Stream r,r)rrrrr,$szContour.streamcCs ||d<dS)Nr,r)rrrrrr,$scCs|dS)z Sets the text elements associated with each z value. The 'text' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r-r)rrrrr-$s z Contour.textcCs ||d<dS)Nr-r)rrrrrr-%scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3 %s zContour.textsrccCs ||d<dS)Nr3r)rrrrrr3%scCs|dS)z Transposes the z data. The 'transpose' property must be specified as a bool (either True, or False) Returns ------- bool r7r)rrrrr7!%s zContour.transposecCs ||d<dS)Nr7r)rrrrrr7/%scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr75%sz Contour.uidcCs ||d<dS)Nr7r)rrrrrr7E%scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8K%szContour.uirevisioncCs ||d<dS)Nr8r)rrrrrr8f%scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9l%szContour.visiblecCs ||d<dS)Nr9r)rrrrrr9}%scCs|dS)z Sets the x coordinates. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<%s z Contour.xcCs ||d<dS)Nr<r)rrrrrr<%scCs|dS)a  Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. The 'x0' property accepts values of any type Returns ------- Any r=r)rrrrr=%s z Contour.x0cCs ||d<dS)Nr=r)rrrrrr=%scCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>%sz Contour.xaxiscCs ||d<dS)Nr>r)rrrrrr>%scCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrr%szContour.xcalendarcCs ||d<dS)Nrr)rrrrrr%scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?%s z Contour.xsrccCs ||d<dS)Nr?r)rrrrrr?%scCs|dS)a If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). The 'xtype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any r8r)rrrrr8%sz Contour.xtypecCs ||d<dS)Nr8r)rrrrrr8&scCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@ &s z Contour.ycCs ||d<dS)Nr@r)rrrrrr@&scCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrA&s z Contour.y0cCs ||d<dS)NrAr)rrrrrrA,&scCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrB2&sz Contour.yaxiscCs ||d<dS)NrBr)rrrrrrBE&scCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrK&szContour.ycalendarcCs ||d<dS)Nrr)rrrrrr]&scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCc&s z Contour.ysrccCs ||d<dS)NrCr)rrrrrrCq&scCs|dS)a If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) The 'ytype' property is an enumeration that may be specified as: - One of the following enumeration values: ['array', 'scaled'] Returns ------- Any r9r)rrrrr9w&sz Contour.ytypecCs ||d<dS)Nr9r)rrrrrr9&scCs|dS)z Sets the z data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr&s z Contour.zcCs ||d<dS)Nrr)rrrrrr&scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr&sz Contour.zautocCs ||d<dS)Nrr)rrrrrr&scCs|dS)a Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'zhoverformat' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr&szContour.zhoverformatcCs ||d<dS)Nrr)rrrrrr&scCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr&s z Contour.zmaxcCs ||d<dS)Nrr)rrrrrr&scCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr&sz Contour.zmidcCs ||d<dS)Nrr)rrrrrr&scCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr&s z Contour.zmincCs ||d<dS)Nrr)rrrrrr 'scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr's z Contour.zsrccCs ||d<dS)Nrr)rrrrrr 'scCs |jdS)NrD)rE)rrrrrD&'sz Contour.typecCsdS)NrFr)rrrrrG,'szContour._parent_path_strcCsdS)NaN1 autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. autocontour Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.contour.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false. contours :class:`plotly.graph_objects.contour.Contours` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. fillcolor Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.contour.Hoverlabel` instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.contour.Line` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. ncontours Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.contour.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . transpose Transposes the z data. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . xtype If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . ytype If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) z Sets the z data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . r)rrrrrH2'szContour._prop_descriptionsNc<@ s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|< dd|_ ddl m }=|=|jd<|=|jd <|=|jd <|=|jd <|=|jd <|=|jd <|=|jd<|=|jd<|=|jd<|=|jd<|=|jd<|=|jd<|=|jd<|=|jd<|=|jd<|=|jd<|=|jd<|= |jd<|=!|jd<|="|jd<|=#|jd<|=$|jd<|=%|jd<|=&|jd<|='|jd <|=(|jd!<|=)|jd"<|=*|jd#<|=+|jd$<|=,|jd%<|=-|jd&<|=.|jd'<|=/|jd(<|=0|jd)<|=1|jd*<|=2|jd+<|=3|jd,<|=4|jd-<|=5|jd.<|=6|jd/<|=7|jd0<|=8|jd1<|=9|jd2<|=:|jd3<|=;|jd4<|=<|jd5<|==|jd6<|=>|jd7<|=?|jd8<|=@|jd9<|=A|jd:<|=B|jd;<|=C|jd<<|=D|jd=<|=E|jd><|=F|jd?<|=G|jd@<|=H|jdA<| dd}>|dk r|n|>|d<| d d}>|dk r|n|>|d <| d d}>|dk r|n|>|d <| d d}>|dk r|n|>|d <| d d}>|dk r:|n|>|d <| d d}>|dk r\|n|>|d <| dd}>|dk r~|n|>|d<| dd}>| dk r| n|>|d<| dd}>| dk r| n|>|d<| dd}>| dk r| n|>|d<| dd}>| dk r| n|>|d<| dd}>| dk r(| n|>|d<| dd}>|dk rJ|n|>|d<| dd}>|dk rl|n|>|d<| dd}>|dk r|n|>|d<| dd}>|dk r|n|>|d<| dd}>|dk r|n|>|d<| dd}>|dk r|n|>|d<| dd}>|dk r|n|>|d<| dd}>|dk r8|n|>|d<| dd}>|dk rZ|n|>|d<| dd}>|dk r||n|>|d<| dd}>|dk r|n|>|d<| dd}>|dk r|n|>|d<| d d}>|dk r|n|>|d <| d!d}>|dk r|n|>|d!<| d"d}>|dk r&|n|>|d"<| d#d}>|dk rH|n|>|d#<| d$d}>|dk rj|n|>|d$<| d%d}>|dk r|n|>|d%<| d&d}>| dk r| n|>|d&<| d'd}>|!dk r|!n|>|d'<| d(d}>|"dk r|"n|>|d(<| d)d}>|#dk r|#n|>|d)<| d*d}>|$dk r6|$n|>|d*<| d+d}>|%dk rX|%n|>|d+<| d,d}>|&dk rz|&n|>|d,<| d-d}>|'dk r|'n|>|d-<| d.d}>|(dk r|(n|>|d.<| d/d}>|)dk r|)n|>|d/<| d0d}>|*dk r|*n|>|d0<| d1d}>|+dk r$|+n|>|d1<| d2d}>|,dk rF|,n|>|d2<| d3d}>|-dk rh|-n|>|d3<| d4d}>|.dk r|.n|>|d4<| d5d}>|/dk r|/n|>|d5<| d6d}>|0dk r|0n|>|d6<| d7d}>|1dk r|1n|>|d7<| d8d}>|2dk r|2n|>|d8<| d9d}>|3dk r4|3n|>|d9<| d:d}>|4dk rV|4n|>|d:<| d;d}>|5dk rx|5n|>|d;<| d|6dk r|6n|>|d<<| d=d}>|7dk r|7n|>|d=<| d>d}>|8dk r|8n|>|d><| d?d}>|9dk r|9n|>|d?<| d@d}>|:dk r"|:n|>|d@<| dAd}>|;dk rD|;n|>|dA<ddBlImJ}?d|jKdC<|?dCdddD|jdC<| dCd|jLft|f|<d|_ dS)Ea4 Construct a new Contour object The data from which contour lines are computed is set in `z`. Data in `z` must be a 2D list of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto- generated). By setting `transpose` to True, the above behavior is flipped. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Contour` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. autocontour Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in `ncontours`. If False, set the contour level attributes in `contours`. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.contour.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false. contours :class:`plotly.graph_objects.contour.Contours` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. fillcolor Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.contour.Hoverlabel` instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.contour.Line` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. ncontours Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is True or if `contours.size` is missing. opacity Sets the opacity of the trace. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.contour.Stream` instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc Sets the source reference on plot.ly for text . transpose Transposes the z data. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . xtype If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided). y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . ytype If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided) z Sets the z data. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zhoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . Returns ------- Contour rNzThe first argument to the plotly.graph_objs.Contour constructor must be a dict or an instance of :class:`plotly.graph_objs.Contour`rJFr)rrr rrrrrr rrrrrrrr?rrrrrrrrr!r"r#rr'rr+rr,r-r3r7r7r8r9r<r=r>rr?r8r@rArBrrCr9rrrrrrr)rKrD)rLrMr)MrNrXrOrPrQrRrSrTrUrVrWrXrYrrr[rrrrrrr`rarcrdrrerfrgrArhrirjrkrlrmrqrrrrsrtr#rxrr|rr}r~rr;rrrrrrrrr<rrrrrr=rr(r)rr*rrrrKrEr)@rrrr rrrrrr rrrrrrrr?rrrrrrrrr!r"r#rr'rr+rr,r-r3r7r7r8r9r<r=r>rr?r8r@rArBrrCr9rrrrrrrrZ v_contourrrK)rQrrrO7(sV                                                                  zContour.__init__);NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Drrrrrrr rrrrrr rrrrrrrr?rrrrrrrrr!r"r#rr'rr+rr,r-r3r7r7r8r9r<r=r>rr?r8r@rArBrrCr9rrrrrrrrDrGrHrOrrr)rQrrXl sj    f .  Q     9   5  #       #                                      rXc4speZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8eddZ9eddZ:dfdd Z;Z= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrr+szCone.coloraxiscCs ||d<dS)Nrr)rrrrrr+scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.cone.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.cone.co lorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.cone.colorbar.tickformatstopdefaults), sets the default property values to use for elements of cone.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.cone.colorbar.Titl e` instance or dict with compatible properties titlefont Deprecated: Please use cone.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use cone.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.cone.ColorBar rr)rrrrr+saz Cone.colorbarcCs ||d<dS)Nrr)rrrrrr+scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrr,s,zCone.colorscalecCs ||d<dS)Nrr)rrrrrr1,scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr 7,szCone.customdatacCs ||d<dS)Nr r)rrrrrr H,scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrN,s zCone.customdatasrccCs ||d<dS)Nrr)rrrrrr\,scCs|dS)aw Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrb,szCone.hoverinfocCs ||d<dS)Nrr)rrrrrrv,scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr|,s zCone.hoverinfosrccCs ||d<dS)Nrr)rrrrrr,scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.cone.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.cone.Hoverlabel rr)rrrrr,s3zCone.hoverlabelcCs ||d<dS)Nrr)rrrrrr,scCs|dS)a- Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variable `norm` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr,s!zCone.hovertemplatecCs ||d<dS)Nrr)rrrrrr,scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr,s zCone.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr-scCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr-szCone.hovertextcCs ||d<dS)Nrr)rrrrrr-scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr-s zCone.hovertextsrccCs ||d<dS)Nrr)rrrrrr,-scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr2-szCone.idscCs ||d<dS)Nrr)rrrrrrB-scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrH-s z Cone.idssrccCs ||d<dS)Nrr)rrrrrrV-scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr\-szCone.legendgroupcCs ||d<dS)Nrr)rrrrrrm-scCs|dS)ac The 'lighting' property is an instance of Lighting that may be specified as: - An instance of :class:`plotly.graph_objs.cone.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor Supported dict properties: ambient Ambient light increases overall color visibility but can wash out the image. diffuse Represents the extent that incident rays are reflected in a range of angles. facenormalsepsilon Epsilon for face normals calculation avoids math issues arising from degenerate geometry. fresnel Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine. roughness Alters specular reflection; the rougher the surface, the wider and less contrasty the shine. specular Represents the level that incident rays are reflected in a single direction, causing shine. vertexnormalsepsilon Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry. Returns ------- plotly.graph_objs.cone.Lighting rr)rrrrrs-s(z Cone.lightingcCs ||d<dS)Nrr)rrrrrr-scCs|dS)a The 'lightposition' property is an instance of Lightposition that may be specified as: - An instance of :class:`plotly.graph_objs.cone.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor Supported dict properties: x Numeric vector, representing the X coordinate for each vertex. y Numeric vector, representing the Y coordinate for each vertex. z Numeric vector, representing the Z coordinate for each vertex. Returns ------- plotly.graph_objs.cone.Lightposition rr)rrrrr-szCone.lightpositioncCs ||d<dS)Nrr)rrrrrr-scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!-sz Cone.metacCs ||d<dS)Nr!r)rrrrrr!-scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"-s z Cone.metasrccCs ||d<dS)Nr"r)rrrrrr"-scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#-sz Cone.namecCs ||d<dS)Nr#r)rrrrrr#.scCs|dS)aS Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr' .sz Cone.opacitycCs ||d<dS)Nr'r)rrrrrr'.scCs|dS)aF Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr#.szCone.reversescalecCs ||d<dS)Nrr)rrrrrr3.scCs|dS)a7 Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular subplot, of type 'scene', that may be specified as the string 'scene' optionally followed by an integer >= 1 (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- str rr)rrrrr9.sz Cone.scenecCs ||d<dS)Nrr)rrrrrrL.scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+R.s zCone.showlegendcCs ||d<dS)Nr+r)rrrrrr+a.scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrg.s zCone.showscalecCs ||d<dS)Nrr)rrrrrrv.scCs|dS)a Determines whether `sizeref` is set as a "scaled" (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as "absolute" value (in the same units as the vector field). The 'sizemode' property is an enumeration that may be specified as: - One of the following enumeration values: ['scaled', 'absolute'] Returns ------- Any sizemoder)rrrrr[|.sz Cone.sizemodecCs ||d<dS)Nr[r)rrrrrr[.scCs|dS)aO Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to "scaled", `sizeref` is unitless, its default value is 0.5 With `sizemode` set to "absolute", `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm. The 'sizeref' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float r(r)rrrrr(.sz Cone.sizerefcCs ||d<dS)Nr(r)rrrrrr(.scCs|dS)ab The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.cone.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.cone.Stream r,r)rrrrr,.sz Cone.streamcCs ||d<dS)Nr,r)rrrrrr,.scCs|dS)a Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-.sz Cone.textcCs ||d<dS)Nr-r)rrrrrr-.scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3.s z Cone.textsrccCs ||d<dS)Nr3r)rrrrrr3.scCs|dS)z Sets the x components of the vector field. The 'u' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r*r)rrrrr*.s zCone.ucCs ||d<dS)Nr*r)rrrrrr* /scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7/szCone.uidcCs ||d<dS)Nr7r)rrrrrr7"/scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8(/szCone.uirevisioncCs ||d<dS)Nr8r)rrrrrr8C/scCs|dS)z Sets the source reference on plot.ly for u . The 'usrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r+r)rrrrr+I/s z Cone.usrccCs ||d<dS)Nr+r)rrrrrr+W/scCs|dS)z Sets the y components of the vector field. The 'v' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r,r)rrrrr,]/s zCone.vcCs ||d<dS)Nr,r)rrrrrr,k/scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9q/sz Cone.visiblecCs ||d<dS)Nr9r)rrrrrr9/scCs|dS)z Sets the source reference on plot.ly for v . The 'vsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r-r)rrrrr-/s z Cone.vsrccCs ||d<dS)Nr-r)rrrrrr-/scCs|dS)z Sets the z components of the vector field. The 'w' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r.r)rrrrr./s zCone.wcCs ||d<dS)Nr.r)rrrrrr./scCs|dS)z Sets the source reference on plot.ly for w . The 'wsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r/r)rrrrr//s z Cone.wsrccCs ||d<dS)Nr/r)rrrrrr//scCs|dS)a Sets the x coordinates of the vector field and of the displayed cones. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr</s zCone.xcCs ||d<dS)Nr<r)rrrrrr</scCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?/s z Cone.xsrccCs ||d<dS)Nr?r)rrrrrr?/scCs|dS)a Sets the y coordinates of the vector field and of the displayed cones. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@/s zCone.ycCs ||d<dS)Nr@r)rrrrrr@/scCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC0s z Cone.ysrccCs ||d<dS)NrCr)rrrrrrC0scCs|dS)a Sets the z coordinates of the vector field and of the displayed cones. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr0s zCone.zcCs ||d<dS)Nrr)rrrrrr%0scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr+0s z Cone.zsrccCs ||d<dS)Nrr)rrrrrr90scCs |jdS)NrD)rE)rrrrrD?0sz Cone.typecCsdS)NrFr)rrrrrGE0szCone._parent_path_strcCsdS)Na. anchor Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.cone.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.cone.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `norm` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.cone.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.cone.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. sizemode Determines whether `sizeref` is set as a "scaled" (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as "absolute" value (in the same units as the vector field). sizeref Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to "scaled", `sizeref` is unitless, its default value is 0.5 With `sizemode` set to "absolute", `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm. stream :class:`plotly.graph_objects.cone.Stream` instance or dict with compatible properties text Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . u Sets the x components of the vector field. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. usrc Sets the source reference on plot.ly for u . v Sets the y components of the vector field. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). vsrc Sets the source reference on plot.ly for v . w Sets the z components of the vector field. wsrc Sets the source reference on plot.ly for w . x Sets the x coordinates of the vector field and of the displayed cones. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates of the vector field and of the displayed cones. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates of the vector field and of the displayed cones. zsrc Sets the source reference on plot.ly for z . r)rrrrrHK0srzCone._prop_descriptionsNc59 sP tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|5 dd|_ ddl m }6|6|jd<|6|jd <|6|jd <|6|jd <|6|jd <|6|jd <|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6|jd<|6 |jd<|6!|jd<|6"|jd<|6#|jd<|6$|jd<|6%|jd<|6&|jd<|6'|jd <|6(|jd!<|6)|jd"<|6*|jd#<|6+|jd$<|6,|jd%<|6-|jd&<|6.|jd'<|6/|jd(<|60|jd)<|61|jd*<|62|jd+<|63|jd,<|64|jd-<|65|jd.<|66|jd/<|67|jd0<|68|jd1<|69|jd2<|6:|jd3<|6;|jd4<|6<|jd5<|6=|jd6<|6>|jd7<|6?|jd8<|6@|jd9<|6A|jd:<| dd}7|dk rP|n|7|d<| d d}7|dk rr|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| d d}7|dk r|n|7|d <| dd}7|dk r|n|7|d<| dd}7| dk r>| n|7|d<| dd}7| dk r`| n|7|d<| dd}7| dk r| n|7|d<| dd}7| dk r| n|7|d<| dd}7| dk r| n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r |n|7|d<| dd}7|dk r,|n|7|d<| dd}7|dk rN|n|7|d<| dd}7|dk rp|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r|n|7|d<| dd}7|dk r<|n|7|d<| dd}7|dk r^|n|7|d<| d d}7|dk r|n|7|d <| d!d}7|dk r|n|7|d!<| d"d}7|dk r|n|7|d"<| d#d}7|dk r|n|7|d#<| d$d}7|dk r|n|7|d$<| d%d}7|dk r*|n|7|d%<| d&d}7| dk rL| n|7|d&<| d'd}7|!dk rn|!n|7|d'<| d(d}7|"dk r|"n|7|d(<| d)d}7|#dk r|#n|7|d)<| d*d}7|$dk r|$n|7|d*<| d+d}7|%dk r|%n|7|d+<| d,d}7|&dk r|&n|7|d,<| d-d}7|'dk r:|'n|7|d-<| d.d}7|(dk r\|(n|7|d.<| d/d}7|)dk r~|)n|7|d/<| d0d}7|*dk r|*n|7|d0<| d1d}7|+dk r|+n|7|d1<| d2d}7|,dk r|,n|7|d2<| d3d}7|-dk r|-n|7|d3<| d4d}7|.dk r(|.n|7|d4<| d5d}7|/dk rJ|/n|7|d5<| d6d}7|0dk rl|0n|7|d6<| d7d}7|1dk r|1n|7|d7<| d8d}7|2dk r|2n|7|d8<| d9d}7|3dk r|3n|7|d9<| d:d}7|4dk r|4n|7|d:<dd;lBmC}8d|jDd<<|8da0 Construct a new Cone object Use cone traces to visualize vector fields. Specify a vector field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, `w`. The cones are drawn exactly at the positions given by `x`, `y` and `z`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Cone` anchor Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip. autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. cmax Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`. cmin Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.cone.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.cone.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `norm` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. lighting :class:`plotly.graph_objects.cone.Lighting` instance or dict with compatible properties lightposition :class:`plotly.graph_objects.cone.Lightposition` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change. reversescale Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color. scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. sizemode Determines whether `sizeref` is set as a "scaled" (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as "absolute" value (in the same units as the vector field). sizeref Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to "scaled", `sizeref` is unitless, its default value is 0.5 With `sizemode` set to "absolute", `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm. stream :class:`plotly.graph_objects.cone.Stream` instance or dict with compatible properties text Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textsrc Sets the source reference on plot.ly for text . u Sets the x components of the vector field. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. usrc Sets the source reference on plot.ly for u . v Sets the y components of the vector field. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). vsrc Sets the source reference on plot.ly for v . w Sets the z components of the vector field. wsrc Sets the source reference on plot.ly for w . x Sets the x coordinates of the vector field and of the displayed cones. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates of the vector field and of the displayed cones. ysrc Sets the source reference on plot.ly for y . z Sets the z coordinates of the vector field and of the displayed cones. zsrc Sets the source reference on plot.ly for z . Returns ------- Cone coneNzThe first argument to the plotly.graph_objs.Cone constructor must be a dict or an instance of :class:`plotly.graph_objs.Cone`rJFr)r\rZrrrrrrrrr rrrrrrrrrrrrrr!r"r#r'rrr+rr[r(r,r-r3r*r7r8r+r,r9r-r.r/r<r?r@rCrr)rKrD)rLrMr)FrNrYrOrPrQrRrSrTrUrVrWrXrYr\ZAnchorValidatorr[rrrrrrrrr`rarerfrgrhrirjrkrlrmrqrrrrrsrtrxrrr|rZSizemodeValidatorr1r}r~rr2rrr3r4rr5r6r7rrrrrrrrKrEr)9rrrZrrrrrrrrr rrrrrrrrrrrrrr!r"r#r'rrr+rr[r(r,r-r3r*r7r8r+r,r9r-r.r/r<r?r@rCrrrZv_conerrK)rQrrrO>1sZ:                                                           z Cone.__init__)4NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)=rrrrrZrrrrrrrrrr rrrrrrrrrrrrrr!r"r#r'rrr+rr[r(r,r-r3r*r7r8r+r,r9r-r.r/r<r?r@rCrrrDrGrHrOrrr)rQrrYr*s>        c .     5 #       *                                vrYc-seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1eddZ2eddZ3dfdd Z4Z5S)ChoroplethmapboxcCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrrL3szChoroplethmapbox.autocolorscalecCs ||d<dS)Nrr)rrrrrr_3scCs|dS)a Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer. The 'below' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rmr)rrrrrme3szChoroplethmapbox.belowcCs ||d<dS)Nrmr)rrrrrrmw3scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrr}3szChoroplethmapbox.coloraxiscCs ||d<dS)Nrr)rrrrrr3scCs|dS)aD- The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.choroplethmapbox.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.choropl ethmapbox.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.choroplethmapbox.colorbar.tickformatstopdefau lts), sets the default property values to use for elements of choroplethmapbox.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.choroplethmapbox.c olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use choroplethmapbox.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use choroplethmapbox.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.choroplethmapbox.ColorBar rr)rrrrr3sezChoroplethmapbox.colorbarcCs ||d<dS)Nrr)rrrrrr~4scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrr4s,zChoroplethmapbox.colorscalecCs ||d<dS)Nrr)rrrrrr4scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr 4szChoroplethmapbox.customdatacCs ||d<dS)Nr r)rrrrrr 4scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr4s zChoroplethmapbox.customdatasrccCs ||d<dS)Nrr)rrrrrr4scCs|dS)a Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example "properties.name". The 'featureidkey' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr4szChoroplethmapbox.featureidkeycCs ||d<dS)Nrr)rrrrrr4scCs|dS)a Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". The 'geojson' property accepts values of any type Returns ------- Any rr)rrrrr4szChoroplethmapbox.geojsoncCs ||d<dS)Nrr)rrrrrr 5scCs|dS)ai Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters (e.g. 'location+z') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr5szChoroplethmapbox.hoverinfocCs ||d<dS)Nrr)rrrrrr$5scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr*5s zChoroplethmapbox.hoverinfosrccCs ||d<dS)Nrr)rrrrrr85scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.choroplethmapbox.Hoverlabel rr)rrrrr>5s3zChoroplethmapbox.hoverlabelcCs ||d<dS)Nrr)rrrrrrs5scCs|dS)a3 Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variable `properties` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrry5s!zChoroplethmapbox.hovertemplatecCs ||d<dS)Nrr)rrrrrr5scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr5s z!Choroplethmapbox.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr5scCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr5szChoroplethmapbox.hovertextcCs ||d<dS)Nrr)rrrrrr5scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr5s zChoroplethmapbox.hovertextsrccCs ||d<dS)Nrr)rrrrrr5scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr5szChoroplethmapbox.idscCs ||d<dS)Nrr)rrrrrr5scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr5s zChoroplethmapbox.idssrccCs ||d<dS)Nrr)rrrrrr6scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr 6szChoroplethmapbox.legendgroupcCs ||d<dS)Nrr)rrrrrr6scCs|dS)a Sets which features found in "geojson" to plot using their feature `id` field. The 'locations' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr!6s zChoroplethmapbox.locationscCs ||d<dS)Nrr)rrrrrr06scCs|dS)z Sets the source reference on plot.ly for locations . The 'locationssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr66s zChoroplethmapbox.locationssrccCs ||d<dS)Nrr)rrrrrrD6scCs|dS)a& The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.choroplethmapbox.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: line :class:`plotly.graph_objects.choroplethmapbox.m arker.Line` instance or dict with compatible properties opacity Sets the opacity of the locations. opacitysrc Sets the source reference on plot.ly for opacity . Returns ------- plotly.graph_objs.choroplethmapbox.Marker rr)rrrrrJ6szChoroplethmapbox.markercCs ||d<dS)Nrr)rrrrrre6scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!k6szChoroplethmapbox.metacCs ||d<dS)Nr!r)rrrrrr!6scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"6s zChoroplethmapbox.metasrccCs ||d<dS)Nr"r)rrrrrr"6scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#6szChoroplethmapbox.namecCs ||d<dS)Nr#r)rrrrrr#6scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr6szChoroplethmapbox.reversescalecCs ||d<dS)Nrr)rrrrrr6scCs|dS)aq The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.choroplethmapbox.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.choroplethmapbox.s elected.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.choroplethmapbox.Selected rr)rrrrr6szChoroplethmapbox.selectedcCs ||d<dS)Nrr)rrrrrr6scCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*6szChoroplethmapbox.selectedpointscCs ||d<dS)Nr*r)rrrrrr*6scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+6s zChoroplethmapbox.showlegendcCs ||d<dS)Nr+r)rrrrrr+ 7scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr7s zChoroplethmapbox.showscalecCs ||d<dS)Nrr)rrrrrr7scCs|dS)az The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.choroplethmapbox.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.choroplethmapbox.Stream r,r)rrrrr,%7szChoroplethmapbox.streamcCs ||d<dS)Nr,r)rrrrrr,@7scCs|dS)a' Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. The 'subplot' property is an identifier of a particular subplot, of type 'mapbox', that may be specified as the string 'mapbox' optionally followed by an integer >= 1 (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) Returns ------- str rLr)rrrrrLF7szChoroplethmapbox.subplotcCs ||d<dS)NrLr)rrrrrrLY7scCs|dS)a] Sets the text elements associated with each location. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-_7szChoroplethmapbox.textcCs ||d<dS)Nr-r)rrrrrr-o7scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3u7s zChoroplethmapbox.textsrccCs ||d<dS)Nr3r)rrrrrr37scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr77szChoroplethmapbox.uidcCs ||d<dS)Nr7r)rrrrrr77scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr87szChoroplethmapbox.uirevisioncCs ||d<dS)Nr8r)rrrrrr87scCs|dS)a} The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.choroplethmapbox.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.choroplethmapbox.u nselected.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.choroplethmapbox.Unselected rr)rrrrr7szChoroplethmapbox.unselectedcCs ||d<dS)Nrr)rrrrrr7scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr97szChoroplethmapbox.visiblecCs ||d<dS)Nr9r)rrrrrr97scCs|dS)z Sets the color values. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr7s zChoroplethmapbox.zcCs ||d<dS)Nrr)rrrrrr8scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr8szChoroplethmapbox.zautocCs ||d<dS)Nrr)rrrrrr8scCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr8s zChoroplethmapbox.zmaxcCs ||d<dS)Nrr)rrrrrr-8scCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr38szChoroplethmapbox.zmidcCs ||d<dS)Nrr)rrrrrrC8scCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrI8s zChoroplethmapbox.zmincCs ||d<dS)Nrr)rrrrrrX8scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr^8s zChoroplethmapbox.zsrccCs ||d<dS)Nrr)rrrrrrl8scCs |jdS)NrD)rE)rrrrrDr8szChoroplethmapbox.typecCsdS)NrFr)rrrrrGx8sz!Choroplethmapbox._parent_path_strcCsdS)Na* autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. below Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.choroplethmapbox.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . featureidkey Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example "properties.name". geojson Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `properties` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. locations Sets which features found in "geojson" to plot using their feature `id` field. locationssrc Sets the source reference on plot.ly for locations . marker :class:`plotly.graph_objects.choroplethmapbox.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. selected :class:`plotly.graph_objects.choroplethmapbox.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.choroplethmapbox.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. text Sets the text elements associated with each location. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.choroplethmapbox.Unselecte d` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). z Sets the color values. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . r)rrrrrH~8sYz#Choroplethmapbox._prop_descriptionsNc.2 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|. dd|_ ddl m }/|/|jd<|/|jd <|/|jd <|/|jd <|/|jd <|/|jd <|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/ |jd<|/!|jd<|/"|jd<|/#|jd<|/$|jd<|/%|jd<|/&|jd<|/'|jd <|/(|jd!<|/)|jd"<|/*|jd#<|/+|jd$<|/,|jd%<|/-|jd&<|/.|jd'<|//|jd(<|/0|jd)<|/1|jd*<|/2|jd+<|/3|jd,<|/4|jd-<|/5|jd.<|/6|jd/<|/7|jd0<|/8|jd1<|/9|jd2<|/:|jd3<| dd}0|dk r|n|0|d<| d d}0|dk r|n|0|d <| d d}0|dk r2|n|0|d <| d d}0|dk rT|n|0|d <| d d}0|dk rv|n|0|d <| d d}0|dk r|n|0|d <| dd}0|dk r|n|0|d<| dd}0| dk r| n|0|d<| dd}0| dk r| n|0|d<| dd}0| dk r | n|0|d<| dd}0| dk rB| n|0|d<| dd}0| dk rd| n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r0|n|0|d<| dd}0|dk rR|n|0|d<| dd}0|dk rt|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| d d}0|dk r|n|0|d <| d!d}0|dk r@|n|0|d!<| d"d}0|dk rb|n|0|d"<| d#d}0|dk r|n|0|d#<| d$d}0|dk r|n|0|d$<| d%d}0|dk r|n|0|d%<| d&d}0| dk r| n|0|d&<| d'd}0|!dk r |!n|0|d'<| d(d}0|"dk r.|"n|0|d(<| d)d}0|#dk rP|#n|0|d)<| d*d}0|$dk rr|$n|0|d*<| d+d}0|%dk r|%n|0|d+<| d,d}0|&dk r|&n|0|d,<| d-d}0|'dk r|'n|0|d-<| d.d}0|(dk r|(n|0|d.<| d/d}0|)dk r|)n|0|d/<| d0d}0|*dk r>|*n|0|d0<| d1d}0|+dk r`|+n|0|d1<| d2d}0|,dk r|,n|0|d2<| d3d}0|-dk r|-n|0|d3<dd4l;m<}1d|j=d5<|1d5ddd6|jd5<| d5d|j>ft|f|.d|_ dS)7a, Construct a new Choroplethmapbox object GeoJSON features to be filled are set in `geojson` The data that describes the choropleth value-to-color mapping is set in `locations` and `z`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Choroplethmapbox` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. below Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.choroplethmapbox.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . featureidkey Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example "properties.name". geojson Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `properties` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. locations Sets which features found in "geojson" to plot using their feature `id` field. locationssrc Sets the source reference on plot.ly for locations . marker :class:`plotly.graph_objects.choroplethmapbox.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. selected :class:`plotly.graph_objects.choroplethmapbox.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.choroplethmapbox.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on. text Sets the text elements associated with each location. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.choroplethmapbox.Unselecte d` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). z Sets the color values. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . Returns ------- Choroplethmapbox choroplethmapboxNzThe first argument to the plotly.graph_objs.Choroplethmapbox constructor must be a dict or an instance of :class:`plotly.graph_objs.Choroplethmapbox`rJFr)r^rrmrrrr rrrrrrrrrrrrrrrrr!r"r#rrr*r+rr,rLr-r3r7r8rr9rrrrrr)rKrD)rLrMr)?rNr]rOrPrQrRrSrTrUrVrWrXrYr^rr[rsrrrr`rarrrerfrgrhrirjrkrlrmrqrrrrrrsrtrrr{r|rr}rUr~rrrrrrr(rr*rrrrKrEr)2rrrrmrrrr rrrrrrrrrrrrrrrrr!r"r#rrr*r+rr,rLr-r3r7r8rr9rrrrrrrZv_choroplethmapboxrrK)rQrrrOX9s0                                                    zChoroplethmapbox.__init__)-NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)6rrrrrrrmrrrr rrrrrrrrrrrrrrrrr!r"r#rrr*r+rr,rLr-r3r7r8rr9rrrrrrrDrGrHrOrrr)rQrr]H3s    g .       5 #                                  ]r]c-seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1eddZ2eddZ3dfdd Z4Z5S) ChoroplethcCs|dS)a  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. The 'autocolorscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr7;szChoropleth.autocolorscalecCs ||d<dS)Nrr)rrrrrrJ;scCs|dS)a Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. The 'coloraxis' property is an identifier of a particular subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' optionally followed by an integer >= 1 (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- str rr)rrrrrP;szChoropleth.coloraxiscCs ||d<dS)Nrr)rrrrrre;scCs|dS)a, The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.choropleth.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: bgcolor Sets the color of padded area. bordercolor Sets the axis line color. borderwidth Sets the width (in px) or the border enclosing this color bar. dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. len Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. lenmode Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in *pixels. Use `len` to set the value. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". outlinecolor Sets the axis line color. outlinewidth Sets the width (in px) of the axis line. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. thickness Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. thicknessmode Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the color bar's tick label font tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.choropl eth.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.choropleth.colorbar.tickformatstopdefaults), sets the default property values to use for elements of choropleth.colorbar.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.choropleth.colorba r.Title` instance or dict with compatible properties titlefont Deprecated: Please use choropleth.colorbar.title.font instead. Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleside Deprecated: Please use choropleth.colorbar.title.side instead. Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. x Sets the x position of the color bar (in plot fraction). xanchor Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. xpad Sets the amount of padding (in px) along the x direction. y Sets the y position of the color bar (in plot fraction). yanchor Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. ypad Sets the amount of padding (in px) along the y direction. Returns ------- plotly.graph_objs.choropleth.ColorBar rr)rrrrrk;sdzChoropleth.colorbarcCs ||d<dS)Nrr)rrrrrrP<scCs|dS)a Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis. The 'colorscale' property is a colorscale and may be specified as: - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - One of the following named colorscales: ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'peach', 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. Appending '_r' to a named colorscale reverses it. Returns ------- str rr)rrrrrV<s,zChoropleth.colorscalecCs ||d<dS)Nrr)rrrrrr<scCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr <szChoropleth.customdatacCs ||d<dS)Nr r)rrrrrr <scCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr<s zChoropleth.customdatasrccCs ||d<dS)Nrr)rrrrrr<scCs|dS)a Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name". The 'featureidkey' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr<szChoropleth.featureidkeycCs ||d<dS)Nrr)rrrrrr<scCs|dS)a/ Sets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on. The 'geo' property is an identifier of a particular subplot, of type 'geo', that may be specified as the string 'geo' optionally followed by an integer >= 1 (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) Returns ------- str rr)rrrrr<szChoropleth.geocCs ||d<dS)Nrr)rrrrrr<scCs|dS)a Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". The 'geojson' property accepts values of any type Returns ------- Any rr)rrrrr<szChoropleth.geojsoncCs ||d<dS)Nrr)rrrrrr<scCs|dS)ai Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters (e.g. 'location+z') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr<szChoropleth.hoverinfocCs ||d<dS)Nrr)rrrrrr=scCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr=s zChoropleth.hoverinfosrccCs ||d<dS)Nrr)rrrrrr%=scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.choropleth.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.choropleth.Hoverlabel rr)rrrrr+=s3zChoropleth.hoverlabelcCs ||d<dS)Nrr)rrrrrr`=scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrf=s!zChoropleth.hovertemplatecCs ||d<dS)Nrr)rrrrrr=scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr=s zChoropleth.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr=scCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr=szChoropleth.hovertextcCs ||d<dS)Nrr)rrrrrr=scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr=s zChoropleth.hovertextsrccCs ||d<dS)Nrr)rrrrrr=scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr=szChoropleth.idscCs ||d<dS)Nrr)rrrrrr=scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr=s zChoropleth.idssrccCs ||d<dS)Nrr)rrrrrr=scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr=szChoropleth.legendgroupcCs ||d<dS)Nrr)rrrrrr>scCs|dS)aI Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", "USA- states", *country names* correspond to features on the base map and value "geojson-id" corresponds to features from a custom GeoJSON linked to the `geojson` attribute. The 'locationmode' property is an enumeration that may be specified as: - One of the following enumeration values: ['ISO-3', 'USA-states', 'country names', 'geojson-id'] Returns ------- Any rr)rrrrr>szChoropleth.locationmodecCs ||d<dS)Nrr)rrrrrr!>scCs|dS)a" Sets the coordinates via location IDs or names. See `locationmode` for more info. The 'locations' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr'>s zChoropleth.locationscCs ||d<dS)Nrr)rrrrrr6>scCs|dS)z Sets the source reference on plot.ly for locations . The 'locationssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr<>s zChoropleth.locationssrccCs ||d<dS)Nrr)rrrrrrJ>scCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.choropleth.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: line :class:`plotly.graph_objects.choropleth.marker. Line` instance or dict with compatible properties opacity Sets the opacity of the locations. opacitysrc Sets the source reference on plot.ly for opacity . Returns ------- plotly.graph_objs.choropleth.Marker rr)rrrrrP>szChoropleth.markercCs ||d<dS)Nrr)rrrrrrk>scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!q>szChoropleth.metacCs ||d<dS)Nr!r)rrrrrr!>scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr">s zChoropleth.metasrccCs ||d<dS)Nr"r)rrrrrr">scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#>szChoropleth.namecCs ||d<dS)Nr#r)rrrrrr#>scCs|dS)aF Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr>szChoropleth.reversescalecCs ||d<dS)Nrr)rrrrrr>scCs|dS)a_ The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.choropleth.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.choropleth.selecte d.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.choropleth.Selected rr)rrrrr>szChoropleth.selectedcCs ||d<dS)Nrr)rrrrrr>scCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*>szChoropleth.selectedpointscCs ||d<dS)Nr*r)rrrrrr*>scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+?s zChoropleth.showlegendcCs ||d<dS)Nr+r)rrrrrr+?scCs|dS)z Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr?s zChoropleth.showscalecCs ||d<dS)Nrr)rrrrrr%?scCs|dS)an The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.choropleth.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.choropleth.Stream r,r)rrrrr,+?szChoropleth.streamcCs ||d<dS)Nr,r)rrrrrr,F?scCs|dS)a] Sets the text elements associated with each location. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-L?szChoropleth.textcCs ||d<dS)Nr-r)rrrrrr-\?scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3b?s zChoropleth.textsrccCs ||d<dS)Nr3r)rrrrrr3p?scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7v?szChoropleth.uidcCs ||d<dS)Nr7r)rrrrrr7?scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8?szChoropleth.uirevisioncCs ||d<dS)Nr8r)rrrrrr8?scCs|dS)ak The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.choropleth.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.choropleth.unselec ted.Marker` instance or dict with compatible properties Returns ------- plotly.graph_objs.choropleth.Unselected rr)rrrrr?szChoropleth.unselectedcCs ||d<dS)Nrr)rrrrrr?scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9?szChoropleth.visiblecCs ||d<dS)Nr9r)rrrrrr9?scCs|dS)z Sets the color values. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr?s z Choropleth.zcCs ||d<dS)Nrr)rrrrrr?scCs|dS)a Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True, or False) Returns ------- bool rr)rrrrr?szChoropleth.zautocCs ||d<dS)Nrr)rrrrrr@scCs|dS)a+ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr @s zChoropleth.zmaxcCs ||d<dS)Nrr)rrrrrr@scCs|dS)aq Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr @szChoropleth.zmidcCs ||d<dS)Nrr)rrrrrr0@scCs|dS)a+ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrr6@s zChoropleth.zmincCs ||d<dS)Nrr)rrrrrrE@scCs|dS)z Sets the source reference on plot.ly for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrK@s zChoropleth.zsrccCs ||d<dS)Nrr)rrrrrrY@scCs |jdS)NrD)rE)rrrrrD_@szChoropleth.typecCsdS)NrFr)rrrrrGe@szChoropleth._parent_path_strcCsdS)NaU+ autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.choropleth.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . featureidkey Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name". geo Sets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on. geojson Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.choropleth.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", "USA-states", *country names* correspond to features on the base map and value "geojson-id" corresponds to features from a custom GeoJSON linked to the `geojson` attribute. locations Sets the coordinates via location IDs or names. See `locationmode` for more info. locationssrc Sets the source reference on plot.ly for locations . marker :class:`plotly.graph_objects.choropleth.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. selected :class:`plotly.graph_objects.choropleth.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.choropleth.Stream` instance or dict with compatible properties text Sets the text elements associated with each location. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.choropleth.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). z Sets the color values. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . r)rrrrrHk@s\zChoropleth._prop_descriptionsNc.2 s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|. dd|_ ddl m }/|/|jd<|/|jd <|/|jd <|/|jd <|/|jd <|/|jd <|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/|jd<|/ |jd<|/!|jd<|/"|jd<|/#|jd<|/$|jd<|/%|jd<|/&|jd<|/'|jd <|/(|jd!<|/)|jd"<|/*|jd#<|/+|jd$<|/,|jd%<|/-|jd&<|/.|jd'<|//|jd(<|/0|jd)<|/1|jd*<|/2|jd+<|/3|jd,<|/4|jd-<|/5|jd.<|/6|jd/<|/7|jd0<|/8|jd1<|/9|jd2<|/:|jd3<| dd}0|dk r|n|0|d<| d d}0|dk r|n|0|d <| d d}0|dk r2|n|0|d <| d d}0|dk rT|n|0|d <| d d}0|dk rv|n|0|d <| d d}0|dk r|n|0|d <| dd}0|dk r|n|0|d<| dd}0| dk r| n|0|d<| dd}0| dk r| n|0|d<| dd}0| dk r | n|0|d<| dd}0| dk rB| n|0|d<| dd}0| dk rd| n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r0|n|0|d<| dd}0|dk rR|n|0|d<| dd}0|dk rt|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| dd}0|dk r|n|0|d<| d d}0|dk r|n|0|d <| d!d}0|dk r@|n|0|d!<| d"d}0|dk rb|n|0|d"<| d#d}0|dk r|n|0|d#<| d$d}0|dk r|n|0|d$<| d%d}0|dk r|n|0|d%<| d&d}0| dk r| n|0|d&<| d'd}0|!dk r |!n|0|d'<| d(d}0|"dk r.|"n|0|d(<| d)d}0|#dk rP|#n|0|d)<| d*d}0|$dk rr|$n|0|d*<| d+d}0|%dk r|%n|0|d+<| d,d}0|&dk r|&n|0|d,<| d-d}0|'dk r|'n|0|d-<| d.d}0|(dk r|(n|0|d.<| d/d}0|)dk r|)n|0|d/<| d0d}0|*dk r>|*n|0|d0<| d1d}0|+dk r`|+n|0|d1<| d2d}0|,dk r|,n|0|d2<| d3d}0|-dk r|-n|0|d3<dd4l;m<}1d|j=d5<|1d5ddd6|jd5<| d5d|j>ft|f|.d|_ dS)7a-- Construct a new Choropleth object The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Choropleth` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.choropleth.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . featureidkey Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name". geo Sets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on. geojson Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon". hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.choropleth.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", "USA-states", *country names* correspond to features on the base map and value "geojson-id" corresponds to features from a custom GeoJSON linked to the `geojson` attribute. locations Sets the coordinates via location IDs or names. See `locationmode` for more info. locationssrc Sets the source reference on plot.ly for locations . marker :class:`plotly.graph_objects.choropleth.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. reversescale Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. selected :class:`plotly.graph_objects.choropleth.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. showscale Determines whether or not a colorbar is displayed for this trace. stream :class:`plotly.graph_objects.choropleth.Stream` instance or dict with compatible properties text Sets the text elements associated with each location. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.choropleth.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). z Sets the color values. zauto Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. zmax Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. zmid Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. zmin Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. zsrc Sets the source reference on plot.ly for z . Returns ------- Choropleth choroplethNzThe first argument to the plotly.graph_objs.Choropleth constructor must be a dict or an instance of :class:`plotly.graph_objs.Choropleth`rJFr)r`rrrrr rrrrrrrrrrrrrrrrrrr!r"r#rrr*r+rr,r-r3r7r8rr9rrrrrr)rKrD)rLrMr)?rNr_rOrPrQrRrSrTrUrVrWrXrYr`rr[rrrr`rarrrrerfrgrhrirjrkrlrmrqrrrrrrrsrtrrr{r|rr}r~rrrrrrr(rr*rrrrKrEr)2rrrrrrr rrrrrrrrrrrrrrrrrrr!r"r#rrr*r+rr,r-r3r7r8rr9rrrrrrrZ v_choroplethrrK)rQrrrOHAs0                                                    zChoropleth.__init__)-NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)6rrrrrrrrrr rrrrrrrrrrrrrrrrrrr!r"r#rrr*r+rr,r-r3r7r8rr9rrrrrrrDrGrHrOrrr)rQrr_3;s   f .        5 #                                  `r_c!seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%edcddZ&ededfZ'djfdhdi Z(Z)S)kCarpetcCs|dS)z An array containing values of the first parameter value The 'a' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rDr)rrrrrD#Cs zCarpet.acCs ||d<dS)NrDr)rrrrrrD1CscCs|dS)a5 Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. The 'a0' property is a number and may be specified as: - An int or float Returns ------- int|float rMr)rrrrrM7Csz Carpet.a0cCs ||d<dS)NrMr)rrrrrrMGCscCs|dS)ai+ The 'aaxis' property is an instance of Aaxis that may be specified as: - An instance of :class:`plotly.graph_objs.carpet.Aaxis` - A dict of string/value properties that will be passed to the Aaxis constructor Supported dict properties: arraydtick The stride between grid lines along the axis arraytick0 The starting index of grid lines along the axis autorange Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to False. categoryarray Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`. categoryarraysrc Sets the source reference on plot.ly for categoryarray . categoryorder Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. cheatertype color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. dtick The stride between grid lines along the axis endline Determines whether or not a line is drawn at along the final value of this axis. If True, the end line is drawn on top of the grid lines. endlinecolor Sets the line color of the end line. endlinewidth Sets the width (in px) of the end line. exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. fixedrange Determines whether or not this axis is zoom- able. If true, then zoom is disabled. gridcolor Sets the axis line color. gridwidth Sets the width (in px) of the axis line. labelpadding Extra padding between label and the axis labelprefix Sets a axis label prefix. labelsuffix Sets a axis label suffix. linecolor Sets the axis line color. linewidth Sets the width (in px) of the axis line. minorgridcolor Sets the color of the grid lines. minorgridcount Sets the number of minor grid ticks per major grid tick minorgridwidth Sets the width (in px) of the grid lines. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". range Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. rangemode If "normal", the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If "nonnegative", the range is non- negative, regardless of the input data. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showgrid Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. showline Determines whether or not a line bounding this axis is drawn. showticklabels Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. smoothing startline Determines whether or not a line is drawn at along the starting value of this axis. If True, the start line is drawn on top of the grid lines. startlinecolor Sets the line color of the start line. startlinewidth Sets the width (in px) of the start line. tick0 The starting index of grid lines along the axis tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickfont Sets the tick font. tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.carpet. aaxis.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.carpet.aaxis.tickformatstopdefaults), sets the default property values to use for elements of carpet.aaxis.tickformatstops tickmode tickprefix Sets a tick label prefix. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . title :class:`plotly.graph_objects.carpet.aaxis.Title ` instance or dict with compatible properties titlefont Deprecated: Please use carpet.aaxis.title.font instead. Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleoffset Deprecated: Please use carpet.aaxis.title.offset instead. An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute. type Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question. Returns ------- plotly.graph_objs.carpet.Aaxis aaxisr)rrrrrbMCsdz Carpet.aaxiscCs ||d<dS)Nrbr)rrrrrrb2DscCs|dS)z Sets the source reference on plot.ly for a . The 'asrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rEr)rrrrrE8Ds z Carpet.asrccCs ||d<dS)NrEr)rrrrrrEFDscCs|dS)z A two dimensional array of y coordinates at each carpet point. The 'b' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rFr)rrrrrFLDs zCarpet.bcCs ||d<dS)NrFr)rrrrrrFZDscCs|dS)a5 Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. The 'b0' property is a number and may be specified as: - An int or float Returns ------- int|float rOr)rrrrrO`Dsz Carpet.b0cCs ||d<dS)NrOr)rrrrrrOpDscCs|dS)ai+ The 'baxis' property is an instance of Baxis that may be specified as: - An instance of :class:`plotly.graph_objs.carpet.Baxis` - A dict of string/value properties that will be passed to the Baxis constructor Supported dict properties: arraydtick The stride between grid lines along the axis arraytick0 The starting index of grid lines along the axis autorange Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to False. categoryarray Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`. categoryarraysrc Sets the source reference on plot.ly for categoryarray . categoryorder Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. cheatertype color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. dtick The stride between grid lines along the axis endline Determines whether or not a line is drawn at along the final value of this axis. If True, the end line is drawn on top of the grid lines. endlinecolor Sets the line color of the end line. endlinewidth Sets the width (in px) of the end line. exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. fixedrange Determines whether or not this axis is zoom- able. If true, then zoom is disabled. gridcolor Sets the axis line color. gridwidth Sets the width (in px) of the axis line. labelpadding Extra padding between label and the axis labelprefix Sets a axis label prefix. labelsuffix Sets a axis label suffix. linecolor Sets the axis line color. linewidth Sets the width (in px) of the axis line. minorgridcolor Sets the color of the grid lines. minorgridcount Sets the number of minor grid ticks per major grid tick minorgridwidth Sets the width (in px) of the grid lines. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". range Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. rangemode If "normal", the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If "nonnegative", the range is non- negative, regardless of the input data. separatethousands If "true", even 4-digit integers are separated showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showgrid Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. showline Determines whether or not a line bounding this axis is drawn. showticklabels Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. smoothing startline Determines whether or not a line is drawn at along the starting value of this axis. If True, the start line is drawn on top of the grid lines. startlinecolor Sets the line color of the start line. startlinewidth Sets the width (in px) of the start line. tick0 The starting index of grid lines along the axis tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickfont Sets the tick font. tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.carpet. baxis.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.carpet.baxis.tickformatstopdefaults), sets the default property values to use for elements of carpet.baxis.tickformatstops tickmode tickprefix Sets a tick label prefix. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . title :class:`plotly.graph_objects.carpet.baxis.Title ` instance or dict with compatible properties titlefont Deprecated: Please use carpet.baxis.title.font instead. Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. titleoffset Deprecated: Please use carpet.baxis.title.offset instead. An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute. type Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question. Returns ------- plotly.graph_objs.carpet.Baxis baxisr)rrrrrcvDsdz Carpet.baxiscCs ||d<dS)Nrcr)rrrrrrc[EscCs|dS)z Sets the source reference on plot.ly for b . The 'bsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rGr)rrrrrGaEs z Carpet.bsrccCs ||d<dS)NrGr)rrrrrrGoEscCs|dS)ab An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie The 'carpet' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrruEsz Carpet.carpetcCs ||d<dS)Nrr)rrrrrrEscCs|dS)a& The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been ommitted. The 'cheaterslope' property is a number and may be specified as: - An int or float Returns ------- int|float cheatersloper)rrrrrdEs zCarpet.cheaterslopecCs ||d<dS)Nrdr)rrrrrrdEscCs|dS)a Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. The 'color' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrrEs6z Carpet.colorcCs ||d<dS)Nrr)rrrrrrEscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr EszCarpet.customdatacCs ||d<dS)Nr r)rrrrrr EscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrEs zCarpet.customdatasrccCs ||d<dS)Nrr)rrrrrrFscCs|dS)z Sets the a coordinate step. See `a0` for more info. The 'da' property is a number and may be specified as: - An int or float Returns ------- int|float rQr)rrrrrQ Fs z Carpet.dacCs ||d<dS)NrQr)rrrrrrQFscCs|dS)z Sets the b coordinate step. See `b0` for more info. The 'db' property is a number and may be specified as: - An int or float Returns ------- int|float rRr)rrrrrRFs z Carpet.dbcCs ||d<dS)NrRr)rrrrrrR,FscCs|dS)a The default font used for axis & tick labels on this carpet The 'font' property is an instance of Font that may be specified as: - An instance of :class:`plotly.graph_objs.carpet.Font` - A dict of string/value properties that will be passed to the Font constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- plotly.graph_objs.carpet.Font rr)rrrrr2Fs%z Carpet.fontcCs ||d<dS)Nrr)rrrrrrYFscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr_Fsz Carpet.idscCs ||d<dS)Nrr)rrrrrroFscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrruFs z Carpet.idssrccCs ||d<dS)Nrr)rrrrrrFscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!Fsz Carpet.metacCs ||d<dS)Nr!r)rrrrrr!FscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Fs zCarpet.metasrccCs ||d<dS)Nr"r)rrrrrr"FscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#Fsz Carpet.namecCs ||d<dS)Nr#r)rrrrrr#FscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'Fs zCarpet.opacitycCs ||d<dS)Nr'r)rrrrrr'FscCs|dS)af The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.carpet.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.carpet.Stream r,r)rrrrr,Fsz Carpet.streamcCs ||d<dS)Nr,r)rrrrrr,FscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7Gsz Carpet.uidcCs ||d<dS)Nr7r)rrrrrr7GscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8GszCarpet.uirevisioncCs ||d<dS)Nr8r)rrrrrr85GscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9;GszCarpet.visiblecCs ||d<dS)Nr9r)rrrrrr9LGscCs|dS)a[ A two dimensional array of x coordinates at each carpet point. If ommitted, the plot is a cheater plot and the xaxis is hidden by default. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r<r)rrrrr<RGszCarpet.xcCs ||d<dS)Nr<r)rrrrrr<bGscCs|dS)a Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular subplot, of type 'x', that may be specified as the string 'x' optionally followed by an integer >= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>hGsz Carpet.xaxiscCs ||d<dS)Nr>r)rrrrrr>{GscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?Gs z Carpet.xsrccCs ||d<dS)Nr?r)rrrrrr?GscCs|dS)z A two dimensional array of y coordinates at each carpet point. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@Gs zCarpet.ycCs ||d<dS)Nr@r)rrrrrr@GscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBGsz Carpet.yaxiscCs ||d<dS)NrBr)rrrrrrBGscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrCGs z Carpet.ysrccCs ||d<dS)NrCr)rrrrrrCGscCs |jdS)NrD)rE)rrrrrDGsz Carpet.typecCsdS)NrFr)rrrrrGGszCarpet._parent_path_strcCsdS)NaX a An array containing values of the first parameter value a0 Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. aaxis :class:`plotly.graph_objects.carpet.Aaxis` instance or dict with compatible properties asrc Sets the source reference on plot.ly for a . b A two dimensional array of y coordinates at each carpet point. b0 Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. baxis :class:`plotly.graph_objects.carpet.Baxis` instance or dict with compatible properties bsrc Sets the source reference on plot.ly for b . carpet An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie cheaterslope The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been ommitted. color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . da Sets the a coordinate step. See `a0` for more info. db Sets the b coordinate step. See `b0` for more info. font The default font used for axis & tick labels on this carpet ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. stream :class:`plotly.graph_objects.carpet.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x A two dimensional array of x coordinates at each carpet point. If ommitted, the plot is a cheater plot and the xaxis is hidden by default. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y A two dimensional array of y coordinates at each carpet point. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . r)rrrrrHGszCarpet._prop_descriptionsNc"& stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|" dd|_ ddl m }#|#|jd<|#|jd <|#|jd <|#|jd <|#|jd <|#|jd <|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|#|jd<|# |jd<|#!|jd<|#"|jd<|##|jd<|#$|jd<|#%|jd<|#&|jd<|#'|jd<|#(|jd <|#)|jd!<|#*|jd"<|#+|jd#<|#,|jd$<|#-|jd%<|#.|jd&<| dd}$|dk rF|n|$|d<| d d}$|dk rh|n|$|d <| d d}$|dk r|n|$|d <| d d}$|dk r|n|$|d <| d d}$|dk r|n|$|d <| d d}$|dk r|n|$|d <| dd}$|dk r|n|$|d<| dd}$| dk r4| n|$|d<| dd}$| dk rV| n|$|d<| dd}$| dk rx| n|$|d<| dd}$| dk r| n|$|d<| dd}$| dk r| n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r"|n|$|d<| dd}$|dk rD|n|$|d<| dd}$|dk rf|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r|n|$|d<| dd}$|dk r2|n|$|d<| dd}$|dk rT|n|$|d<| dd}$|dk rv|n|$|d<| d d}$|dk r|n|$|d <| d!d}$|dk r|n|$|d!<| d"d}$|dk r|n|$|d"<| d#d}$|dk r|n|$|d#<| d$d}$|dk r |n|$|d$<| d%d}$| dk rB| n|$|d%<| d&d}$|!dk rd|!n|$|d&<dd'l/m0}%d|j1d(<|%d(ddd)|jd(<| d(d|j2ft|f|"d|_ dS)*a Construct a new Carpet object The data describing carpet axis layout is set in `y` and (optionally) also `x`. If only `y` is present, `x` the plot is interpreted as a cheater plot and is filled in using the `y` values. `x` and `y` may either be 2D arrays matching with each dimension matching that of `a` and `b`, or they may be 1D arrays with total length equal to that of `a` and `b`. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Carpet` a An array containing values of the first parameter value a0 Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. aaxis :class:`plotly.graph_objects.carpet.Aaxis` instance or dict with compatible properties asrc Sets the source reference on plot.ly for a . b A two dimensional array of y coordinates at each carpet point. b0 Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. baxis :class:`plotly.graph_objects.carpet.Baxis` instance or dict with compatible properties bsrc Sets the source reference on plot.ly for b . carpet An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie cheaterslope The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been ommitted. color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . da Sets the a coordinate step. See `a0` for more info. db Sets the b coordinate step. See `b0` for more info. font The default font used for axis & tick labels on this carpet ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. stream :class:`plotly.graph_objects.carpet.Stream` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). x A two dimensional array of x coordinates at each carpet point. If ommitted, the plot is a cheater plot and the xaxis is hidden by default. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xsrc Sets the source reference on plot.ly for x . y A two dimensional array of y coordinates at each carpet point. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ysrc Sets the source reference on plot.ly for y . Returns ------- Carpet rNzThe first argument to the plotly.graph_objs.Carpet constructor must be a dict or an instance of :class:`plotly.graph_objs.Carpet`rJFr)rrDrMrbrErFrOrcrGrdrr rrQrRrrrr!r"r#r'r,r7r8r9r<r>r?r@rBrC)rKrD)rLrMr)3rNrarOrPrQrRrSrTrUrVrWrXrYrrOr[rTZAaxisValidatorrPrQrUZBaxisValidatorrRrZCheaterslopeValidatorrr`rarVrW FontValidatorrlrmrrrsrtrxr}rrrrrrrrrrrKrEr)&rrrDrMrbrErFrOrcrGrrdrr rrQrRrrrr!r"r#r'r,r7r8r9r<r>r?r@rBrCrZv_carpetrrK)rQrrrOfHs9                                        zCarpet.__init__)!NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)*rrrrrDrrMrbrErFrOrcrGrrdrr rrQrRrrrr!r"r#r'r,r7r8r9r<r>r?r@rBrCrDrGrHrOrrr)rQrraCs   f    f    8     '                   rac(s8eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,edxdyZ-edzd{Z.dfd}d~ Z/Z0S) CandlestickcCs|dS)z Sets the close values. The 'close' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrIs zCandlestick.closecCs ||d<dS)Nrr)rrrrrrIscCs|dS)z Sets the source reference on plot.ly for close . The 'closesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrIs zCandlestick.closesrccCs ||d<dS)Nrr)rrrrrrIscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr IszCandlestick.customdatacCs ||d<dS)Nr r)rrrrrr IscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrIs zCandlestick.customdatasrccCs ||d<dS)Nrr)rrrrrrJscCs|dS)a` The 'decreasing' property is an instance of Decreasing that may be specified as: - An instance of :class:`plotly.graph_objs.candlestick.Decreasing` - A dict of string/value properties that will be passed to the Decreasing constructor Supported dict properties: fillcolor Sets the fill color. Defaults to a half- transparent variant of the line color, marker color, or marker line color, whichever is available. line :class:`plotly.graph_objects.candlestick.decrea sing.Line` instance or dict with compatible properties Returns ------- plotly.graph_objs.candlestick.Decreasing rr)rrrrr JszCandlestick.decreasingcCs ||d<dS)Nrr)rrrrrr'JscCs|dS)z Sets the high values. The 'high' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr-Js zCandlestick.highcCs ||d<dS)Nrr)rrrrrr;JscCs|dS)z Sets the source reference on plot.ly for high . The 'highsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrAJs zCandlestick.highsrccCs ||d<dS)Nrr)rrrrrrOJscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrUJszCandlestick.hoverinfocCs ||d<dS)Nrr)rrrrrriJscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrroJs zCandlestick.hoverinfosrccCs ||d<dS)Nrr)rrrrrr}JscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.candlestick.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . split Show hover information (open, close, high, low) in separate labels. Returns ------- plotly.graph_objs.candlestick.Hoverlabel rr)rrrrrJs6zCandlestick.hoverlabelcCs ||d<dS)Nrr)rrrrrrJscCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrJszCandlestick.hovertextcCs ||d<dS)Nrr)rrrrrrJscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrJs zCandlestick.hovertextsrccCs ||d<dS)Nrr)rrrrrrJscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrJszCandlestick.idscCs ||d<dS)Nrr)rrrrrrJscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrKs zCandlestick.idssrccCs ||d<dS)Nrr)rrrrrrKscCs|dS)a` The 'increasing' property is an instance of Increasing that may be specified as: - An instance of :class:`plotly.graph_objs.candlestick.Increasing` - A dict of string/value properties that will be passed to the Increasing constructor Supported dict properties: fillcolor Sets the fill color. Defaults to a half- transparent variant of the line color, marker color, or marker line color, whichever is available. line :class:`plotly.graph_objects.candlestick.increa sing.Line` instance or dict with compatible properties Returns ------- plotly.graph_objs.candlestick.Increasing rr)rrrrrKszCandlestick.increasingcCs ||d<dS)Nrr)rrrrrr0KscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr6KszCandlestick.legendgroupcCs ||d<dS)Nrr)rrrrrrGKscCs|dS)a The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.candlestick.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: width Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`. Returns ------- plotly.graph_objs.candlestick.Line rr)rrrrrMKszCandlestick.linecCs ||d<dS)Nrr)rrrrrreKscCs|dS)z Sets the low values. The 'low' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrkKs zCandlestick.lowcCs ||d<dS)Nrr)rrrrrryKscCs|dS)z Sets the source reference on plot.ly for low . The 'lowsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrKs zCandlestick.lowsrccCs ||d<dS)Nrr)rrrrrrKscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!KszCandlestick.metacCs ||d<dS)Nr!r)rrrrrr!KscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Ks zCandlestick.metasrccCs ||d<dS)Nr"r)rrrrrr"KscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#KszCandlestick.namecCs ||d<dS)Nr#r)rrrrrr#KscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'Ks zCandlestick.opacitycCs ||d<dS)Nr'r)rrrrrr'KscCs|dS)z Sets the open values. The 'open' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrKs zCandlestick.opencCs ||d<dS)Nrr)rrrrrrKscCs|dS)z Sets the source reference on plot.ly for open . The 'opensrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrLs zCandlestick.opensrccCs ||d<dS)Nrr)rrrrrrLscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*LszCandlestick.selectedpointscCs ||d<dS)Nr*r)rrrrrr*'LscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+-Ls zCandlestick.showlegendcCs ||d<dS)Nr+r)rrrrrr+= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>MszCandlestick.xaxiscCs ||d<dS)Nr>r)rrrrrr>MscCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrr!MszCandlestick.xcalendarcCs ||d<dS)Nrr)rrrrrr3MscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?9Ms zCandlestick.xsrccCs ||d<dS)Nr?r)rrrrrr?GMscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBMMszCandlestick.yaxiscCs ||d<dS)NrBr)rrrrrrB`MscCs |jdS)NrD)rE)rrrrrDfMszCandlestick.typecCsdS)NrFr)rrrrrGlMszCandlestick._parent_path_strcCsdS)Na close Sets the close values. closesrc Sets the source reference on plot.ly for close . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . decreasing :class:`plotly.graph_objects.candlestick.Decreasing` instance or dict with compatible properties high Sets the high values. highsrc Sets the source reference on plot.ly for high . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.candlestick.Hoverlabel` instance or dict with compatible properties hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . increasing :class:`plotly.graph_objects.candlestick.Increasing` instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.candlestick.Line` instance or dict with compatible properties low Sets the low values. lowsrc Sets the source reference on plot.ly for low . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. open Sets the open values. opensrc Sets the source reference on plot.ly for open . selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.candlestick.Stream` instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). whiskerwidth Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es). x Sets the x coordinates. If absent, linear coordinate will be generated. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. r)rrrrrHrMszCandlestick._prop_descriptionsNc)- stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|) dd|_ ddl m }*|*|jd<|*|jd <|*|jd <|*|jd <|*|jd <|*|jd <|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|*|jd<|* |jd<|*!|jd<|*"|jd<|*#|jd<|*$|jd<|*%|jd<|*&|jd<|*'|jd <|*(|jd!<|*)|jd"<|**|jd#<|*+|jd$<|*,|jd%<|*-|jd&<|*.|jd'<|*/|jd(<|*0|jd)<|*1|jd*<|*2|jd+<|*3|jd,<|*4|jd-<|*5|jd.<| dd}+|dk r|n|+|d<| d d}+|dk r|n|+|d <| d d}+|dk r|n|+|d <| d d}+|dk r|n|+|d <| d d}+|dk r0|n|+|d <| d d}+|dk rR|n|+|d <| dd}+|dk rt|n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+| dk r| n|+|d<| dd}+|dk r@|n|+|d<| dd}+|dk rb|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r |n|+|d<| dd}+|dk r.|n|+|d<| dd}+|dk rP|n|+|d<| dd}+|dk rr|n|+|d<| dd}+|dk r|n|+|d<| dd}+|dk r|n|+|d<| d d}+|dk r|n|+|d <| d!d}+|dk r|n|+|d!<| d"d}+|dk r|n|+|d"<| d#d}+|dk r>|n|+|d#<| d$d}+|dk r`|n|+|d$<| d%d}+|dk r|n|+|d%<| d&d}+| dk r| n|+|d&<| d'd}+|!dk r|!n|+|d'<| d(d}+|"dk r|"n|+|d(<| d)d}+|#dk r |#n|+|d)<| d*d}+|$dk r,|$n|+|d*<| d+d}+|%dk rN|%n|+|d+<| d,d}+|&dk rp|&n|+|d,<| d-d}+|'dk r|'n|+|d-<| d.d}+|(dk r|(n|+|d.<dd/l6m7},d|j8d0<|,d0ddd1|jd0<| d0d|j9ft|f|)d|_ dS)2a Construct a new Candlestick object The candlestick is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The boxes represent the spread between the `open` and `close` values and the lines represent the spread between the `low` and `high` values Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Candlestick` close Sets the close values. closesrc Sets the source reference on plot.ly for close . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . decreasing :class:`plotly.graph_objects.candlestick.Decreasing` instance or dict with compatible properties high Sets the high values. highsrc Sets the source reference on plot.ly for high . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.candlestick.Hoverlabel` instance or dict with compatible properties hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . increasing :class:`plotly.graph_objects.candlestick.Increasing` instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.candlestick.Line` instance or dict with compatible properties low Sets the low values. lowsrc Sets the source reference on plot.ly for low . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. open Sets the open values. opensrc Sets the source reference on plot.ly for open . selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.candlestick.Stream` instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). whiskerwidth Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es). x Sets the x coordinates. If absent, linear coordinate will be generated. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. Returns ------- Candlestick candlestickNzThe first argument to the plotly.graph_objs.Candlestick constructor must be a dict or an instance of :class:`plotly.graph_objs.Candlestick`rJFr)rhrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr*r+r,r-r3r7r8r9rgr<r>rr?rB)rKrD)rLrMr):rNrfrOrPrQrRrSrTrUrVrWrXrYrhrr[rr`rarbrrrerfrgrjrkrlrmrnrqrrrrrrsrtrxrrr{r|r}r~rrrrWhiskerwidthValidatorrrrrrrrKrEr)-rrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr*r+r,r-r3r7r8r9rgr<r>rr?rBrZ v_candlestickrrK)rQrrrONsS                                               zCandlestick.__init__)(NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)1rrrrrrrr rrrrrrrrrrrrrrrrr!r"r#r'rrr*r+r,r-r3r7r8r9rgr<r>rr?rBrDrGrHrOrrr)rQrrfIs          8                                rfcGs^eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZe>jddZ>eddZ?e?jddZ?eddZ@e@jddZ@eddZAeAjddZAeddZBeBjddZBeddZCeCjddZCeddZDeDjddZDedd„ZEeEjdd„ZEeddńZFeFjddńZFeddȄZGeGjddȄZGedd˄ZHeHjdd˄ZHedd΄ZIeIjdd΄ZIeddфZJeJjddфZJeddԄZKeddքZLedd؄ZMd܇fddۄ ZNZOS)BoxcCs|dS)a Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. The 'alignmentgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrOszBox.alignmentgroupcCs ||d<dS)Nrr)rrrrrrOscCs|dS)a If True, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn. Defaults to True when `mean` is set. Defaults to "sd" when `sd` is set Otherwise defaults to False. The 'boxmean' property is an enumeration that may be specified as: - One of the following enumeration values: [True, 'sd', False] Returns ------- Any boxmeanr)rrrrrkOsz Box.boxmeancCs ||d<dS)Nrkr)rrrrrrkOscCs|dS)aB If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If False, only the box(es) are shown with no sample points Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to "all" under the q1/median/q3 signature. Otherwise defaults to "outliers". The 'boxpoints' property is an enumeration that may be specified as: - One of the following enumeration values: ['all', 'outliers', 'suspectedoutliers', False] Returns ------- Any boxpointsr)rrrrrlOsz Box.boxpointscCs ||d<dS)Nrlr)rrrrrrlOscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr OszBox.customdatacCs ||d<dS)Nr r)rrrrrr OscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrOs zBox.customdatasrccCs ||d<dS)Nrr)rrrrrrOscCs|dS)z Sets the x coordinate step for multi-box traces set using q1/median/q3. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrPs zBox.dxcCs ||d<dS)Nrr)rrrrrrPscCs|dS)z Sets the y coordinate step for multi-box traces set using q1/median/q3. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrrPs zBox.dycCs ||d<dS)Nrr)rrrrrr$PscCs|dS)a Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. The 'fillcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str rr)rrrrr*Ps5z Box.fillcolorcCs ||d<dS)Nrr)rrrrrraPscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrgPsz Box.hoverinfocCs ||d<dS)Nrr)rrrrrr{PscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrPs zBox.hoverinfosrccCs ||d<dS)Nrr)rrrrrrPscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.box.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.box.Hoverlabel rr)rrrrrPs3zBox.hoverlabelcCs ||d<dS)Nrr)rrrrrrPscCs|dS)ah Do the hover effects highlight individual boxes or sample points or both? The 'hoveron' property is a flaglist and may be specified as a string containing: - Any combination of ['boxes', 'points'] joined with '+' characters (e.g. 'boxes+points') Returns ------- Any rr)rrrrrPsz Box.hoveroncCs ||d<dS)Nrr)rrrrrrPscCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrPs!zBox.hovertemplatecCs ||d<dS)Nrr)rrrrrr QscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrQs zBox.hovertemplatesrccCs ||d<dS)Nrr)rrrrrrQscCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr$Qsz Box.hovertextcCs ||d<dS)Nrr)rrrrrr4QscCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr:Qs zBox.hovertextsrccCs ||d<dS)Nrr)rrrrrrHQscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrNQszBox.idscCs ||d<dS)Nrr)rrrrrr^QscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrdQs z Box.idssrccCs ||d<dS)Nrr)rrrrrrrQscCs|dS)a Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es). The 'jitter' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float rr)rrrrrxQsz Box.jittercCs ||d<dS)Nrr)rrrrrrQscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrQszBox.legendgroupcCs ||d<dS)Nrr)rrrrrrQscCs|dS)aN The 'line' property is an instance of Line that may be specified as: - An instance of :class:`plotly.graph_objs.box.Line` - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the color of line bounding the box(es). width Sets the width (in px) of line bounding the box(es). Returns ------- plotly.graph_objs.box.Line rr)rrrrrQszBox.linecCs ||d<dS)Nrr)rrrrrrQscCs|dS)a Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR. The 'lowerfence' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray lowerfencer)rrrrrmQszBox.lowerfencecCs ||d<dS)Nrmr)rrrrrrmQscCs|dS)z Sets the source reference on plot.ly for lowerfence . The 'lowerfencesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str lowerfencesrcr)rrrrrnQs zBox.lowerfencesrccCs ||d<dS)Nrnr)rrrrrrnQscCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.box.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. line :class:`plotly.graph_objects.box.marker.Line` instance or dict with compatible properties opacity Sets the marker opacity. outliercolor Sets the color of the outlier sample points. size Sets the marker size (in px). symbol Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot- open" to a symbol name. Returns ------- plotly.graph_objs.box.Marker rr)rrrrrQs&z Box.markercCs ||d<dS)Nrr)rrrrrrRscCs|dS)a Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values. The 'mean' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray meanr)rrrrroRszBox.meancCs ||d<dS)Nror)rrrrrro/RscCs|dS)z Sets the source reference on plot.ly for mean . The 'meansrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str meansrcr)rrrrrp5Rs z Box.meansrccCs ||d<dS)Nrpr)rrrrrrpCRscCs|dS)a# Sets the median values. There should be as many items as the number of boxes desired. The 'median' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray medianr)rrrrrqIRs z Box.mediancCs ||d<dS)Nrqr)rrrrrrqXRscCs|dS)z Sets the source reference on plot.ly for median . The 'mediansrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str mediansrcr)rrrrrr^Rs z Box.mediansrccCs ||d<dS)Nrrr)rrrrrrrlRscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!rRszBox.metacCs ||d<dS)Nr!r)rrrrrr!RscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"Rs z Box.metasrccCs ||d<dS)Nr"r)rrrrrr"RscCs|dS)a Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#RszBox.namecCs ||d<dS)Nr#r)rrrrrr#RscCs|dS)a Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched- box-plots for more info. Defaults to False unless `notchwidth` or `notchspan` is set. The 'notched' property must be specified as a bool (either True, or False) Returns ------- bool notchedr)rrrrrsRsz Box.notchedcCs ||d<dS)Nrsr)rrrrrrsRscCs|dS)a+ Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size. The 'notchspan' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray notchspanr)rrrrrtRsz Box.notchspancCs ||d<dS)Nrtr)rrrrrrtRscCs|dS)z Sets the source reference on plot.ly for notchspan . The 'notchspansrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str notchspansrcr)rrrrruRs zBox.notchspansrccCs ||d<dS)Nrur)rrrrrruRscCs|dS)aD Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es). The 'notchwidth' property is a number and may be specified as: - An int or float in the interval [0, 0.5] Returns ------- int|float notchwidthr)rrrrrvSs zBox.notchwidthcCs ||d<dS)Nrvr)rrrrrrvSscCs|dS)a Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. The 'offsetgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r%r)rrrrr%SszBox.offsetgroupcCs ||d<dS)Nr%r)rrrrrr%)SscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'/Ss z Box.opacitycCs ||d<dS)Nr'r)rrrrrr'=SscCs|dS)a] Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal). The 'orientation' property is an enumeration that may be specified as: - One of the following enumeration values: ['v', 'h'] Returns ------- Any r(r)rrrrr(CSszBox.orientationcCs ||d<dS)Nr(r)rrrrrr(SSscCs|dS)a Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes The 'pointpos' property is a number and may be specified as: - An int or float in the interval [-2, 2] Returns ------- int|float rr)rrrrrYSsz Box.pointposcCs ||d<dS)Nrr)rrrrrrkSscCs|dS)a# Sets the Quartile 1 values. There should be as many items as the number of boxes desired. The 'q1' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray q1r)rrrrrwqSs zBox.q1cCs ||d<dS)Nrwr)rrrrrrwSscCs|dS)z Sets the source reference on plot.ly for q1 . The 'q1src' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str q1srcr)rrrrrxSs z Box.q1srccCs ||d<dS)Nrxr)rrrrrrxSscCs|dS)a# Sets the Quartile 3 values. There should be as many items as the number of boxes desired. The 'q3' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray q3r)rrrrrySs zBox.q3cCs ||d<dS)Nryr)rrrrrrySscCs|dS)z Sets the source reference on plot.ly for q3 . The 'q3src' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str q3srcr)rrrrrzSs z Box.q3srccCs ||d<dS)Nrzr)rrrrrrzSscCs|dS)a Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publications/jse/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half. The 'quartilemethod' property is an enumeration that may be specified as: - One of the following enumeration values: ['linear', 'exclusive', 'inclusive'] Returns ------- Any quartilemethodr)rrrrr{SszBox.quartilemethodcCs ||d<dS)Nr{r)rrrrrr{SscCs|dS)a  Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values. The 'sd' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray sdr)rrrrr|SszBox.sdcCs ||d<dS)Nr|r)rrrrrr|SscCs|dS)z Sets the source reference on plot.ly for sd . The 'sdsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str sdsrcr)rrrrr}Ss z Box.sdsrccCs ||d<dS)Nr}r)rrrrrr} TscCs|dS)a6 The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.box.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.box.selected.Marke r` instance or dict with compatible properties Returns ------- plotly.graph_objs.box.Selected rr)rrrrrTsz Box.selectedcCs ||d<dS)Nrr)rrrrrr$TscCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr**TszBox.selectedpointscCs ||d<dS)Nr*r)rrrrrr*= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>Usz Box.xaxiscCs ||d<dS)Nr>r)rrrrrr>UscCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrUsz Box.xcalendarcCs ||d<dS)Nrr)rrrrrrUscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?Us zBox.xsrccCs ||d<dS)Nr?r)rrrrrr?UscCs|dS)a  Sets the y sample data or coordinates. See overview for more info. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@Us zBox.ycCs ||d<dS)Nr@r)rrrrrr@UscCs|dS)a Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAUs zBox.y0cCs ||d<dS)NrAr)rrrrrrAUscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrBVsz Box.yaxiscCs ||d<dS)NrBr)rrrrrrBVscCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrVsz Box.ycalendarcCs ||d<dS)Nrr)rrrrrr+VscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC1Vs zBox.ysrccCs ||d<dS)NrCr)rrrrrrC?VscCs |jdS)NrD)rE)rrrrrDEVszBox.typecCsdS)NrFr)rrrrrGKVszBox._parent_path_strcCsdS)Na@ alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. boxmean If True, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn. Defaults to True when `mean` is set. Defaults to "sd" when `sd` is set Otherwise defaults to False. boxpoints If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If False, only the box(es) are shown with no sample points Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to "all" under the q1/median/q3 signature. Otherwise defaults to "outliers". customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step for multi-box traces set using q1/median/q3. dy Sets the y coordinate step for multi-box traces set using q1/median/q3. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.box.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual boxes or sample points or both? hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . jitter Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es). legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.box.Line` instance or dict with compatible properties lowerfence Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR. lowerfencesrc Sets the source reference on plot.ly for lowerfence . marker :class:`plotly.graph_objects.box.Marker` instance or dict with compatible properties mean Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values. meansrc Sets the source reference on plot.ly for mean . median Sets the median values. There should be as many items as the number of boxes desired. mediansrc Sets the source reference on plot.ly for median . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical notched Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home /notched-box-plots for more info. Defaults to False unless `notchwidth` or `notchspan` is set. notchspan Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size. notchspansrc Sets the source reference on plot.ly for notchspan . notchwidth Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es). offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal). pointpos Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes q1 Sets the Quartile 1 values. There should be as many items as the number of boxes desired. q1src Sets the source reference on plot.ly for q1 . q3 Sets the Quartile 3 values. There should be as many items as the number of boxes desired. q3src Sets the source reference on plot.ly for q3 . quartilemethod Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publication s/jse/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half. sd Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values. sdsrc Sets the source reference on plot.ly for sd . selected :class:`plotly.graph_objects.box.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.box.Stream` instance or dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.box.Unselected` instance or dict with compatible properties upperfence Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point above 1.5 times the IQR. upperfencesrc Sets the source reference on plot.ly for upperfence . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). whiskerwidth Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es). width Sets the width of the box in data coordinate If 0 (default value) the width is automatically selected based on the positions of other box traces in the same subplot. x Sets the x sample data or coordinates. See overview for more info. x0 Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y sample data or coordinates. See overview for more info. y0 Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . r)rrrrrHQVsIzBox._prop_descriptionsNcHL s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|H dd|_ ddl m }I|I|jd<|I|jd <|I|jd <|I|jd <|I|jd <|I|jd <|I|jd<|I|jd<|I|jd<|I|jd<|I|jd<|I|jd<|I|jd<|I|jd<|I|jd<|I|jd<|I|jd<|I |jd<|I!|jd<|I"|jd<|I#|jd<|I$|jd<|I%|jd<|I&|jd<|I'|jd <|I(|jd!<|I)|jd"<|I*|jd#<|I+|jd$<|I,|jd%<|I-|jd&<|I.|jd'<|I/|jd(<|I0|jd)<|I1|jd*<|I2|jd+<|I3|jd,<|I4|jd-<|I5|jd.<|I6|jd/<|I7|jd0<|I8|jd1<|I9|jd2<|I:|jd3<|I;|jd4<|I<|jd5<|I=|jd6<|I>|jd7<|I?|jd8<|I@|jd9<|IA|jd:<|IB|jd;<|IC|jd<<|ID|jd=<|IE|jd><|IF|jd?<|IG|jd@<|IH|jdA<|II|jdB<|IJ|jdC<|IK|jdD<|IL|jdE<|IM|jdF<|IN|jdG<|IO|jdH<|IP|jdI<|IQ|jdJ<|IR|jdK<|IS|jdL<|IT|jdM<| dd}J|dk rZ|n|J|d<| d d}J|dk r||n|J|d <| d d}J|dk r|n|J|d <| d d}J|dk r|n|J|d <| d d}J|dk r|n|J|d <| d d}J|dk r|n|J|d <| dd}J|dk r&|n|J|d<| dd}J| dk rH| n|J|d<| dd}J| dk rj| n|J|d<| dd}J| dk r| n|J|d<| dd}J| dk r| n|J|d<| dd}J| dk r| n|J|d<| dd}J|dk r|n|J|d<| dd}J|dk r|n|J|d<| dd}J|dk r6|n|J|d<| dd}J|dk rX|n|J|d<| dd}J|dk rz|n|J|d<| dd}J|dk r|n|J|d<| dd}J|dk r|n|J|d<| dd}J|dk r|n|J|d<| dd}J|dk r|n|J|d<| dd}J|dk r$|n|J|d<| dd}J|dk rF|n|J|d<| dd}J|dk rh|n|J|d<| d d}J|dk r|n|J|d <| d!d}J|dk r|n|J|d!<| d"d}J|dk r|n|J|d"<| d#d}J|dk r|n|J|d#<| d$d}J|dk r|n|J|d$<| d%d}J|dk r4|n|J|d%<| d&d}J| dk rV| n|J|d&<| d'd}J|!dk rx|!n|J|d'<| d(d}J|"dk r|"n|J|d(<| d)d}J|#dk r|#n|J|d)<| d*d}J|$dk r|$n|J|d*<| d+d}J|%dk r|%n|J|d+<| d,d}J|&dk r"|&n|J|d,<| d-d}J|'dk rD|'n|J|d-<| d.d}J|(dk rf|(n|J|d.<| d/d}J|)dk r|)n|J|d/<| d0d}J|*dk r|*n|J|d0<| d1d}J|+dk r|+n|J|d1<| d2d}J|,dk r|,n|J|d2<| d3d}J|-dk r|-n|J|d3<| d4d}J|.dk r2|.n|J|d4<| d5d}J|/dk rT|/n|J|d5<| d6d}J|0dk rv|0n|J|d6<| d7d}J|1dk r|1n|J|d7<| d8d}J|2dk r|2n|J|d8<| d9d}J|3dk r|3n|J|d9<| d:d}J|4dk r|4n|J|d:<| d;d}J|5dk r |5n|J|d;<| dd}J|8dk r|8n|J|d><| d?d}J|9dk r|9n|J|d?<| d@d}J|:dk r|:n|J|d@<| dAd}J|;dk r|;n|J|dA<| dBd}J|dk rR|>n|J|dD<| dEd}J|?dk rt|?n|J|dE<| dFd}J|@dk r|@n|J|dF<| dGd}J|Adk r|An|J|dG<| dHd}J|Bdk r|Bn|J|dH<| dId}J|Cdk r|Cn|J|dI<| dJd}J|Ddk r|Dn|J|dJ<| dKd}J|Edk r@|En|J|dK<| dLd}J|Fdk rb|Fn|J|dL<| dMd}J|Gdk r|Gn|J|dM<ddNlUmV}Kd|jWdO<|KdOdddP|jdO<| dOd|jXft|f|Hd|_ dS)Qa\G Construct a new Box object Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow outward from the boxes' edges, by default they span +/- 1.5 times the interquartile range (IQR: Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and suspected outliers points can be optionally added to the box plot. The values and positions corresponding to each boxes can be input using two signatures. The first signature expects users to supply the sample values in the `y` data array for vertical boxes (`x` for horizontal boxes). By supplying an `x` (`y`) array, one box per distinct `x` (`y`) value is drawn If no `x` (`y`) list is provided, a single box is drawn. In this case, the box is positioned with the trace `name` or with `x0` (`y0`) if provided. The second signature expects users to supply the boxes corresponding Q1, median and Q3 statistics in the `q1`, `median` and `q3` data arrays respectively. Other box features relying on statistics namely `lowerfence`, `upperfence`, `notchspan` can be set directly by the users. To have plotly compute them or to show sample points besides the boxes, users can set the `y` data array for vertical boxes (`x` for horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in the traces and the inner length corresponding the sample size. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Box` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. boxmean If True, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn. Defaults to True when `mean` is set. Defaults to "sd" when `sd` is set Otherwise defaults to False. boxpoints If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If False, only the box(es) are shown with no sample points Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to "all" under the q1/median/q3 signature. Otherwise defaults to "outliers". customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step for multi-box traces set using q1/median/q3. dy Sets the y coordinate step for multi-box traces set using q1/median/q3. fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.box.Hoverlabel` instance or dict with compatible properties hoveron Do the hover effects highlight individual boxes or sample points or both? hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . jitter Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es). legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line :class:`plotly.graph_objects.box.Line` instance or dict with compatible properties lowerfence Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR. lowerfencesrc Sets the source reference on plot.ly for lowerfence . marker :class:`plotly.graph_objects.box.Marker` instance or dict with compatible properties mean Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values. meansrc Sets the source reference on plot.ly for mean . median Sets the median values. There should be as many items as the number of boxes desired. mediansrc Sets the source reference on plot.ly for median . meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical notched Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home /notched-box-plots for more info. Defaults to False unless `notchwidth` or `notchspan` is set. notchspan Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size. notchspansrc Sets the source reference on plot.ly for notchspan . notchwidth Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es). offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. opacity Sets the opacity of the trace. orientation Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal). pointpos Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes q1 Sets the Quartile 1 values. There should be as many items as the number of boxes desired. q1src Sets the source reference on plot.ly for q1 . q3 Sets the Quartile 3 values. There should be as many items as the number of boxes desired. q3src Sets the source reference on plot.ly for q3 . quartilemethod Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publication s/jse/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half. sd Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values. sdsrc Sets the source reference on plot.ly for sd . selected :class:`plotly.graph_objects.box.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.box.Stream` instance or dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. textsrc Sets the source reference on plot.ly for text . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.box.Unselected` instance or dict with compatible properties upperfence Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point above 1.5 times the IQR. upperfencesrc Sets the source reference on plot.ly for upperfence . visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). whiskerwidth Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es). width Sets the width of the box in data coordinate If 0 (default value) the width is automatically selected based on the positions of other box traces in the same subplot. x Sets the x sample data or coordinates. See overview for more info. x0 Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y sample data or coordinates. See overview for more info. y0 Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . Returns ------- Box rNz}The first argument to the plotly.graph_objs.Box constructor must be a dict or an instance of :class:`plotly.graph_objs.Box`rJFr)rrrkrlr rrrrrrrrrrrrrrrrrrmrnrrorprqrrr!r"r#rsrtrurvr%r'r(rrwrxryrzr{r|r}rr*r+r,r-r3r7r8rr~rr9rgr:r<r=r>rr?r@rArBrrC)rKrD)rLrMr)YrNrjrOrPrQrRrSrTrUrVrWrXrYrrZr[ZBoxmeanValidatorZBoxpointsValidatorr`rarcrdrrerfrgrrhrirjrkrlrmrrqrZLowerfenceValidatorZLowerfencesrcValidatorrZ MeanValidatorZMeansrcValidatorZMedianValidatorZMediansrcValidatorrrrsrtZNotchedValidatorZNotchspanValidatorZNotchspansrcValidatorZNotchwidthValidatorrvrxryrZ Q1ValidatorZQ1SrcValidatorZ Q3ValidatorZQ3SrcValidatorZQuartilemethodValidatorZ SdValidatorZSdsrcValidatorrr{r|r}r~rrrrZUpperfenceValidatorZUpperfencesrcValidatorrrirrrrrrrrrrrrrKrEr)Lrrrrkrlr rrrrrrrrrrrrrrrrrrmrnrrorprqrrr!r"r#rsrtrurvr%r'r(rrwrxryrzr{r|r}rr*r+r,r-r3r7r8rr~rr9rgr:r<r=r>rr?r@rArBrrCrZv_boxrrK)rQrrrOWs8                                                                              z Box.__init__)GNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Prrrrrrrkrlr rrrrrrrrrrrrrrrrrrmrnrrorprqrrr!r"r#rsrtrurvr%r'r(rrwrxryrzr{r|r}rr*r+r,r-r3r7r8rr~rr9rgr:r<r=r>rr?r@rArBrrCrDrGrHrOrrr)rQrrjOs        7   5  #           (                                                 Mrjc,seZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0eddZ1eddZ2dfdd Z3Z4S)BarpolarcCs|dS)a2 Sets where the bar base is drawn (in radial axis units). In "stack" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead. The 'base' property accepts values of any type Returns ------- Any|numpy.ndarray r r)rrrrr ^Zs z Barpolar.basecCs ||d<dS)Nr r)rrrrrr mZscCs|dS)z Sets the source reference on plot.ly for base . The 'basesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str basesrcr)rrrrrsZs zBarpolar.basesrccCs ||d<dS)Nrr)rrrrrrZscCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr ZszBarpolar.customdatacCs ||d<dS)Nr r)rrrrrr ZscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrZs zBarpolar.customdatasrccCs ||d<dS)Nrr)rrrrrrZscCs|dS)z Sets the r coordinate step. The 'dr' property is a number and may be specified as: - An int or float Returns ------- int|float rWr)rrrrrWZs z Barpolar.drcCs ||d<dS)NrWr)rrrrrrWZscCs|dS)a@ Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates. The 'dtheta' property is a number and may be specified as: - An int or float Returns ------- int|float rXr)rrrrrXZszBarpolar.dthetacCs ||d<dS)NrXr)rrrrrrXZscCs|dS)ac Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters (e.g. 'r+theta') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrZszBarpolar.hoverinfocCs ||d<dS)Nrr)rrrrrrZscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrZs zBarpolar.hoverinfosrccCs ||d<dS)Nrr)rrrrrr[scCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.barpolar.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.barpolar.Hoverlabel rr)rrrrr [s3zBarpolar.hoverlabelcCs ||d<dS)Nrr)rrrrrr?[scCs|dS)a Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrE[s!zBarpolar.hovertemplatecCs ||d<dS)Nrr)rrrrrrh[scCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrn[s zBarpolar.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr|[scCs|dS)a< Same as `text`. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr[szBarpolar.hovertextcCs ||d<dS)Nrr)rrrrrr[scCs|dS)z Sets the source reference on plot.ly for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr[s zBarpolar.hovertextsrccCs ||d<dS)Nrr)rrrrrr[scCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrr[sz Barpolar.idscCs ||d<dS)Nrr)rrrrrr[scCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr[s zBarpolar.idssrccCs ||d<dS)Nrr)rrrrrr[scCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr[szBarpolar.legendgroupcCs ||d<dS)Nrr)rrrrrr[scCs|dS)a The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.barpolar.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. cauto Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. cmax Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well. cmid Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`. cmin Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well. color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. coloraxis Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar :class:`plotly.graph_objects.barpolar.marker.Co lorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis. colorsrc Sets the source reference on plot.ly for color . line :class:`plotly.graph_objects.barpolar.marker.Li ne` instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc Sets the source reference on plot.ly for opacity . reversescale Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. showscale Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array. Returns ------- plotly.graph_objs.barpolar.Marker rr)rrrrr[sozBarpolar.markercCs ||d<dS)Nrr)rrrrrr^\scCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!d\sz Barpolar.metacCs ||d<dS)Nr!r)rrrrrr!z\scCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"\s zBarpolar.metasrccCs ||d<dS)Nr"r)rrrrrr"\scCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#\sz Barpolar.namecCs ||d<dS)Nr#r)rrrrrr#\scCs|dS)aQ Shifts the angular position where the bar is drawn (in "thetatunit" units). The 'offset' property is a number and may be specified as: - An int or float - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray r$r)rrrrr$\szBarpolar.offsetcCs ||d<dS)Nr$r)rrrrrr$\scCs|dS)z Sets the source reference on plot.ly for offset . The 'offsetsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r&r)rrrrr&\s zBarpolar.offsetsrccCs ||d<dS)Nr&r)rrrrrr&\scCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'\s zBarpolar.opacitycCs ||d<dS)Nr'r)rrrrrr'\scCs|dS)z Sets the radial coordinates The 'r' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rYr)rrrrrY\s z Barpolar.rcCs ||d<dS)NrYr)rrrrrrY\scCs|dS)a  Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. The 'r0' property accepts values of any type Returns ------- Any rZr)rrrrrZ\s z Barpolar.r0cCs ||d<dS)NrZr)rrrrrrZ ]scCs|dS)z Sets the source reference on plot.ly for r . The 'rsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r[r)rrrrr[]s z Barpolar.rsrccCs ||d<dS)Nr[r)rrrrrr[]scCs|dS)a The 'selected' property is an instance of Selected that may be specified as: - An instance of :class:`plotly.graph_objs.barpolar.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker :class:`plotly.graph_objects.barpolar.selected. Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.barpolar.selected. Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.barpolar.Selected rr)rrrrr%]szBarpolar.selectedcCs ||d<dS)Nrr)rrrrrr?]scCs|dS)a Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. The 'selectedpoints' property accepts values of any type Returns ------- Any r*r)rrrrr*E]szBarpolar.selectedpointscCs ||d<dS)Nr*r)rrrrrr*W]scCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+]]s zBarpolar.showlegendcCs ||d<dS)Nr+r)rrrrrr+l]scCs|dS)aj The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.barpolar.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.barpolar.Stream r,r)rrrrr,r]szBarpolar.streamcCs ||d<dS)Nr,r)rrrrrr,]scCs|dS)a Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. The 'subplot' property is an identifier of a particular subplot, of type 'polar', that may be specified as the string 'polar' optionally followed by an integer >= 1 (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) Returns ------- str rLr)rrrrrL]szBarpolar.subplotcCs ||d<dS)NrLr)rrrrrrL]scCs|dS)a Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates. The 'text' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray r-r)rrrrr-]sz Barpolar.textcCs ||d<dS)Nr-r)rrrrrr-]scCs|dS)z Sets the source reference on plot.ly for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3r)rrrrr3]s zBarpolar.textsrccCs ||d<dS)Nr3r)rrrrrr3]scCs|dS)z Sets the angular coordinates The 'theta' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r\r)rrrrr\]s zBarpolar.thetacCs ||d<dS)Nr\r)rrrrrr\]scCs|dS)a! Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. The 'theta0' property accepts values of any type Returns ------- Any r]r)rrrrr]]s zBarpolar.theta0cCs ||d<dS)Nr]r)rrrrrr]]scCs|dS)z Sets the source reference on plot.ly for theta . The 'thetasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r^r)rrrrr^^s zBarpolar.thetasrccCs ||d<dS)Nr^r)rrrrrr^^scCs|dS)aY Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. The 'thetaunit' property is an enumeration that may be specified as: - One of the following enumeration values: ['radians', 'degrees', 'gradians'] Returns ------- Any r_r)rrrrr_^szBarpolar.thetaunitcCs ||d<dS)Nr_r)rrrrrr_&^scCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7,^sz Barpolar.uidcCs ||d<dS)Nr7r)rrrrrr7<^scCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8B^szBarpolar.uirevisioncCs ||d<dS)Nr8r)rrrrrr8]^scCs|dS)a" The 'unselected' property is an instance of Unselected that may be specified as: - An instance of :class:`plotly.graph_objs.barpolar.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker :class:`plotly.graph_objects.barpolar.unselecte d.Marker` instance or dict with compatible properties textfont :class:`plotly.graph_objects.barpolar.unselecte d.Textfont` instance or dict with compatible properties Returns ------- plotly.graph_objs.barpolar.Unselected rr)rrrrrc^szBarpolar.unselectedcCs ||d<dS)Nrr)rrrrrr}^scCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr9^szBarpolar.visiblecCs ||d<dS)Nr9r)rrrrrr9^scCs|dS)aH Sets the bar angular width (in "thetaunit" units). The 'width' property is a number and may be specified as: - An int or float in the interval [0, inf] - A tuple, list, or one-dimensional numpy array of the above Returns ------- int|float|numpy.ndarray r:r)rrrrr:^s zBarpolar.widthcCs ||d<dS)Nr:r)rrrrrr:^scCs|dS)z Sets the source reference on plot.ly for width . The 'widthsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r;r)rrrrr;^s zBarpolar.widthsrccCs ||d<dS)Nr;r)rrrrrr;^scCs |jdS)NrD)rE)rrrrrD^sz Barpolar.typecCsdS)NrFr)rrrrrG^szBarpolar._parent_path_strcCsdS)Na" base Sets where the bar base is drawn (in radial axis units). In "stack" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead. basesrc Sets the source reference on plot.ly for base . customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dr Sets the r coordinate step. dtheta Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates. hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.barpolar.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.barpolar.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the angular position where the bar is drawn (in "thetatunit" units). offsetsrc Sets the source reference on plot.ly for offset . opacity Sets the opacity of the trace. r Sets the radial coordinates r0 Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.barpolar.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.barpolar.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates. textsrc Sets the source reference on plot.ly for text . theta Sets the angular coordinates theta0 Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. thetasrc Sets the source reference on plot.ly for theta . thetaunit Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.barpolar.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar angular width (in "thetaunit" units). widthsrc Sets the source reference on plot.ly for width . r)rrrrrH^s6zBarpolar._prop_descriptionsNc-1 stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|- dd|_ ddl m }.|.|jd<|.|jd <|.|jd <|.|jd <|.|jd <|.|jd <|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|.|jd<|. |jd<|.!|jd<|."|jd<|.#|jd<|.$|jd<|.%|jd<|.&|jd<|.'|jd <|.(|jd!<|.)|jd"<|.*|jd#<|.+|jd$<|.,|jd%<|.-|jd&<|..|jd'<|./|jd(<|.0|jd)<|.1|jd*<|.2|jd+<|.3|jd,<|.4|jd-<|.5|jd.<|.6|jd/<|.7|jd0<|.8|jd1<|.9|jd2<| dd}/|dk r|n|/|d<| d d}/|dk r|n|/|d <| d d}/|dk r$|n|/|d <| d d}/|dk rF|n|/|d <| d d}/|dk rh|n|/|d <| d d}/|dk r|n|/|d <| dd}/|dk r|n|/|d<| dd}/| dk r| n|/|d<| dd}/| dk r| n|/|d<| dd}/| dk r| n|/|d<| dd}/| dk r4| n|/|d<| dd}/| dk rV| n|/|d<| dd}/|dk rx|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r"|n|/|d<| dd}/|dk rD|n|/|d<| dd}/|dk rf|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| dd}/|dk r|n|/|d<| d d}/|dk r|n|/|d <| d!d}/|dk r2|n|/|d!<| d"d}/|dk rT|n|/|d"<| d#d}/|dk rv|n|/|d#<| d$d}/|dk r|n|/|d$<| d%d}/|dk r|n|/|d%<| d&d}/| dk r| n|/|d&<| d'd}/|!dk r|!n|/|d'<| d(d}/|"dk r |"n|/|d(<| d)d}/|#dk rB|#n|/|d)<| d*d}/|$dk rd|$n|/|d*<| d+d}/|%dk r|%n|/|d+<| d,d}/|&dk r|&n|/|d,<| d-d}/|'dk r|'n|/|d-<| d.d}/|(dk r|(n|/|d.<| d/d}/|)dk r|)n|/|d/<| d0d}/|*dk r0|*n|/|d0<| d1d}/|+dk rR|+n|/|d1<| d2d}/|,dk rt|,n|/|d2<dd3l:m;}0d|j` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Same as `text`. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.barpolar.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the angular position where the bar is drawn (in "thetatunit" units). offsetsrc Sets the source reference on plot.ly for offset . opacity Sets the opacity of the trace. r Sets the radial coordinates r0 Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.barpolar.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.barpolar.Stream` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on. text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates. textsrc Sets the source reference on plot.ly for text . theta Sets the angular coordinates theta0 Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step. thetasrc Sets the source reference on plot.ly for theta . thetaunit Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes. uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.barpolar.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar angular width (in "thetaunit" units). widthsrc Sets the source reference on plot.ly for width . Returns ------- Barpolar barpolarNzThe first argument to the plotly.graph_objs.Barpolar constructor must be a dict or an instance of :class:`plotly.graph_objs.Barpolar`rJFr)rr rr rrWrXrrrrrrrrrrrr!r"r#r$r&r'rYrZr[rr*r+r,rLr-r3r\r]r^r_r7r8rr9r:r;)rKrD)rLrMr)>rNrrOrPrQrRrSrTrUrVrWrXrYrr\r[BasesrcValidatorr`rararbrerfrgrhrirjrkrlrmrqrrrrsrtrurwrxrcrdrerr{r|r}rUr~rrfrgrhrirrrrrrrrKrEr)1rrr rr rrWrXrrrrrrrrrrrr!r"r#r$r&r'rYrZr[rr*r+r,rLr-r3r\r]r^r_r7r8rr9r:r;rZ v_barpolarrrK)rQrrrO_s(s                                                   zBarpolar.__init__),NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)5rrrrr rrr rrWrXrrrrrrrrrrrr!r"r#r$r&r'rYrZr[rr*r+r,rLr-r3r\r]r^r_r7r8rr9r:r;rDrGrHrOrrr)rQrrZZs          5 #       q                             :rcBseZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZejdEdDZedFdGZejdHdGZedIdJZejdKdJZedLdMZejdNdMZedOdPZejdQdPZedRdSZ e jdTdSZ edUdVZ!e!jdWdVZ!edXdYZ"e"jdZdYZ"ed[d\Z#e#jd]d\Z#ed^d_Z$e$jd`d_Z$edadbZ%e%jdcdbZ%edddeZ&e&jdfdeZ&edgdhZ'e'jdidhZ'edjdkZ(e(jdldkZ(edmdnZ)e)jdodnZ)edpdqZ*e*jdrdqZ*edsdtZ+e+jdudtZ+edvdwZ,e,jdxdwZ,edydzZ-e-jd{dzZ-ed|d}Z.e.jd~d}Z.eddZ/e/jddZ/eddZ0e0jddZ0eddZ1e1jddZ1eddZ2e2jddZ2eddZ3e3jddZ3eddZ4e4jddZ4eddZ5e5jddZ5eddZ6e6jddZ6eddZ7e7jddZ7eddZ8e8jddZ8eddZ9e9jddZ9eddZ:e:jddZ:eddZ;e;jddZ;eddZe>jddZ>eddZ?e?jddZ?eddZ@e@jddZ@eddZAeAjddZAeddZBeBjddZBeddZCeCjddZCeddZDeDjddZDedd„ZEeEjdd„ZEeddńZFeddDŽZGeddɄZHd͇fdd̄ ZIZJS)BarcCs|dS)a Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. The 'alignmentgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrr6aszBar.alignmentgroupcCs ||d<dS)Nrr)rrrrrrGascCs|dS)aB Sets where the bar base is drawn (in position axis units). In "stack" or "relative" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead. The 'base' property accepts values of any type Returns ------- Any|numpy.ndarray r r)rrrrr Mas zBar.basecCs ||d<dS)Nr r)rrrrrr \ascCs|dS)z Sets the source reference on plot.ly for base . The 'basesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrbas z Bar.basesrccCs ||d<dS)Nrr)rrrrrrpascCs|dS)a} Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. The 'cliponaxis' property must be specified as a bool (either True, or False) Returns ------- bool r r)rrrrr vaszBar.cliponaxiscCs ||d<dS)Nr r)rrrrrr ascCs|dS)a_ Constrain the size of text inside or outside a bar to be no larger than the bar itself. The 'constraintext' property is an enumeration that may be specified as: - One of the following enumeration values: ['inside', 'outside', 'both', 'none'] Returns ------- Any r r)rrrrr aszBar.constraintextcCs ||d<dS)Nr r)rrrrrr ascCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr aszBar.customdatacCs ||d<dS)Nr r)rrrrrr ascCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrras zBar.customdatasrccCs ||d<dS)Nrr)rrrrrrascCs|dS)z Sets the x coordinate step. See `x0` for more info. The 'dx' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrras zBar.dxcCs ||d<dS)Nrr)rrrrrrascCs|dS)z Sets the y coordinate step. See `y0` for more info. The 'dy' property is a number and may be specified as: - An int or float Returns ------- int|float rr)rrrrras zBar.dycCs ||d<dS)Nrr)rrrrrrascCs|dS)a The 'error_x' property is an instance of ErrorX that may be specified as: - An instance of :class:`plotly.graph_objs.bar.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. copy_ystyle symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.bar.ErrorX ryr)rrrrryasIz Bar.error_xcCs ||d<dS)Nryr)rrrrrryAbscCs|dS)a The 'error_y' property is an instance of ErrorY that may be specified as: - An instance of :class:`plotly.graph_objs.bar.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor Supported dict properties: array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. arrayminus Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. arrayminussrc Sets the source reference on plot.ly for arrayminus . arraysrc Sets the source reference on plot.ly for array . color Sets the stoke color of the error bars. symmetric Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. thickness Sets the thickness (in px) of the error bars. traceref tracerefminus type Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`. value Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. valueminus Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars visible Determines whether or not this set of error bars is visible. width Sets the width (in px) of the cross-bar at both ends of the error bars. Returns ------- plotly.graph_objs.bar.ErrorY rzr)rrrrrzGbsGz Bar.error_ycCs ||d<dS)Nrzr)rrrrrrzbscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrrbsz Bar.hoverinfocCs ||d<dS)Nrr)rrrrrrbscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrbs zBar.hoverinfosrccCs ||d<dS)Nrr)rrrrrrbscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.bar.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.bar.Hoverlabel rr)rrrrrbs3zBar.hoverlabelcCs ||d<dS)Nrr)rrrrrrbscCs|dS)a< Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time- format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per- point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrrbs!zBar.hovertemplatecCs ||d<dS)Nrr)rrrrrr"cscCs|dS)z Sets the source reference on plot.ly for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr(cs zBar.hovertemplatesrccCs ||d<dS)Nrr)rrrrrr6cscCs|dS)ab Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. The 'hovertext' property is a string and must be specified as: - A string - A number that will be converted to a string - A tuple, list, or one-dimensional numpy array of the above Returns ------- str|numpy.ndarray rr)rrrrr= 1 (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- str r>r)rrrrr>gsz Bar.xaxiscCs ||d<dS)Nr>r)rrrrrr>gscCs|dS)a Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrgsz Bar.xcalendarcCs ||d<dS)Nrr)rrrrrrgscCs|dS)z Sets the source reference on plot.ly for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r?r)rrrrr?gs zBar.xsrccCs ||d<dS)Nr?r)rrrrrr?gscCs|dS)z Sets the y coordinates. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r@r)rrrrr@hs zBar.ycCs ||d<dS)Nr@r)rrrrrr@hscCs|dS)a  Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. The 'y0' property accepts values of any type Returns ------- Any rAr)rrrrrAhs zBar.y0cCs ||d<dS)NrAr)rrrrrrA&hscCs|dS)a Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular subplot, of type 'y', that may be specified as the string 'y' optionally followed by an integer >= 1 (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- str rBr)rrrrrB,hsz Bar.yaxiscCs ||d<dS)NrBr)rrrrrrB?hscCs|dS)a Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any rr)rrrrrEhsz Bar.ycalendarcCs ||d<dS)Nrr)rrrrrrWhscCs|dS)z Sets the source reference on plot.ly for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rCr)rrrrrC]hs zBar.ysrccCs ||d<dS)NrCr)rrrrrrCkhscCs |jdS)NrD)rE)rrrrrDqhszBar.typecCsdS)NrFr)rrrrrGwhszBar._parent_path_strcCsdS)Na5 alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. base Sets where the bar base is drawn (in position axis units). In "stack" or "relative" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead. basesrc Sets the source reference on plot.ly for base . cliponaxis Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. error_x :class:`plotly.graph_objects.bar.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.bar.ErrorY` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.bar.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. insidetextfont Sets the font used for `text` lying inside the bar. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.bar.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. offsetsrc Sets the source reference on plot.ly for offset . opacity Sets the opacity of the trace. orientation Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). outsidetextfont Sets the font used for `text` lying outside the bar. r r coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the radial coordinatesfor legacy polar chart only. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.bar.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.bar.Stream` instance or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the angular coordinatesfor legacy polar chart only. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textangle Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. textfont Sets the font used for `text`. textposition Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . tsrc Sets the source reference on plot.ly for t . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.bar.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar width (in position axis units). widthsrc Sets the source reference on plot.ly for width . x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . r)rrrrrH}hszBar._prop_descriptionsNcCG s tt|d|dkri}n4t||jr4|}nt|trJt|}nt d|C dd|_ ddl m }D|D|jd<|D|jd <|D|jd <|D|jd <|D|jd <|D|jd <|D|jd<|D|jd<|D|jd<|D|jd<|D|jd<|D|jd<|D|jd<|D|jd<|D|jd<|D|jd<|D|jd<|D |jd<|D!|jd<|D"|jd<|D#|jd<|D$|jd<|D%|jd<|D&|jd<|D'|jd <|D(|jd!<|D)|jd"<|D*|jd#<|D+|jd$<|D,|jd%<|D-|jd&<|D.|jd'<|D/|jd(<|D0|jd)<|D1|jd*<|D2|jd+<|D3|jd,<|D4|jd-<|D5|jd.<|D6|jd/<|D7|jd0<|D8|jd1<|D9|jd2<|D:|jd3<|D;|jd4<|D<|jd5<|D=|jd6<|D>|jd7<|D?|jd8<|D@|jd9<|DA|jd:<|DB|jd;<|DC|jd<<|DD|jd=<|DE|jd><|DF|jd?<|DG|jd@<|DH|jdA<|DI|jdB<|DJ|jdC<|DK|jdD<|DL|jdE<|DM|jdF<|DN|jdG<|DO|jdH<| dd}E|dk r|n|E|d<| d d}E|dk r6|n|E|d <| d d}E|dk rX|n|E|d <| d d}E|dk rz|n|E|d <| d d}E|dk r|n|E|d <| d d}E|dk r|n|E|d <| dd}E|dk r|n|E|d<| dd}E| dk r| n|E|d<| dd}E| dk r$| n|E|d<| dd}E| dk rF| n|E|d<| dd}E| dk rh| n|E|d<| dd}E| dk r| n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r4|n|E|d<| dd}E|dk rV|n|E|d<| dd}E|dk rx|n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r|n|E|d<| dd}E|dk r"|n|E|d<| d d}E|dk rD|n|E|d <| d!d}E|dk rf|n|E|d!<| d"d}E|dk r|n|E|d"<| d#d}E|dk r|n|E|d#<| d$d}E|dk r|n|E|d$<| d%d}E|dk r|n|E|d%<| d&d}E| dk r| n|E|d&<| d'd}E|!dk r2|!n|E|d'<| d(d}E|"dk rT|"n|E|d(<| d)d}E|#dk rv|#n|E|d)<| d*d}E|$dk r|$n|E|d*<| d+d}E|%dk r|%n|E|d+<| d,d}E|&dk r|&n|E|d,<| d-d}E|'dk r|'n|E|d-<| d.d}E|(dk r |(n|E|d.<| d/d}E|)dk rB|)n|E|d/<| d0d}E|*dk rd|*n|E|d0<| d1d}E|+dk r|+n|E|d1<| d2d}E|,dk r|,n|E|d2<| d3d}E|-dk r|-n|E|d3<| d4d}E|.dk r|.n|E|d4<| d5d}E|/dk r|/n|E|d5<| d6d}E|0dk r0|0n|E|d6<| d7d}E|1dk rR|1n|E|d7<| d8d}E|2dk rt|2n|E|d8<| d9d}E|3dk r|3n|E|d9<| d:d}E|4dk r|4n|E|d:<| d;d}E|5dk r|5n|E|d;<| dd}E|8dk r@|8n|E|d><| d?d}E|9dk rb|9n|E|d?<| d@d}E|:dk r|:n|E|d@<| dAd}E|;dk r|;n|E|dA<| dBd}E|dk r |>n|E|dD<| dEd}E|?dk r.|?n|E|dE<| dFd}E|@dk rP|@n|E|dF<| dGd}E|Adk rr|An|E|dG<| dHd}E|Bdk r|Bn|E|dH<ddIlPmQ}Fd|jRdJ<|FdJdddK|jdJ<| dJd|jSft|f|Cd|_ dS)La7 Construct a new Bar object The data visualized by the span of the bars is set in `y` if `orientation` is set th "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged. Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Bar` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently. base Sets where the bar base is drawn (in position axis units). In "stack" or "relative" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead. basesrc Sets the source reference on plot.ly for base . cliponaxis Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . dx Sets the x coordinate step. See `x0` for more info. dy Sets the y coordinate step. See `y0` for more info. error_x :class:`plotly.graph_objects.bar.ErrorX` instance or dict with compatible properties error_y :class:`plotly.graph_objects.bar.ErrorY` instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.bar.Hoverlabel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. hovertemplatesrc Sets the source reference on plot.ly for hovertemplate . hovertext Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag. hovertextsrc Sets the source reference on plot.ly for hovertext . ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. insidetextfont Sets the font used for `text` lying inside the bar. legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.bar.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. offset Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead. offsetgroup Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up. offsetsrc Sets the source reference on plot.ly for offset . opacity Sets the opacity of the trace. orientation Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). outsidetextfont Sets the font used for `text` lying outside the bar. r r coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the radial coordinatesfor legacy polar chart only. rsrc Sets the source reference on plot.ly for r . selected :class:`plotly.graph_objects.bar.Selected` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.bar.Stream` instance or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the angular coordinatesfor legacy polar chart only. text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels. textangle Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars. textfont Sets the font used for `text`. textposition Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. textpositionsrc Sets the source reference on plot.ly for textposition . textsrc Sets the source reference on plot.ly for text . texttemplate Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time- format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. texttemplatesrc Sets the source reference on plot.ly for texttemplate . tsrc Sets the source reference on plot.ly for t . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected :class:`plotly.graph_objects.bar.Unselected` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). width Sets the bar width (in position axis units). widthsrc Sets the source reference on plot.ly for width . x Sets the x coordinates. x0 Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step. xaxis Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xcalendar Sets the calendar system to use with `x` date data. xsrc Sets the source reference on plot.ly for x . y Sets the y coordinates. y0 Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step. yaxis Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ycalendar Sets the calendar system to use with `y` date data. ysrc Sets the source reference on plot.ly for y . Returns ------- Bar barNz}The first argument to the plotly.graph_objs.Bar constructor must be a dict or an instance of :class:`plotly.graph_objs.Bar`rJFr)rrr rr r r rrrryrzrrrrrrrrrrrrrr!r"r#r$r%r&r'r(r)rYr[rr*r+r,rr-r.r/r1r2r3r4r5rr7r8rr9r:r;r<r=r>rr?r@rArBrrC)rKrD)rLrMr)TrNrrOrPrQrRrSrTrUrVrWrXrYrrZr[r\rr]r_r`rarcrdr|r}rerfrgrhrirjrkrlrmrorprqrrrrsrtrurvrwrxryrzrcrerr{r|r}rr~rrrrrrrrrrrrrrrrrrrrrrrrrrKrEr)Grrrr rr r r rrrryrzrrrrrrrrrrrrrr!r"r#r$r%r&r'r(r)rYr[rr*r+r,rr-r.r/r1r2r3r4r5rr7r8rr9r:r;r<r=r>rr?r@rArBrrCrZv_barrrK)rQrrrOisr                                                                         z Bar.__init__)BNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)Krrrrrrr rr r r rrrryrzrrrrrrrrrrrrrr!r"r#r$r%r&r'r(r)rYr[rr*r+r,rr-r.r/r1r2r3r4r5rr7r8rr9r:r;r<r=r>rr?r@rArBrrCrDrGrHrOrrr)rQrr2as          K I   5 #       1  p         1          1                         !rcs~eZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2Zed4d5Zejd6d5Zed7d8Zejd9d8Zed:d;ZejdZejd?d>Zed@dAZejdBdAZedCdDZedEdFZedGdHZdLfdJdK ZZS)MAreacCs|dS)a Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray r r)rrrrr lszArea.customdatacCs ||d<dS)Nr r)rrrrrr lscCs|dS)z Sets the source reference on plot.ly for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrr#ls zArea.customdatasrccCs ||d<dS)Nrr)rrrrrr1lscCs|dS)a` Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - A list or array of the above Returns ------- Any|numpy.ndarray rr)rrrrr7lszArea.hoverinfocCs ||d<dS)Nrr)rrrrrrKlscCs|dS)z Sets the source reference on plot.ly for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrQls zArea.hoverinfosrccCs ||d<dS)Nrr)rrrrrr_lscCs|dS)a The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.area.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines alignsrc Sets the source reference on plot.ly for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.area.Hoverlabel rr)rrrrrels3zArea.hoverlabelcCs ||d<dS)Nrr)rrrrrrlscCs|dS)aq Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrlszArea.idscCs ||d<dS)Nrr)rrrrrrlscCs|dS)z Sets the source reference on plot.ly for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrls z Area.idssrccCs ||d<dS)Nrr)rrrrrrlscCs|dS)ak Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str rr)rrrrrlszArea.legendgroupcCs ||d<dS)Nrr)rrrrrrlscCs|dS)ae The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.area.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: color Area traces are deprecated! Please switch to the "barpolar" trace type. Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. colorsrc Sets the source reference on plot.ly for color . opacity Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the marker opacity. opacitysrc Sets the source reference on plot.ly for opacity . size Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the marker size (in px). sizesrc Sets the source reference on plot.ly for size . symbol Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name. symbolsrc Sets the source reference on plot.ly for symbol . Returns ------- plotly.graph_objs.area.Marker rr)rrrrrls4z Area.markercCs ||d<dS)Nrr)rrrrrrmscCs|dS)a  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!msz Area.metacCs ||d<dS)Nr!r)rrrrrr!3mscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"9ms z Area.metasrccCs ||d<dS)Nr"r)rrrrrr"GmscCs|dS)a& Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#Mmsz Area.namecCs ||d<dS)Nr#r)rrrrrr#]mscCs|dS)z Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float r'r)rrrrr'cms z Area.opacitycCs ||d<dS)Nr'r)rrrrrr'qmscCs|dS)aQ Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the radial coordinates for legacy polar chart only. The 'r' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rYr)rrrrrYwmszArea.rcCs ||d<dS)NrYr)rrrrrrYmscCs|dS)z Sets the source reference on plot.ly for r . The 'rsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r[r)rrrrr[ms z Area.rsrccCs ||d<dS)Nr[r)rrrrrr[mscCs|dS)a Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr+ms zArea.showlegendcCs ||d<dS)Nr+r)rrrrrr+mscCs|dS)ab The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.area.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, only the newest 50 points will be displayed on the plot. token The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details. Returns ------- plotly.graph_objs.area.Stream r,r)rrrrr,msz Area.streamcCs ||d<dS)Nr,r)rrrrrr,mscCs|dS)aR Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for legacy polar chart only. The 't' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray rr)rrrrrmszArea.tcCs ||d<dS)Nrr)rrrrrrmscCs|dS)z Sets the source reference on plot.ly for t . The 'tsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rr)rrrrrms z Area.tsrccCs ||d<dS)Nrr)rrrrrrmscCs|dS)aL Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r7r)rrrrr7nszArea.uidcCs ||d<dS)Nr7r)rrrrrr7nscCs|dS)aR Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8nszArea.uirevisioncCs ||d<dS)Nr8r)rrrrrr82nscCs|dS)a Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration values: [True, False, 'legendonly'] Returns ------- Any r9r)rrrrr98nsz Area.visiblecCs ||d<dS)Nr9r)rrrrrr9InscCs |jdS)NrD)rE)rrrrrDOnsz Area.typecCsdS)NrFr)rrrrrGUnszArea._parent_path_strcCsdS)Na customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.area.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.area.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. r Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the radial coordinates for legacy polar chart only. rsrc Sets the source reference on plot.ly for r . showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.area.Stream` instance or dict with compatible properties t Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for legacy polar chart only. tsrc Sets the source reference on plot.ly for t . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). r)rrrrrH[nsbzArea._prop_descriptionsNc stt|d|dkri}n4t||jr4|}nt|trJt|}nt d| dd|_ ddl m }||jd<||jd <||jd <||jd <||jd <||jd <||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<||jd<| |jd<|!|jd<|"|jd<|#|jd<|$|jd<| dd}|dk r|n||d<| d d}|dk r|n||d <| d d}|dk r|n||d <| d d}|dk r |n||d <| d d}|dk rB|n||d <| d d}|dk rd|n||d <| dd}|dk r|n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r| n||d<| dd}| dk r0| n||d<| dd}|dk rR|n||d<| dd}|dk rt|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r|n||d<| dd}|dk r@|n||d<| dd}|dk rb|n||d<| dd}|dk r|n||d<ddl%m&}d|j'd<|dddd |jd<| dd|j(ft|f|d|_ dS)!a Construct a new Area object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Area` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements customdatasrc Sets the source reference on plot.ly for customdata . hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel :class:`plotly.graph_objects.area.Hoverlabel` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. idssrc Sets the source reference on plot.ly for ids . legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. marker :class:`plotly.graph_objects.area.Marker` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index. metasrc Sets the source reference on plot.ly for meta . name Sets the trace name. The trace name appear as the legend item and on hover. opacity Sets the opacity of the trace. r Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the radial coordinates for legacy polar chart only. rsrc Sets the source reference on plot.ly for r . showlegend Determines whether or not an item corresponding to this trace is shown in the legend. stream :class:`plotly.graph_objects.area.Stream` instance or dict with compatible properties t Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for legacy polar chart only. tsrc Sets the source reference on plot.ly for t . uid Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. uirevision Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Returns ------- Area areaNzThe first argument to the plotly.graph_objs.Area constructor must be a dict or an instance of :class:`plotly.graph_objs.Area`rJFr)rr rrrrrrrrr!r"r#r'rYr[r+r,rrr7r8r9)rKrD)rLrMr))rNrrOrPrQrRrSrTrUrVrWrXrYrr`r[rarerfrgrlrmrqrrrrsrtrxrcrer|r}rrrrrrrKrEr)rrr rrrrrrrrr!r"r#r'rYr[r+r,rrr7r8r9rZv_arearrK)rQrrrOns                              z Area.__init__)NNNNNNNNNNNNNNNNNNNNNNN) rrrrr rrrrrrrrrr!r"r#r'rYr[r+r,rrr7r8r9rDrGrHrOrrr)rQrrls     5    6                fr)BaseLayoutTypecSs eZdZddddddddgZd d lZed d ed ZeddZ ddZ eddZ e j ddZ eddZ e j ddZ eddZej ddZeddZej ddZeddZej d dZed!d"Zej d#d"Zed$d%Zej d&d%Zed'd(Zej d)d(Zed*d+Zej d,d+Zed-d.Zej d/d.Zed0d1Zej d2d1Zed3d4Zej d5d4Zed6d7Zej d8d7Zed9d:Zej d;d:Zedd=Zed?d@Zej dAd@ZedBdCZej dDdCZedEdFZej dGdFZedHdIZej dJdIZedKdLZej dMdLZedNdOZ e j dPdOZ edQdRZ!e!j dSdRZ!edTdUZ"e"j dVdUZ"edWdXZ#e#j dYdXZ#edZd[Z$e$j d\d[Z$ed]d^Z%e%j d_d^Z%ed`daZ&e&j dbdaZ&edcddZ'e'j deddZ'edfdgZ(e(j dhdgZ(edidjZ)e)j dkdjZ)edldmZ*e*j dndmZ*edodpZ+e+j dqdpZ+edrdsZ,e,j dtdsZ,edudvZ-e-j dwdvZ-edxdyZ.e.j dzdyZ.ed{d|Z/e/j d}d|Z/ed~dZ0e0j ddZ0eddZ1e1j ddZ1eddZ2e2j ddZ2eddZ3e3j ddZ3eddZ4e4j ddZ4eddZ5e5j ddZ5eddZ6e6j ddZ6eddZ7e7j ddZ7eddZ8e8j ddZ8eddZ9e9j ddZ9eddZ:e:j ddZ:eddZ;e;j ddZ;eddZe>j ddZ>eddZ?e?j ddZ?eddZ@e@j ddZ@eddZAeAj ddZAeddZBeBj ddZBeddZCeCj ddZCeddZDeDj ddZDeddZEeEj ddZEeddZFeFj ddZFeddĄZGeGj ddĄZGeddDŽZHeHj ddDŽZHeddʄZIeIj ddʄZIedd̈́ZJeJj dd̈́ZJeddЄZKeKj ddЄZKeddӄZLeLj ddӄZLeddքZMeMj ddքZMeddلZNeNj ddلZNedd܄ZOeOj dd܄ZOedd߄ZPePj dd߄ZPeddZQeQj ddZQeddZReRj ddZReddZSeSj ddZSeddZTeTj ddZTeddZUeUj ddZUeddZVeVj ddZVeddZWeWj ddZWeddZXeXj ddZXeddZYeYj ddZYeddZZeZj ddZZeddZ[e[j ddZ[eddZ\e\j ddZ\eddZ]e]j ddZ]edd Z^ed d Z_d d iZ`dfdd ZaZbS(Layoutrrmapboxpolarrternaryr>rBrNz^(|z)(\d+)$c Cs>ddlm}m}m}m}m}m}m}m}||||||||dS)zo dict of validator classes for each subplot type Returns ------- dict r)rrMapboxValidatorPolarValidatorrTernaryValidatorrr)rrrrrrr>rB) Zplotly.validators.layoutrrrrrrrr) rrrrrrrrrrrr_subplotid_validatorsos ( zLayout._subplotid_validatorscCs |j|S)N)_subplotid_prop_rematch)rproprrr_subplot_re_matchoszLayout._subplot_re_matchcCs|dS)a The 'angularaxis' property is an instance of AngularAxis that may be specified as: - An instance of :class:`plotly.graph_objs.layout.AngularAxis` - A dict of string/value properties that will be passed to the AngularAxis constructor Supported dict properties: domain Polar chart subplots are not supported yet. This key has currently no effect. endpadding Legacy polar charts are deprecated! Please switch to "polar" subplots. range Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this angular axis. showline Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the line bounding this angular axis will be shown on the figure. showticklabels Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the angular axis ticks will feature tick labels. tickcolor Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the color of the tick lines on this angular axis. ticklen Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this angular axis. tickorientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (from the paper perspective) of the angular axis tick labels. ticksuffix Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this angular axis. visible Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not this axis will be visible. Returns ------- plotly.graph_objs.layout.AngularAxis angularaxisr)rrrrros9zLayout.angularaxiscCs ||d<dS)Nrr)rrrrrr/pscCs|dS)a9 The 'annotations' property is a tuple of instances of Annotation that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.Annotation - A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor Supported dict properties: align Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more
HTML tags) or if an explicit width is set to override the text width. arrowcolor Sets the color of the annotation arrow. arrowhead Sets the end annotation arrow head style. arrowside Sets the annotation arrow head position. arrowsize Sets the size of the end annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line. arrowwidth Sets the width (in px) of annotation arrow line. ax Sets the x component of the arrow tail about the arrow head. If `axref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If `axref` is an axis, this is an absolute value on that axis, like `x`, NOT a relative value. axref Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ax` is a relative offset in pixels from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed. ay Sets the y component of the arrow tail about the arrow head. If `ayref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If `ayref` is an axis, this is an absolute value on that axis, like `y`, NOT a relative value. ayref Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ay` is a relative offset in pixels from `y`. If set to a y axis id (e.g. "y" or "y2"), `ay` is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed. bgcolor Sets the background color of the annotation. bordercolor Sets the color of the border enclosing the annotation `text`. borderpad Sets the padding (in px) between the `text` and the enclosing border. borderwidth Sets the width (in px) of the border enclosing the annotation `text`. captureevents Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default `captureevents` is False unless `hovertext` is provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`. clicktoshow Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the `x` and `y` values of this annotation, and it is hidden (visible: false), it will appear. In "onoff" mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In "onout" mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different `x` or `y` values, you can set `xclick` and/or `yclick`. This is useful for example to label the side of a bar. To label markers though, `standoff` is preferred over `xclick` and `yclick`. font Sets the annotation text font. height Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped. hoverlabel :class:`plotly.graph_objects.layout.annotation. Hoverlabel` instance or dict with compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. name When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. opacity Sets the opacity of the annotation (text + arrow). showarrow Determines whether or not the annotation is drawn with an arrow. If True, `text` is placed near the arrow's tail. If False, `text` lines up with the `x` and `y` provided. standoff Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount. startarrowhead Sets the start annotation arrow head style. startarrowsize Sets the size of the start annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line. startstandoff Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount. templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. text Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (
), bold (), italics (), hyperlinks (). Tags , , are also supported. textangle Sets the angle at which the `text` is drawn with respect to the horizontal. valign Sets the vertical alignment of the `text` within the box. Has an effect only if an explicit height is set to override the text height. visible Determines whether or not this annotation is visible. width Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use
to start a new line. x Sets the annotation's x position. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. xanchor Sets the text box's horizontal position anchor This anchor binds the `x` position to the "left", "center" or "right" of the annotation. For example, if `x` is set to 1, `xref` to "paper" and `xanchor` to "right" then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If "auto", the anchor is equivalent to "center" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side. xclick Toggle this annotation when clicking a data point whose `x` value is `xclick` rather than the annotation's `x` value. xref Sets the annotation's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side. xshift Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels. y Sets the annotation's y position. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. yanchor Sets the text box's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the annotation. For example, if `y` is set to 1, `yref` to "paper" and `yanchor` to "top" then the top- most portion of the annotation lines up with the top-most edge of the plotting area. If "auto", the anchor is equivalent to "middle" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side. yclick Toggle this annotation when clicking a data point whose `y` value is `yclick` rather than the annotation's `y` value. yref Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an y coordinate If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). yshift Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels. Returns ------- tuple[plotly.graph_objs.layout.Annotation] annotationsr)rrrrr5pszLayout.annotationscCs ||d<dS)Nrr)rrrrrrLqscCs|dS)aO When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations The 'annotationdefaults' property is an instance of Annotation that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Annotation` - A dict of string/value properties that will be passed to the Annotation constructor Supported dict properties: Returns ------- plotly.graph_objs.layout.Annotation annotationdefaultsr)rrrrrRqszLayout.annotationdefaultscCs ||d<dS)Nrr)rrrrrrgqscCs|dS)a Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot. The 'autosize' property must be specified as a bool (either True, or False) Returns ------- bool autosizer)rrrrrmqszLayout.autosizecCs ||d<dS)Nrr)rrrrrrqscCs|dS)a Sets the gap (in plot fraction) between bars of adjacent location coordinates. The 'bargap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float bargapr)rrrrrqs z Layout.bargapcCs ||d<dS)Nrr)rrrrrrqscCs|dS)a Sets the gap (in plot fraction) between bars of the same location coordinate. The 'bargroupgap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float bargroupgapr)rrrrrqs zLayout.bargroupgapcCs ||d<dS)Nrr)rrrrrrqscCs|dS)a Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. The 'barmode' property is an enumeration that may be specified as: - One of the following enumeration values: ['stack', 'group', 'overlay', 'relative'] Returns ------- Any barmoder)rrrrrqszLayout.barmodecCs ||d<dS)Nrr)rrrrrrqscCs|dS)a Sets the normalization for bar traces on the graph. With "fraction", the value of each bar is divided by the sum of all values at that location coordinate. "percent" is the same but multiplied by 100 to show percentages. The 'barnorm' property is an enumeration that may be specified as: - One of the following enumeration values: ['', 'fraction', 'percent'] Returns ------- Any barnormr)rrrrrqszLayout.barnormcCs ||d<dS)Nrr)rrrrrrqscCs|dS)aN Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set. The 'boxgap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float boxgapr)rrrrrqsz Layout.boxgapcCs ||d<dS)Nrr)rrrrrrqscCs|dS)aR Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set. The 'boxgroupgap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float boxgroupgapr)rrrrrqszLayout.boxgroupgapcCs ||d<dS)Nrr)rrrrrr rscCs|dS)a] Determines how boxes at the same location coordinate are displayed on the graph. If "group", the boxes are plotted next to one another centered around the shared location. If "overlay", the boxes are plotted over one another, you might need to set "opacity" to see them multiple boxes. Has no effect on traces that have "width" set. The 'boxmode' property is an enumeration that may be specified as: - One of the following enumeration values: ['group', 'overlay'] Returns ------- Any boxmoder)rrrrrrszLayout.boxmodecCs ||d<dS)Nrr)rrrrrr#rscCs|dS)a  Sets the default calendar system to use for interpreting and displaying dates throughout the plot. The 'calendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', 'thai', 'ummalqura'] Returns ------- Any calendarr)rrrrr)rszLayout.calendarcCs ||d<dS)Nrr)rrrrrr3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. Returns ------- plotly.graph_objs.layout.Hoverlabel rr)rrrrrus(zLayout.hoverlabelcCs ||d<dS)Nrr)rrrrrruscCs|dS)a` Determines the mode of hover interactions. If `clickmode` includes the "select" flag, `hovermode` defaults to "closest". If `clickmode` lacks the "select" flag, it defaults to "x" or "y" (depending on the trace's `orientation` value) for plots based on cartesian coordinates. For anything else the default value is "closest". The 'hovermode' property is an enumeration that may be specified as: - One of the following enumeration values: ['x', 'y', 'closest', False] Returns ------- Any hovermoder)rrrrruszLayout.hovermodecCs ||d<dS)Nrr)rrrrrruscCs|dS)a The 'images' property is a tuple of instances of Image that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.Image - A list or tuple of dicts of string/value properties that will be passed to the Image constructor Supported dict properties: layer Specifies whether images are drawn below or above traces. When `xref` and `yref` are both set to `paper`, image is drawn below the entire plot area. name When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. opacity Sets the opacity of the image. sizex Sets the image container size horizontally. The image will be sized based on the `position` value. When `xref` is set to `paper`, units are sized relative to the plot width. sizey Sets the image container size vertically. The image will be sized based on the `position` value. When `yref` is set to `paper`, units are sized relative to the plot height. sizing Specifies which dimension of the image to constrain. source Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute. templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. visible Determines whether or not this image is visible. x Sets the image's x position. When `xref` is set to `paper`, units are sized relative to the plot height. See `xref` for more info xanchor Sets the anchor for the x position xref Sets the images's x coordinate axis. If set to a x axis id (e.g. "x" or "x2"), the `x` position refers to an x data coordinate If set to "paper", the `x` position refers to the distance from the left of plot in normalized coordinates where 0 (1) corresponds to the left (right). y Sets the image's y position. When `yref` is set to `paper`, units are sized relative to the plot height. See `yref` for more info yanchor Sets the anchor for the y position. yref Sets the images's y coordinate axis. If set to a y axis id (e.g. "y" or "y2"), the `y` position refers to a y data coordinate. If set to "paper", the `y` position refers to the distance from the bottom of the plot in normalized coordinates where 0 (1) corresponds to the bottom (top). Returns ------- tuple[plotly.graph_objs.layout.Image] imagesr)rrrrrus]z Layout.imagescCs ||d<dS)Nrr)rrrrrr- uirevision Controls persistence of user-driven changes in the view: `center`, `zoom`, `bearing`, `pitch`. Defaults to `layout.uirevision`. zoom Sets the zoom level of the map (mapbox.zoom). Returns ------- plotly.graph_objs.layout.Mapbox rr)rrrrrvsRz Layout.mapboxcCs ||d<dS)Nrr)rrrrrrwscCs|dS)aC The 'margin' property is an instance of Margin that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Margin` - A dict of string/value properties that will be passed to the Margin constructor Supported dict properties: autoexpand Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults. b Sets the bottom margin (in px). l Sets the left margin (in px). pad Sets the amount of padding (in px) between the plotting area and the axis lines r Sets the right margin (in px). t Sets the top margin (in px). Returns ------- plotly.graph_objs.layout.Margin marginr)rrrrr$ws z Layout.margincCs ||d<dS)Nrr)rrrrrrFwscCs|dS)a Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}. The 'meta' property accepts values of any type Returns ------- Any|numpy.ndarray r!r)rrrrr!Lwsz Layout.metacCs ||d<dS)Nr!r)rrrrrr!`wscCs|dS)z Sets the source reference on plot.ly for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r"r)rrrrr"fws zLayout.metasrccCs ||d<dS)Nr"r)rrrrrr"twscCs|dS)ac The 'modebar' property is an instance of Modebar that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Modebar` - A dict of string/value properties that will be passed to the Modebar constructor Supported dict properties: activecolor Sets the color of the active or hovered on icons in the modebar. bgcolor Sets the background color of the modebar. color Sets the color of the icons in the modebar. orientation Sets the orientation of the modebar. uirevision Controls persistence of user-driven changes related to the modebar, including `hovermode`, `dragmode`, and `showspikes` at both the root level and inside subplots. Defaults to `layout.uirevision`. Returns ------- plotly.graph_objs.layout.Modebar modebarr)rrrrrzwszLayout.modebarcCs ||d<dS)Nrr)rrrrrrwscCs|dS)a Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire polar by the given angle in legacy polar charts. The 'orientation' property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90). Returns ------- int|float r(r)rrrrr(wszLayout.orientationcCs ||d<dS)Nr(r)rrrrrr(wscCs|dS)aE Sets the background color of the paper where the graph is drawn. The 'paper_bgcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str paper_bgcolorr)rrrrrws4zLayout.paper_bgcolorcCs ||d<dS)Nrr)rrrrrrwscCs|dS)a Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`. The 'piecolorway' property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings Returns ------- list piecolorwayr)rrrrrwszLayout.piecolorwaycCs ||d<dS)Nrr)rrrrrrxscCs|dS)aK Sets the background color of the plotting area in-between x and y axes. The 'plot_bgcolor' property is a color and may be specified as: - A hex string (e.g. '#ff0000') - An rgb/rgba string (e.g. 'rgb(255,0,0)') - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - A named CSS color: aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen Returns ------- str plot_bgcolorr)rrrrr xs4zLayout.plot_bgcolorcCs ||d<dS)Nrr)rrrrrrCxscCs|dS)a[ The 'polar' property is an instance of Polar that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Polar` - A dict of string/value properties that will be passed to the Polar constructor Supported dict properties: angularaxis :class:`plotly.graph_objects.layout.polar.Angul arAxis` instance or dict with compatible properties bargap Sets the gap between bars of adjacent location coordinates. Values are unitless, they represent fractions of the minimum difference in bar positions in the data. barmode Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. bgcolor Set the background color of the subplot domain :class:`plotly.graph_objects.layout.polar.Domai n` instance or dict with compatible properties gridshape Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale). hole Sets the fraction of the radius to cut out of the polar subplot. radialaxis :class:`plotly.graph_objects.layout.polar.Radia lAxis` instance or dict with compatible properties sector Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with 0 corresponding to rightmost limit of the polar subplot. uirevision Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`. Returns ------- plotly.graph_objs.layout.Polar rr)rrrrrIxs@z Layout.polarcCs ||d<dS)Nrr)rrrrrrxscCs|dS)a The 'radialaxis' property is an instance of RadialAxis that may be specified as: - An instance of :class:`plotly.graph_objs.layout.RadialAxis` - A dict of string/value properties that will be passed to the RadialAxis constructor Supported dict properties: domain Polar chart subplots are not supported yet. This key has currently no effect. endpadding Legacy polar charts are deprecated! Please switch to "polar" subplots. orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (an angle with respect to the origin) of the radial axis. range Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this radial axis. showline Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the line bounding this radial axis will be shown on the figure. showticklabels Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the radial axis ticks will feature tick labels. tickcolor Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the color of the tick lines on this radial axis. ticklen Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this radial axis. tickorientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (from the paper perspective) of the radial axis tick labels. ticksuffix Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this radial axis. visible Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not this axis will be visible. Returns ------- plotly.graph_objs.layout.RadialAxis radialaxisr)rrrrrxs>zLayout.radialaxiscCs ||d<dS)Nrr)rrrrrrxscCs|dS)a The 'scene' property is an instance of Scene that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Scene` - A dict of string/value properties that will be passed to the Scene constructor Supported dict properties: annotations A tuple of :class:`plotly.graph_objects.layout. scene.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as layout.template.lay out.scene.annotationdefaults), sets the default property values to use for elements of layout.scene.annotations aspectmode If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used. aspectratio Sets this scene's axis aspectratio. bgcolor camera :class:`plotly.graph_objects.layout.scene.Camer a` instance or dict with compatible properties domain :class:`plotly.graph_objects.layout.scene.Domai n` instance or dict with compatible properties dragmode Determines the mode of drag interactions for this scene. hovermode Determines the mode of hover interactions for this scene. uirevision Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`. xaxis :class:`plotly.graph_objects.layout.scene.XAxis ` instance or dict with compatible properties yaxis :class:`plotly.graph_objects.layout.scene.YAxis ` instance or dict with compatible properties zaxis :class:`plotly.graph_objects.layout.scene.ZAxis ` instance or dict with compatible properties Returns ------- plotly.graph_objs.layout.Scene rr)rrrrrxsCz Layout.scenecCs ||d<dS)Nrr)rrrrrryscCs|dS)a When "dragmode" is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit. The 'selectdirection' property is an enumeration that may be specified as: - One of the following enumeration values: ['h', 'v', 'd', 'any'] Returns ------- Any selectdirectionr)rrrrr"yszLayout.selectdirectioncCs ||d<dS)Nrr)rrrrrr4yscCs|dS)z Controls persistence of user-driven changes in selected points from all traces. The 'selectionrevision' property accepts values of any type Returns ------- Any selectionrevisionr)rrrrr:ys zLayout.selectionrevisioncCs ||d<dS)Nrr)rrrrrrHyscCs|dS)a Sets the decimal and thousand separators. For example, *. * puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default. The 'separators' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str separatorsr)rrrrrNyszLayout.separatorscCs ||d<dS)Nrr)rrrrrr`yscCs|dS)aY" The 'shapes' property is a tuple of instances of Shape that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.Shape - A list or tuple of dicts of string/value properties that will be passed to the Shape constructor Supported dict properties: fillcolor Sets the color filling the shape's interior. layer Specifies whether shapes are drawn below or above traces. line :class:`plotly.graph_objects.layout.shape.Line` instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. opacity Sets the opacity of the shape. path For `type` "path" - a valid SVG path with the pixel values replaced by data values in `xsizemode`/`ysizemode` being "scaled" and taken unmodified as pixels relative to `xanchor` and `yanchor` in case of "pixel" size mode. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained "polybezier" commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can't use either to separate date from time parts. Therefore we'll use underscore for this purpose: 2015-02-21_13:45:56.789 templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. type Specifies the shape type to be drawn. If "line", a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect to the axes' sizing mode. If "circle", a circle is drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes' sizing mode. If "rect", a rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to the axes' sizing mode. If "path", draw a custom SVG path using `path`. with respect to the axes' sizing mode. visible Determines whether or not this shape is visible. x0 Sets the shape's starting x position. See `type` and `xsizemode` for more info. x1 Sets the shape's end x position. See `type` and `xsizemode` for more info. xanchor Only relevant in conjunction with `xsizemode` set to "pixel". Specifies the anchor point on the x axis to which `x0`, `x1` and x coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `xsizemode` not set to "pixel". xref Sets the shape's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate. If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", then you must convert the date to unix time in milliseconds. xsizemode Sets the shapes's sizing mode along the x axis. If set to "scaled", `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to "paper"). If set to "pixel", `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction. y0 Sets the shape's starting y position. See `type` and `ysizemode` for more info. y1 Sets the shape's end y position. See `type` and `ysizemode` for more info. yanchor Only relevant in conjunction with `ysizemode` set to "pixel". Specifies the anchor point on the y axis to which `y0`, `y1` and y coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `ysizemode` not set to "pixel". yref Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an y coordinate If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). ysizemode Sets the shapes's sizing mode along the y axis. If set to "scaled", `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to "paper"). If set to "pixel", `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction. Returns ------- tuple[plotly.graph_objs.layout.Shape] shapesr)rrrrrfys#z Layout.shapescCs ||d<dS)Nrr)rrrrrr zscCs|dS)a, When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes The 'shapedefaults' property is an instance of Shape that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Shape` - A dict of string/value properties that will be passed to the Shape constructor Supported dict properties: Returns ------- plotly.graph_objs.layout.Shape shapedefaultsr)rrrrrzszLayout.shapedefaultscCs ||d<dS)Nrr)rrrrrr%zscCs|dS)a Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool r+r)rrrrr++zszLayout.showlegendcCs ||d<dS)Nr+r)rrrrrr+=zscCs|dS)a The 'sliders' property is a tuple of instances of Slider that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.Slider - A list or tuple of dicts of string/value properties that will be passed to the Slider constructor Supported dict properties: active Determines which button (by index starting from 0) is considered active. activebgcolor Sets the background color of the slider grip while dragging. bgcolor Sets the background color of the slider. bordercolor Sets the color of the border enclosing the slider. borderwidth Sets the width (in px) of the border enclosing the slider. currentvalue :class:`plotly.graph_objects.layout.slider.Curr entvalue` instance or dict with compatible properties font Sets the font of the slider step labels. len Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends. lenmode Determines whether this slider length is set in units of plot "fraction" or in *pixels. Use `len` to set the value. minorticklen Sets the length in pixels of minor step tick marks name When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. pad Set the padding of the slider component along each side. steps A tuple of :class:`plotly.graph_objects.layout. slider.Step` instances or dicts with compatible properties stepdefaults When used in a template (as layout.template.layout.slider.stepdefaults), sets the default property values to use for elements of layout.slider.steps templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. tickcolor Sets the color of the border enclosing the slider. ticklen Sets the length in pixels of step tick marks tickwidth Sets the tick width (in px). transition :class:`plotly.graph_objects.layout.slider.Tran sition` instance or dict with compatible properties visible Determines whether or not the slider is visible. x Sets the x position (in normalized coordinates) of the slider. xanchor Sets the slider's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector. y Sets the y position (in normalized coordinates) of the slider. yanchor Sets the slider's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector. Returns ------- tuple[plotly.graph_objs.layout.Slider] slidersr)rrrrrCzsnzLayout.sliderscCs ||d<dS)Nrr)rrrrrrzscCs|dS)a3 When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders The 'sliderdefaults' property is an instance of Slider that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Slider` - A dict of string/value properties that will be passed to the Slider constructor Supported dict properties: Returns ------- plotly.graph_objs.layout.Slider sliderdefaultsr)rrrrrzszLayout.sliderdefaultscCs ||d<dS)Nrr)rrrrrrzscCs|dS)aI Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area- like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills. The 'spikedistance' property is a integer and may be specified as: - An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807] Returns ------- int spikedistancer)rrrrrzszLayout.spikedistancecCs ||d<dS)Nrr)rrrrrrzscCs|dS)a Sets the default sunburst slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendsunburstcolors`. The 'sunburstcolorway' property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings Returns ------- list sunburstcolorwayr)rrrrrzszLayout.sunburstcolorwaycCs ||d<dS)Nrr)rrrrrrzscCs|dS)ag Default attributes to be applied to the plot. This should be a dict with format: `{'layout': layoutTemplate, 'data': {trace_type: [traceTemplate, ...], ...}}` where `layoutTemplate` is a dict matching the structure of `figure.layout` and `traceTemplate` is a dict matching the structure of the trace with type `trace_type` (e.g. 'scatter'). Alternatively, this may be specified as an instance of plotly.graph_objs.layout.Template. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so this can be used to add a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`. The 'template' property is an instance of Template that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Template` - A dict of string/value properties that will be passed to the Template constructor Supported dict properties: data :class:`plotly.graph_objects.layout.template.Da ta` instance or dict with compatible properties layout :class:`plotly.graph_objects.Layout` instance or dict with compatible properties - The name of a registered template where current registered templates are stored in the plotly.io.templates configuration object. The names of all registered templates can be retrieved with: >>> import plotly.io as pio >>> list(pio.templates) # doctest: +ELLIPSIS ['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...] - A string containing multiple registered template names, joined on '+' characters (e.g. 'template1+template2'). In this case the resulting template is computed by merging together the collection of registered templates Returns ------- plotly.graph_objs.layout.Template templater)rrrrr{s6zLayout.templatecCs ||d<dS)Nrr)rrrrrr={scCs|dS)a The 'ternary' property is an instance of Ternary that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Ternary` - A dict of string/value properties that will be passed to the Ternary constructor Supported dict properties: aaxis :class:`plotly.graph_objects.layout.ternary.Aax is` instance or dict with compatible properties baxis :class:`plotly.graph_objects.layout.ternary.Bax is` instance or dict with compatible properties bgcolor Set the background color of the subplot caxis :class:`plotly.graph_objects.layout.ternary.Cax is` instance or dict with compatible properties domain :class:`plotly.graph_objects.layout.ternary.Dom ain` instance or dict with compatible properties sum The number each triplet should sum to, and the maximum range of each axis uirevision Controls persistence of user-driven changes in axis `min` and `title`, if not overridden in the individual axes. Defaults to `layout.uirevision`. Returns ------- plotly.graph_objs.layout.Ternary rr)rrrrrC{s'zLayout.ternarycCs ||d<dS)Nrr)rrrrrrl{scCs|dS)a The 'title' property is an instance of Title that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Title` - A dict of string/value properties that will be passed to the Title constructor Supported dict properties: font Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute. pad Sets the padding of the title. Each padding value only applies when the corresponding `xanchor`/`yanchor` value is set accordingly. E.g. for left padding to take effect, `xanchor` must be set to "left". The same rule applies if `xanchor`/`yanchor` is determined automatically. Padding is muted if the respective anchor value is "middle*/*center". text Sets the plot's title. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated. x Sets the x position with respect to `xref` in normalized coordinates from 0 (left) to 1 (right). xanchor Sets the title's horizontal alignment with respect to its x position. "left" means that the title starts at x, "right" means that the title ends at x and "center" means that the title's center is at x. "auto" divides `xref` by three and calculates the `xanchor` value automatically based on the value of `x`. xref Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only. y Sets the y position with respect to `yref` in normalized coordinates from 0 (bottom) to 1 (top). "auto" places the baseline of the title onto the vertical center of the top margin. yanchor Sets the title's vertical alignment with respect to its y position. "top" means that the title's cap line is at y, "bottom" means that the title's baseline is at y and "middle" means that the title's midline is at y. "auto" divides `yref` by three and calculates the `yanchor` value automatically based on the value of `y`. yref Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only. Returns ------- plotly.graph_objs.layout.Title rr)rrrrrr{sDz Layout.titlecCs ||d<dS)Nrr)rrrrrr{scCs|dS)aH Deprecated: Please use layout.title.font instead. Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute. The 'font' property is an instance of Font that may be specified as: - An instance of :class:`plotly.graph_objs.layout.title.Font` - A dict of string/value properties that will be passed to the Font constructor Supported dict properties: color family HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman". size Returns ------- rr)rrrrr{s'zLayout.titlefontcCs ||d<dS)Nrr)rrrrrr{scCs|dS)a Sets transition options used during Plotly.react updates. The 'transition' property is an instance of Transition that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Transition` - A dict of string/value properties that will be passed to the Transition constructor Supported dict properties: duration The duration of the transition, in milliseconds. If equal to zero, updates are synchronous. easing The easing function used for the transition ordering Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change. Returns ------- plotly.graph_objs.layout.Transition transitionr)rrrrr{szLayout.transitioncCs ||d<dS)Nrr)rrrrrr |scCs|dS)a Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`. The 'treemapcolorway' property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings Returns ------- list treemapcolorwayr)rrrrr|szLayout.treemapcolorwaycCs ||d<dS)Nrr)rrrrrr#|scCs|dS)a Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision=*time*` and `yaxis.uirevision=*cost*`. Then if only the y data is changed, you can update `yaxis.uirevision=*quantity*` and the y axis range will reset but the x axis range will retain any user- driven zoom. The 'uirevision' property accepts values of any type Returns ------- Any r8r)rrrrr8)|szLayout.uirevisioncCs ||d<dS)Nr8r)rrrrrr8E|scCs|dS)a The 'uniformtext' property is an instance of Uniformtext that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Uniformtext` - A dict of string/value properties that will be passed to the Uniformtext constructor Supported dict properties: minsize Sets the minimum text size between traces of the same type. mode Determines how the font size for various text elements are uniformed between each trace type. If the computed text sizes were smaller than the minimum size defined by `uniformtext.minsize` using "hide" option hides the text; and using "show" option shows the text without further downscaling. Please note that if the size defined by `minsize` is greater than the font size defined by trace, then the `minsize` is used. Returns ------- plotly.graph_objs.layout.Uniformtext uniformtextr)rrrrrK|szLayout.uniformtextcCs ||d<dS)Nrr)rrrrrrk|scCs|dS)ai The 'updatemenus' property is a tuple of instances of Updatemenu that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.Updatemenu - A list or tuple of dicts of string/value properties that will be passed to the Updatemenu constructor Supported dict properties: active Determines which button (by index starting from 0) is considered active. bgcolor Sets the background color of the update menu buttons. bordercolor Sets the color of the border enclosing the update menu. borderwidth Sets the width (in px) of the border enclosing the update menu. buttons A tuple of :class:`plotly.graph_objects.layout. updatemenu.Button` instances or dicts with compatible properties buttondefaults When used in a template (as layout.template.lay out.updatemenu.buttondefaults), sets the default property values to use for elements of layout.updatemenu.buttons direction Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For `left` and `up`, the buttons will still appear in left-to-right or top-to-bottom order respectively. font Sets the font of the update menu button text. name When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. pad Sets the padding around the buttons or dropdown menu. showactive Highlights active dropdown item or active button if true. templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. type Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically visible Determines whether or not the update menu is visible. x Sets the x position (in normalized coordinates) of the update menu. xanchor Sets the update menu's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector. y Sets the y position (in normalized coordinates) of the update menu. yanchor Sets the update menu's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector. Returns ------- tuple[plotly.graph_objs.layout.Updatemenu] updatemenusr)rrrrrq|s_zLayout.updatemenuscCs ||d<dS)Nrr)rrrrrr|scCs|dS)aO When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus The 'updatemenudefaults' property is an instance of Updatemenu that may be specified as: - An instance of :class:`plotly.graph_objs.layout.Updatemenu` - A dict of string/value properties that will be passed to the Updatemenu constructor Supported dict properties: Returns ------- plotly.graph_objs.layout.Updatemenu updatemenudefaultsr)rrrrr|szLayout.updatemenudefaultscCs ||d<dS)Nrr)rrrrrr|scCs|dS)aS Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have "width" set. The 'violingap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float violingapr)rrrrr|szLayout.violingapcCs ||d<dS)Nrr)rrrrrr}scCs|dS)aW Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have "width" set. The 'violingroupgap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float violingroupgapr)rrrrr }szLayout.violingroupgapcCs ||d<dS)Nrr)rrrrrr}scCs|dS)ah Determines how violins at the same location coordinate are displayed on the graph. If "group", the violins are plotted next to one another centered around the shared location. If "overlay", the violins are plotted over one another, you might need to set "opacity" to see them multiple violins. Has no effect on traces that have "width" set. The 'violinmode' property is an enumeration that may be specified as: - One of the following enumeration values: ['group', 'overlay'] Returns ------- Any violinmoder)rrrrr}szLayout.violinmodecCs ||d<dS)Nrr)rrrrrr3}scCs|dS)a Sets the gap (in plot fraction) between bars of adjacent location coordinates. The 'waterfallgap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float waterfallgapr)rrrrr9}s zLayout.waterfallgapcCs ||d<dS)Nrr)rrrrrrH}scCs|dS)a  Sets the gap (in plot fraction) between bars of the same location coordinate. The 'waterfallgroupgap' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float waterfallgroupgapr)rrrrrN}s zLayout.waterfallgroupgapcCs ||d<dS)Nrr)rrrrrr]}scCs|dS)a& Determines how bars at the same location coordinate are displayed on the graph. With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. The 'waterfallmode' property is an enumeration that may be specified as: - One of the following enumeration values: ['group', 'overlay'] Returns ------- Any waterfallmoder)rrrrrc}szLayout.waterfallmodecCs ||d<dS)Nrr)rrrrrrv}scCs|dS)z Sets the plot's width (in px). The 'width' property is a number and may be specified as: - An int or float in the interval [10, inf] Returns ------- int|float r:r)rrrrr:|}s z Layout.widthcCs ||d<dS)Nr:r)rrrrrr:}scCs|dS)aB\ The 'xaxis' property is an instance of XAxis that may be specified as: - An instance of :class:`plotly.graph_objs.layout.XAxis` - A dict of string/value properties that will be passed to the XAxis constructor Supported dict properties: anchor If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`. automargin Determines whether long tick labels automatically grow the figure margins. autorange Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to False. calendar Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar` categoryarray Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`. categoryarraysrc Sets the source reference on plot.ly for categoryarray . categoryorder Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values. color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. constrain If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range" (default), or by decreasing the "domain". constraintoward If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes. dividercolor Sets the color of the dividers Only has an effect on "multicategory" axes. dividerwidth Sets the width (in px) of the dividers Only has an effect on "multicategory" axes. domain Sets the domain of this axis (in plot fraction). dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. fixedrange Determines whether or not this axis is zoom- able. If true, then zoom is disabled. gridcolor Sets the color of the grid lines. gridwidth Sets the width (in px) of the grid lines. hoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" layer Sets the layer on which this axis is displayed. If *above traces*, this axis is displayed above all the subplot's traces If *below traces*, this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to False to show markers and/or text nodes above this axis. linecolor Sets the axis line color. linewidth Sets the width (in px) of the axis line. matches If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`. mirror Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If True, the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If False, mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". overlaying If set a same-letter axis id, this axis is overlaid on top of the corresponding same- letter axis, with traces and axes visible for both axes. If False, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest- numbered axis will be visible. position Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free". range Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. rangemode If "normal", the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If "nonnegative", the range is non- negative, regardless of the input data. Applies only to linear axes. rangeselector :class:`plotly.graph_objects.layout.xaxis.Range selector` instance or dict with compatible properties rangeslider :class:`plotly.graph_objects.layout.xaxis.Range slider` instance or dict with compatible properties scaleanchor If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. scaleratio If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal. separatethousands If "true", even 4-digit integers are separated showdividers Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes. showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showgrid Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. showline Determines whether or not a line bounding this axis is drawn. showspikes Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. side Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area. spikecolor Sets the spike color. If undefined, will use the series color spikedash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). spikemode Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on spikesnap Determines whether spikelines are stuck to the cursor or to the closest datapoints. spikethickness Sets the width (in px) of the zero line. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the tick font. tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.layout. xaxis.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.xaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.xaxis.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. tickson Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.layout.xaxis.Title ` instance or dict with compatible properties titlefont Deprecated: Please use layout.xaxis.title.font instead. Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute. type Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question. uirevision Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`. visible A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false zeroline Determines whether or not a line is drawn at along the 0 value of this axis. If True, the zero line is drawn on top of the grid lines. zerolinecolor Sets the line color of the zero line. zerolinewidth Sets the width (in px) of the zero line. Returns ------- plotly.graph_objs.layout.XAxis r>r)rrrrr>}s7z Layout.xaxiscCs ||d<dS)Nr>r)rrrrrr>FscCs|dS)aZ The 'yaxis' property is an instance of YAxis that may be specified as: - An instance of :class:`plotly.graph_objs.layout.YAxis` - A dict of string/value properties that will be passed to the YAxis constructor Supported dict properties: anchor If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`. automargin Determines whether long tick labels automatically grow the figure margins. autorange Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to False. calendar Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar` categoryarray Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`. categoryarraysrc Sets the source reference on plot.ly for categoryarray . categoryorder Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values. color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. constrain If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range" (default), or by decreasing the "domain". constraintoward If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes. dividercolor Sets the color of the dividers Only has an effect on "multicategory" axes. dividerwidth Sets the width (in px) of the dividers Only has an effect on "multicategory" axes. domain Sets the domain of this axis (in plot fraction). dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48" exponentformat Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. fixedrange Determines whether or not this axis is zoom- able. If true, then zoom is disabled. gridcolor Sets the color of the grid lines. gridwidth Sets the width (in px) of the grid lines. hoverformat Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" layer Sets the layer on which this axis is displayed. If *above traces*, this axis is displayed above all the subplot's traces If *below traces*, this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to False to show markers and/or text nodes above this axis. linecolor Sets the axis line color. linewidth Sets the width (in px) of the axis line. matches If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`. mirror Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If True, the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If False, mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots. nticks Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto". overlaying If set a same-letter axis id, this axis is overlaid on top of the corresponding same- letter axis, with traces and axes visible for both axes. If False, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest- numbered axis will be visible. position Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free". range Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. rangemode If "normal", the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If "nonnegative", the range is non- negative, regardless of the input data. Applies only to linear axes. scaleanchor If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. scaleratio If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal. separatethousands If "true", even 4-digit integers are separated showdividers Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes. showexponent If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. showgrid Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. showline Determines whether or not a line bounding this axis is drawn. showspikes Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest showticklabels Determines whether or not the tick labels are drawn. showtickprefix If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. showticksuffix Same as `showtickprefix` but for tick suffixes. side Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area. spikecolor Sets the spike color. If undefined, will use the series color spikedash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). spikemode Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on spikesnap Determines whether spikelines are stuck to the cursor or to the closest datapoints. spikethickness Sets the width (in px) of the zero line. tick0 Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears. tickangle Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. tickcolor Sets the tick color. tickfont Sets the tick font. tickformat Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops A tuple of :class:`plotly.graph_objects.layout. yaxis.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.yaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.yaxis.tickformatstops ticklen Sets the tick length (in px). tickmode Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). tickprefix Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. tickson Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels. ticksuffix Sets a tick label suffix. ticktext Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. ticktextsrc Sets the source reference on plot.ly for ticktext . tickvals Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. tickvalssrc Sets the source reference on plot.ly for tickvals . tickwidth Sets the tick width (in px). title :class:`plotly.graph_objects.layout.yaxis.Title ` instance or dict with compatible properties titlefont Deprecated: Please use layout.yaxis.title.font instead. Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute. type Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question. uirevision Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`. visible A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false zeroline Determines whether or not a line is drawn at along the 0 value of this axis. If True, the zero line is drawn on top of the grid lines. zerolinecolor Sets the line color of the zero line. zerolinewidth Sets the width (in px) of the zero line. Returns ------- plotly.graph_objs.layout.YAxis rBr)rrrrrBLs/z Layout.yaxiscCs ||d<dS)NrBr)rrrrrrBscCsdS)NrFr)rrrrrGszLayout._parent_path_strcCsdS)NaS angularaxis :class:`plotly.graph_objects.layout.AngularAxis` instance or dict with compatible properties annotations A tuple of :class:`plotly.graph_objects.layout.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations autosize Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot. bargap Sets the gap (in plot fraction) between bars of adjacent location coordinates. bargroupgap Sets the gap (in plot fraction) between bars of the same location coordinate. barmode Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. barnorm Sets the normalization for bar traces on the graph. With "fraction", the value of each bar is divided by the sum of all values at that location coordinate. "percent" is the same but multiplied by 100 to show percentages. boxgap Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set. boxgroupgap Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set. boxmode Determines how boxes at the same location coordinate are displayed on the graph. If "group", the boxes are plotted next to one another centered around the shared location. If "overlay", the boxes are plotted over one another, you might need to set "opacity" to see them multiple boxes. Has no effect on traces that have "width" set. calendar Sets the default calendar system to use for interpreting and displaying dates throughout the plot. clickmode Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired. coloraxis :class:`plotly.graph_objects.layout.Coloraxis` instance or dict with compatible properties colorscale :class:`plotly.graph_objects.layout.Colorscale` instance or dict with compatible properties colorway Sets the default trace colors. datarevision If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data. direction Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the direction corresponding to positive angles in legacy polar charts. dragmode Determines the mode of drag interactions. "select" and "lasso" apply only to scatter traces with markers or text. "orbit" and "turntable" apply only to 3D scenes. editrevision Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`. extendfunnelareacolors If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. extendpiecolors If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. extendsunburstcolors If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. extendtreemapcolors If `true`, the treemap slice colors (whether given by `treemapcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. font Sets the global font. Note that fonts used in traces and other layout components inherit from the global font. funnelareacolorway Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`. funnelgap Sets the gap (in plot fraction) between bars of adjacent location coordinates. funnelgroupgap Sets the gap (in plot fraction) between bars of the same location coordinate. funnelmode Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. geo :class:`plotly.graph_objects.layout.Geo` instance or dict with compatible properties grid :class:`plotly.graph_objects.layout.Grid` instance or dict with compatible properties height Sets the plot's height (in px). hiddenlabels hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts hiddenlabelssrc Sets the source reference on plot.ly for hiddenlabels . hidesources Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the plotly service (at https://plot.ly or on-premise). hoverdistance Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict. hoverlabel :class:`plotly.graph_objects.layout.Hoverlabel` instance or dict with compatible properties hovermode Determines the mode of hover interactions. If `clickmode` includes the "select" flag, `hovermode` defaults to "closest". If `clickmode` lacks the "select" flag, it defaults to "x" or "y" (depending on the trace's `orientation` value) for plots based on cartesian coordinates. For anything else the default value is "closest". images A tuple of :class:`plotly.graph_objects.layout.Image` instances or dicts with compatible properties imagedefaults When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images legend :class:`plotly.graph_objects.layout.Legend` instance or dict with compatible properties mapbox :class:`plotly.graph_objects.layout.Mapbox` instance or dict with compatible properties margin :class:`plotly.graph_objects.layout.Margin` instance or dict with compatible properties meta Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}. metasrc Sets the source reference on plot.ly for meta . modebar :class:`plotly.graph_objects.layout.Modebar` instance or dict with compatible properties orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire polar by the given angle in legacy polar charts. paper_bgcolor Sets the background color of the paper where the graph is drawn. piecolorway Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`. plot_bgcolor Sets the background color of the plotting area in- between x and y axes. polar :class:`plotly.graph_objects.layout.Polar` instance or dict with compatible properties radialaxis :class:`plotly.graph_objects.layout.RadialAxis` instance or dict with compatible properties scene :class:`plotly.graph_objects.layout.Scene` instance or dict with compatible properties selectdirection When "dragmode" is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit. selectionrevision Controls persistence of user-driven changes in selected points from all traces. separators Sets the decimal and thousand separators. For example, *. * puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default. shapes A tuple of :class:`plotly.graph_objects.layout.Shape` instances or dicts with compatible properties shapedefaults When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes showlegend Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. sliders A tuple of :class:`plotly.graph_objects.layout.Slider` instances or dicts with compatible properties sliderdefaults When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders spikedistance Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills. sunburstcolorway Sets the default sunburst slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendsunburstcolors`. template Default attributes to be applied to the plot. This should be a dict with format: `{'layout': layoutTemplate, 'data': {trace_type: [traceTemplate, ...], ...}}` where `layoutTemplate` is a dict matching the structure of `figure.layout` and `traceTemplate` is a dict matching the structure of the trace with type `trace_type` (e.g. 'scatter'). Alternatively, this may be specified as an instance of plotly.graph_objs.layout.Template. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so this can be used to add a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`. ternary :class:`plotly.graph_objects.layout.Ternary` instance or dict with compatible properties title :class:`plotly.graph_objects.layout.Title` instance or dict with compatible properties titlefont Deprecated: Please use layout.title.font instead. Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute. transition Sets transition options used during Plotly.react updates. treemapcolorway Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`. uirevision Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision=*time*` and `yaxis.uirevision=*cost*`. Then if only the y data is changed, you can update `yaxis.uirevision=*quantity*` and the y axis range will reset but the x axis range will retain any user-driven zoom. uniformtext :class:`plotly.graph_objects.layout.Uniformtext` instance or dict with compatible properties updatemenus A tuple of :class:`plotly.graph_objects.layout.Updatemenu` instances or dicts with compatible properties updatemenudefaults When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus violingap Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have "width" set. violingroupgap Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have "width" set. violinmode Determines how violins at the same location coordinate are displayed on the graph. If "group", the violins are plotted next to one another centered around the shared location. If "overlay", the violins are plotted over one another, you might need to set "opacity" to see them multiple violins. Has no effect on traces that have "width" set. waterfallgap Sets the gap (in plot fraction) between bars of adjacent location coordinates. waterfallgroupgap Sets the gap (in plot fraction) between bars of the same location coordinate. waterfallmode Determines how bars at the same location coordinate are displayed on the graph. With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. width Sets the plot's width (in px). xaxis :class:`plotly.graph_objects.layout.XAxis` instance or dict with compatible properties yaxis :class:`plotly.graph_objects.layout.YAxis` instance or dict with compatible properties r)rrrrrHs(zLayout._prop_descriptionsr)rrcTW stt|d|dkri}n4t||jr4|}nt|trJt|}nt d|T dd|_ ddl m }U|U|jd<|U|jd <|U|jd <|U|jd <|U|jd <|U|jd <|U|jd<|U|jd<|U|jd<|U|jd<|U|jd<|U|jd<|U|jd<|U|jd<|U|jd<|U|jd<|U|jd<|U |jd<|U!|jd<|U"|jd<|U#|jd<|U$|jd<|U%|jd<|U&|jd<|U'|jd <|U(|jd!<|U)|jd"<|U*|jd#<|U+|jd$<|U,|jd%<|U-|jd&<|U.|jd'<|U/|jd(<|U0|jd)<|U1|jd*<|U2|jd+<|U3|jd,<|U4|jd-<|U5|jd.<|U6|jd/<|U7|jd0<|U8|jd1<|U9|jd2<|U:|jd3<|U;|jd4<|U<|jd5<|U=|jd6<|U>|jd7<|U?|jd8<|U@|jd9<|UA|jd:<|UB|jd;<|UC|jd<<|UD|jd=<|UE|jd><|UF|jd?<|UG|jd@<|UH|jdA<|UI|jdB<|UJ|jdC<|UK|jdD<|UL|jdE<|UM|jdF<|UN|jdG<|UO|jdH<|UP|jdI<|UQ|jdJ<|UR|jdK<|US|jdL<|UT|jdM<|UU|jdN<|UV|jdO<|UW|jdP<|UX|jdQ<|UY|jdR<|UZ|jdS<|U[|jdT<|U\|jdU<|U]|jdV<|U^|jdW<|U_|jdX<| dd}V|dk r|n|V|d<| d d}V|dk r|n|V|d <| d d}V|dk r8|n|V|d <| d d}V|dk rZ|n|V|d <| d d}V|dk r||n|V|d <| d d}V|dk r|n|V|d <| dd}V|dk r|n|V|d<| dd}V| dk r| n|V|d<| dd}V| dk r| n|V|d<| dd}V| dk r&| n|V|d<| dd}V| dk rH| n|V|d<| dd}V| dk rj| n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r6|n|V|d<| dd}V|dk rX|n|V|d<| dd}V|dk rz|n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r|n|V|d<| dd}V|dk r|n|V|d<| d d}V|dk r$|n|V|d <| d!d}V|dk rF|n|V|d!<| d"d}V|dk rh|n|V|d"<| d#d}V|dk r|n|V|d#<| d$d}V|dk r|n|V|d$<| d%d}V|dk r|n|V|d%<| d&d}V| dk r| n|V|d&<| d'd}V|!dk r|!n|V|d'<| d(d}V|"dk r4|"n|V|d(<| d)d}V|#dk rV|#n|V|d)<| d*d}V|$dk rx|$n|V|d*<| d+d}V|%dk r|%n|V|d+<| d,d}V|&dk r|&n|V|d,<| d-d}V|'dk r|'n|V|d-<| d.d}V|(dk r|(n|V|d.<| d/d}V|)dk r"|)n|V|d/<| d0d}V|*dk rD|*n|V|d0<| d1d}V|+dk rf|+n|V|d1<| d2d}V|,dk r|,n|V|d2<| d3d}V|-dk r|-n|V|d3<| d4d}V|.dk r|.n|V|d4<| d5d}V|/dk r|/n|V|d5<| d6d}V|0dk r|0n|V|d6<| d7d}V|1dk r2|1n|V|d7<| d8d}V|2dk rT|2n|V|d8<| d9d}V|3dk rv|3n|V|d9<| d:d}V|4dk r|4n|V|d:<| d;d}V|5dk r|5n|V|d;<| dd}V|8dk r |8n|V|d><| d?d}V|9dk rB|9n|V|d?<| d@d}V|:dk rd|:n|V|d@<| dAd}V|;dk r|;n|V|dA<| dBd}V|dk r|>n|V|dD<| dEd}V|?dk r|?n|V|dE<| dFd}V|@dk r0|@n|V|dF<| dGd}V|Adk rR|An|V}V|Vdk rh|V|dG<| dHd}V|Bdk r|Bn|V|dH<| dId}V|Cdk r|Cn|V|dI<| dYd}V|Ddk r|Dn|V}V|Vdk r|V|dY<| dJd}V|Edk r|En|V|dJ<| dKd}V|Fdk r|Fn|V|dK<| dLd}V|Gdk r:|Gn|V|dL<| dMd}V|Hdk r\|Hn|V|dM<| dNd}V|Idk r~|In|V|dN<| dOd}V|Jdk r|Jn|V|dO<| dPd}V|Kdk r|Kn|V|dP<| dQd}V|Ldk r|Ln|V|dQ<| dRd}V|Mdk r|Mn|V|dR<| dSd}V|Ndk r(|Nn|V|dS<| dTd}V|Odk rJ|On|V|dT<| dUd}V|Pdk rl|Pn|V|dU<| dVd}V|Qdk r|Qn|V|dV<| dWd}V|Rdk r|Rn|V|dW<| dXd}V|Sdk r|Sn|V|dX<|j`ft|f|Td|_ dS)ZaT Construct a new Layout object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Layout` angularaxis :class:`plotly.graph_objects.layout.AngularAxis` instance or dict with compatible properties annotations A tuple of :class:`plotly.graph_objects.layout.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations autosize Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot. bargap Sets the gap (in plot fraction) between bars of adjacent location coordinates. bargroupgap Sets the gap (in plot fraction) between bars of the same location coordinate. barmode Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. barnorm Sets the normalization for bar traces on the graph. With "fraction", the value of each bar is divided by the sum of all values at that location coordinate. "percent" is the same but multiplied by 100 to show percentages. boxgap Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set. boxgroupgap Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set. boxmode Determines how boxes at the same location coordinate are displayed on the graph. If "group", the boxes are plotted next to one another centered around the shared location. If "overlay", the boxes are plotted over one another, you might need to set "opacity" to see them multiple boxes. Has no effect on traces that have "width" set. calendar Sets the default calendar system to use for interpreting and displaying dates throughout the plot. clickmode Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired. coloraxis :class:`plotly.graph_objects.layout.Coloraxis` instance or dict with compatible properties colorscale :class:`plotly.graph_objects.layout.Colorscale` instance or dict with compatible properties colorway Sets the default trace colors. datarevision If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data. direction Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the direction corresponding to positive angles in legacy polar charts. dragmode Determines the mode of drag interactions. "select" and "lasso" apply only to scatter traces with markers or text. "orbit" and "turntable" apply only to 3D scenes. editrevision Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`. extendfunnelareacolors If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. extendpiecolors If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. extendsunburstcolors If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. extendtreemapcolors If `true`, the treemap slice colors (whether given by `treemapcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. font Sets the global font. Note that fonts used in traces and other layout components inherit from the global font. funnelareacolorway Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`. funnelgap Sets the gap (in plot fraction) between bars of adjacent location coordinates. funnelgroupgap Sets the gap (in plot fraction) between bars of the same location coordinate. funnelmode Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. geo :class:`plotly.graph_objects.layout.Geo` instance or dict with compatible properties grid :class:`plotly.graph_objects.layout.Grid` instance or dict with compatible properties height Sets the plot's height (in px). hiddenlabels hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts hiddenlabelssrc Sets the source reference on plot.ly for hiddenlabels . hidesources Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the plotly service (at https://plot.ly or on-premise). hoverdistance Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict. hoverlabel :class:`plotly.graph_objects.layout.Hoverlabel` instance or dict with compatible properties hovermode Determines the mode of hover interactions. If `clickmode` includes the "select" flag, `hovermode` defaults to "closest". If `clickmode` lacks the "select" flag, it defaults to "x" or "y" (depending on the trace's `orientation` value) for plots based on cartesian coordinates. For anything else the default value is "closest". images A tuple of :class:`plotly.graph_objects.layout.Image` instances or dicts with compatible properties imagedefaults When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images legend :class:`plotly.graph_objects.layout.Legend` instance or dict with compatible properties mapbox :class:`plotly.graph_objects.layout.Mapbox` instance or dict with compatible properties margin :class:`plotly.graph_objects.layout.Margin` instance or dict with compatible properties meta Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}. metasrc Sets the source reference on plot.ly for meta . modebar :class:`plotly.graph_objects.layout.Modebar` instance or dict with compatible properties orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire polar by the given angle in legacy polar charts. paper_bgcolor Sets the background color of the paper where the graph is drawn. piecolorway Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`. plot_bgcolor Sets the background color of the plotting area in- between x and y axes. polar :class:`plotly.graph_objects.layout.Polar` instance or dict with compatible properties radialaxis :class:`plotly.graph_objects.layout.RadialAxis` instance or dict with compatible properties scene :class:`plotly.graph_objects.layout.Scene` instance or dict with compatible properties selectdirection When "dragmode" is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit. selectionrevision Controls persistence of user-driven changes in selected points from all traces. separators Sets the decimal and thousand separators. For example, *. * puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default. shapes A tuple of :class:`plotly.graph_objects.layout.Shape` instances or dicts with compatible properties shapedefaults When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes showlegend Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. sliders A tuple of :class:`plotly.graph_objects.layout.Slider` instances or dicts with compatible properties sliderdefaults When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders spikedistance Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills. sunburstcolorway Sets the default sunburst slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendsunburstcolors`. template Default attributes to be applied to the plot. This should be a dict with format: `{'layout': layoutTemplate, 'data': {trace_type: [traceTemplate, ...], ...}}` where `layoutTemplate` is a dict matching the structure of `figure.layout` and `traceTemplate` is a dict matching the structure of the trace with type `trace_type` (e.g. 'scatter'). Alternatively, this may be specified as an instance of plotly.graph_objs.layout.Template. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so this can be used to add a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`. ternary :class:`plotly.graph_objects.layout.Ternary` instance or dict with compatible properties title :class:`plotly.graph_objects.layout.Title` instance or dict with compatible properties titlefont Deprecated: Please use layout.title.font instead. Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute. transition Sets transition options used during Plotly.react updates. treemapcolorway Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`. uirevision Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision=*time*` and `yaxis.uirevision=*cost*`. Then if only the y data is changed, you can update `yaxis.uirevision=*quantity*` and the y axis range will reset but the x axis range will retain any user-driven zoom. uniformtext :class:`plotly.graph_objects.layout.Uniformtext` instance or dict with compatible properties updatemenus A tuple of :class:`plotly.graph_objects.layout.Updatemenu` instances or dicts with compatible properties updatemenudefaults When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus violingap Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have "width" set. violingroupgap Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have "width" set. violinmode Determines how violins at the same location coordinate are displayed on the graph. If "group", the violins are plotted next to one another centered around the shared location. If "overlay", the violins are plotted over one another, you might need to set "opacity" to see them multiple violins. Has no effect on traces that have "width" set. waterfallgap Sets the gap (in plot fraction) between bars of adjacent location coordinates. waterfallgroupgap Sets the gap (in plot fraction) between bars of the same location coordinate. waterfallmode Determines how bars at the same location coordinate are displayed on the graph. With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. width Sets the plot's width (in px). xaxis :class:`plotly.graph_objects.layout.XAxis` instance or dict with compatible properties yaxis :class:`plotly.graph_objects.layout.YAxis` instance or dict with compatible properties Returns ------- Layout layoutNzThe first argument to the plotly.graph_objs.Layout constructor must be a dict or an instance of :class:`plotly.graph_objs.Layout`rJFr)rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr!r"rr(rrrrrrrrrrrr+rrrrrrrrrr8rrrrrrrrrr:r>rBr)arNrrOrPrQrRrSrTrUrVrWrXrYrZAngularAxisValidatorr[ZAnnotationsValidatorZAnnotationValidatorZAutosizeValidatorZBargapValidatorZBargroupgapValidatorZBarmodeValidatorZBarnormValidatorZBoxgapValidatorZBoxgroupgapValidatorZBoxmodeValidatorZCalendarValidatorZClickmodeValidatorrrZColorwayValidatorZDatarevisionValidatorrZDragmodeValidatorZEditrevisionValidatorZExtendfunnelareacolorsValidatorZExtendpiecolorsValidatorZExtendsunburstcolorsValidatorZExtendtreemapcolorsValidatorreZFunnelareacolorwayValidatorZFunnelgapValidatorZFunnelgroupgapValidatorZFunnelmodeValidatorrZ GridValidatorZHeightValidatorZHiddenlabelsValidatorZHiddenlabelssrcValidatorZHidesourcesValidatorZHoverdistanceValidatorrgZHovermodeValidatorZImagesValidatorZImageValidatorZLegendValidatorrZMarginValidatorrrrsZModebarValidatorryZPaperBgcolorValidatorZPiecolorwayValidatorZPlotBgcolorValidatorrZRadialAxisValidatorrZSelectdirectionValidatorZSelectionrevisionValidatorZSeparatorsValidatorZShapesValidatorZShapeValidatorr|ZSlidersValidatorZSliderValidatorZSpikedistanceValidatorZSunburstcolorwayValidatorZTemplateValidatorrrZTransitionValidatorZTreemapcolorwayValidatorrZUniformtextValidatorZUpdatemenusValidatorZUpdatemenuValidatorZViolingapValidatorZViolingroupgapValidatorZViolinmodeValidatorZWaterfallgapValidatorZWaterfallgroupgapValidatorZWaterfallmodeValidatorrrrr)Wrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr!r"rr(rrrrrrrrrrrr+rrrrrrrrrrr8rrrrrrrrrr:r>rBrZv_layoutr)rQrrrOs                                                                                          zLayout.__init__)SNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)crrrZ_subplotid_prop_namesrecompilejoinrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr!r"rr(rrrrrrrrrrrr+rrrrrrrrrrr8rrrrrrrrrr:r>rBrGrHrrOrrr)rQrros$  ;             K           (     t a      *  _  g T "   !  6  6 B @ E    %   p    8 ) F )     a       91* r)BaseFrameHierarchyTypecseZdZeddZejddZeddZejddZeddZejd dZed d Zejd d Zed dZ e jddZ eddZ e jddZ eddZ eddZ dfdd Z ZS)FramecCs|dS)a The name of the frame into which this frame's properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames. The 'baseframe' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str baseframer)rrrrrszFrame.baseframecCs ||d<dS)Nrr)rrrrrr scCs|dS)z A list of traces this frame modifies. The format is identical to the normal trace definition. Returns ------- Any datar)rrrrrs z Frame.datacCs ||d<dS)Nrr)rrrrrrscCs|dS)aL An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames. The 'group' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str groupr)rrrrr!sz Frame.groupcCs ||d<dS)Nrr)rrrrrr1scCs|dS)z Layout properties which this frame modifies. The format is identical to the normal layout definition. Returns ------- Any rr)rrrrr7s z Frame.layoutcCs ||d<dS)Nrr)rrrrrrCscCs|dS)z A label by which to identify the frame The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str r#r)rrrrr#Is z Frame.namecCs ||d<dS)Nr#r)rrrrrr#XscCs|dS)z A list of trace indices that identify the respective traces in the data attribute The 'traces' property accepts values of any type Returns ------- Any tracesr)rrrrr^s z Frame.tracescCs ||d<dS)Nrr)rrrrrrlscCsdS)NrFr)rrrrrGrszFrame._parent_path_strcCsdS)Na baseframe The name of the frame into which this frame's properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames. data A list of traces this frame modifies. The format is identical to the normal trace definition. group An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames. layout Layout properties which this frame modifies. The format is identical to the normal layout definition. name A label by which to identify the frame traces A list of trace indices that identify the respective traces in the data attribute r)rrrrrHxszFrame._prop_descriptionsNc  stt|d|dkri}n4t||jr4|}nt|trJt|}nt d| dd|_ ddl m } | |jd<| |jd <| |jd <| |jd <| |jd <| |jd <| dd} |dk r|n| |d<| d d} |dk r|n| |d <| d d} |dk r|n| |d <| d d} |dk r<|n| |d <| d d} |dk r^|n| |d <| d d} |dk r|n| |d <|jft|f|d|_ dS)a Construct a new Frame object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.Frame` baseframe The name of the frame into which this frame's properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames. data A list of traces this frame modifies. The format is identical to the normal trace definition. group An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames. layout Layout properties which this frame modifies. The format is identical to the normal layout definition. name A label by which to identify the frame traces A list of trace indices that identify the respective traces in the data attribute Returns ------- Frame framesNzThe first argument to the plotly.graph_objs.Frame constructor must be a dict or an instance of :class:`plotly.graph_objs.Frame`rJFr)framerrrrr#r)rNrrOrPrQrRrSrTrUrVrWrXrYrZBaseframeValidatorr[Z DataValidatorZGroupValidatorZLayoutValidatorrtZTracesValidatorr) rrrrrrr#rrZv_framer)rQrrrOs>,           zFrame.__init__)NNNNNNN)rrrrrrrrrr#rrGrHrOrrr)rQrrs*        r)rI)r)r)r)r)r)r$)r0)r@)rN)r`)rk)rr)r{)r)r)r)r)r)r)r)r)r)r)r)r)r)r)r)r/)r5)r:)r@)rE)rG)rK)rS)r)r\)r^)r`)r)rh)r)r)r)r)r)Figure)Data AnnotationsFrames AngularAxis AnnotationColorBarContoursErrorXErrorYErrorZFontLegendLineMarginMarker RadialAxisSceneStreamXAxisYAxisZAxisXBinsYBinsTraceHistogram2dcontourrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrhrr`r^r\rrSrKrGrEr@r:r5r/rrrrrrrrrrrrrrrrr{rrrkr`rNr@r0r$rrrrrrI) LooseVersionz7.0.0) FigureWidgetr)Zplotly.basedatatypesrZ_BaseTraceTyperUrTrrrrr rr!r&r8rCrVrjrlrxr~rrrrrrrrrrrrrr r+r3r6r>rBrFrHrLrXrYr]r_rarfrjrrrrZ_BaseLayoutTyperrZ_BaseFrameHierarchyTyperZplotly.graph_objsrIrrrrrr$r0r@rNr`rkrrr{rrrrrrrrrrrrrrrr/r5r:r@rErGrKrSrr\r^r`rrhrrrrrZ_figurerZ _deprecationsrrrrrrrrrrrrrrrrrrrrrrrrr__all__ ipywidgetsZdistutils.versionr __version__Z _figurewidgetrappend ImportErrorrrrrs  ` > 9 s ; {  K  r -  O Y ( 2   U  K ) P h -  - v a < < F x  9 ~  c v w  W f a g : \                                                  l