B &[_Wq@s(ddlmZddlZGdddeZdS)) BaseTraceTypeNcCseZdZdZdZddddddd d d d d ddddddddddddddddddd d!d"d#d$d%d&d'd(d)d*d+d,d-d.d/d0d1d2d3d4d5d6d7d8d9d:d;dd?d@dAdBdCdDdEhCZedFdGZejdHdGZedIdJZ e jdKdJZ edLdMZ e jdNdMZ edOdPZ e jdQdPZ edRdSZ e jdTdSZ edUdVZ e jdWdVZ edXdYZejdZdYZed[d\Zejd]d\Zed^d_Zejd`d_ZedadbZejdcdbZedddeZejdfdeZedgdhZejdidhZedjdkZejdldkZedmdnZejdodnZedpdqZejdrdqZedsdtZejdudtZedvdwZejdxdwZedydzZejd{dzZed|d}Zejd~d}ZeddZejddZeddZejddZeddZejddZeddZejddZeddZejddZeddZ e jddZ eddZ!e!jddZ!eddZ"e"jddZ"eddZ#e#jddZ#eddZ$e$jddZ$eddZ%e%jddZ%eddZ&e&jddZ&eddZ'e'jddZ'eddZ(e(jddZ(eddZ)e)jddZ)eddZ*e*jddZ*eddZ+e+jddZ+eddZ,e,jddZ,eddZ-e-jddZ-eddZ.e.jddZ.eddZ/e/jddZ/eddZ0e0jddZ0edd„Z1e1jdd„Z1eddńZ2e2jddńZ2eddȄZ3e3jddȄZ3edd˄Z4e4jdd˄Z4edd΄Z5e5jdd΄Z5eddфZ6e6jddфZ6eddԄZ7e7jddԄZ7eddׄZ8e8jddׄZ8eddڄZ9e9jddڄZ9edd݄Z:e:jdd݄Z:eddZ;e;jddZ;eddZe>jddZ>eddZ?e?jddZ?eddZ@e@jddZ@eddZAeAjddZAeddZBeBjddZBeddZCeCjddZCeddZDeDjddZDeddZEeEjddZEeddZFeFjddZFeddZGeGjddZGeddZHeHjddZHed d ZIeIjd d ZIed d ZJeddZKdfdd ZLZMS( Waterfall waterfallalignmentgroupbase cliponaxis connector constraintext customdata customdatasrc decreasingdxdy hoverinfo hoverinfosrc hoverlabel hovertemplatehovertemplatesrc hovertext hovertextsrcidsidssrc increasinginsidetextanchorinsidetextfont legendgroupmeasure measuresrcmetametasrcnameoffset offsetgroup offsetsrcopacity orientationoutsidetextfontselectedpoints showlegendstreamtext textangletextfonttextinfo textpositiontextpositionsrctextsrc texttemplatetexttemplatesrctotalstypeuid uirevisionvisiblewidthwidthsrcxx0xaxisxperiodxperiod0xperiodalignmentxsrcyy0yaxisyperiodyperiod0yperiodalignmentysrccCs|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 r)selfrIrI@/tmp/pip-install-l29rncou/plotly/plotly/graph_objs/_waterfall.pyrSszWaterfall.alignmentgroupcCs ||d<dS)NrrI)rJvalrIrIrKrdscCs|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 rrI)rJrIrIrKrjs zWaterfall.basecCs ||d<dS)NrrI)rJrLrIrIrKrxscCs|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 rrI)rJrIrIrKr~szWaterfall.cliponaxiscCs ||d<dS)NrrI)rJrLrIrIrKrscCs|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 r rI)rJrIrIrKr szWaterfall.connectorcCs ||d<dS)Nr rI)rJrLrIrIrKr 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 rI)rJrIrIrKr szWaterfall.constraintextcCs ||d<dS)Nr rI)rJrLrIrIrKr 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 rI)rJrIrIrKr szWaterfall.customdatacCs ||d<dS)Nr rI)rJrLrIrIrKr scCs|dS)z Sets the source reference on Chart Studio Cloud for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r rI)rJrIrIrKr s zWaterfall.customdatasrccCs ||d<dS)Nr rI)rJrLrIrIrKr scCs|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 r rI)rJrIrIrKr szWaterfall.decreasingcCs ||d<dS)Nr rI)rJrLrIrIrKr 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 rrI)rJrIrIrKrs z Waterfall.dxcCs ||d<dS)NrrI)rJrLrIrIrKr!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 rrI)rJrIrIrKr's z Waterfall.dycCs ||d<dS)NrrI)rJrLrIrIrKr5scCs|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 rrI)rJrIrIrKr;szWaterfall.hoverinfocCs ||d<dS)NrrI)rJrLrIrIrKrOscCs|dS)z Sets the source reference on Chart Studio Cloud for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rrI)rJrIrIrKrUs zWaterfall.hoverinfosrccCs ||d<dS)NrrI)rJrLrIrIrKrdscCs|dS)a4 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 Chart Studio Cloud for align . bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on Chart Studio Cloud for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on Chart Studio Cloud 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 Chart Studio Cloud for namelength . Returns ------- plotly.graph_objs.waterfall.Hoverlabel rrI)rJrIrIrKrjs3zWaterfall.hoverlabelcCs ||d<dS)NrrI)rJrLrIrIrKrscCs|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-time- format#locale_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://plotly.com/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 rrI)rJrIrIrKrs!zWaterfall.hovertemplatecCs ||d<dS)NrrI)rJrLrIrIrKrscCs|dS)a Sets the source reference on Chart Studio Cloud for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rrI)rJrIrIrKrs zWaterfall.hovertemplatesrccCs ||d<dS)NrrI)rJrLrIrIrKrscCs|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 rrI)rJrIrIrKrszWaterfall.hovertextcCs ||d<dS)NrrI)rJrLrIrIrKrscCs|dS)z Sets the source reference on Chart Studio Cloud for hovertext . The 'hovertextsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rrI)rJrIrIrKrs zWaterfall.hovertextsrccCs ||d<dS)NrrI)rJrLrIrIrKr 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 rrI)rJrIrIrKrsz Waterfall.idscCs ||d<dS)NrrI)rJrLrIrIrKr"scCs|dS)z Sets the source reference on Chart Studio Cloud for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rrI)rJrIrIrKr(s zWaterfall.idssrccCs ||d<dS)NrrI)rJrLrIrIrKr6scCs|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 rrI)rJrIrIrKr<szWaterfall.increasingcCs ||d<dS)NrrI)rJrLrIrIrKrRscCs|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 rrI)rJrIrIrKrXszWaterfall.insidetextanchorcCs ||d<dS)NrrI)rJrLrIrIrKrhscCs|dS)a 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 Chart Studio Cloud 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 Chart Studio Cloud (at https://chart-studio.plotly.com 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 Chart Studio Cloud for family . size sizesrc Sets the source reference on Chart Studio Cloud for size . Returns ------- plotly.graph_objs.waterfall.Insidetextfont rrI)rJrIrIrKrns0zWaterfall.insidetextfontcCs ||d<dS)NrrI)rJrLrIrIrKrscCs|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 rrI)rJrIrIrKrszWaterfall.legendgroupcCs ||d<dS)NrrI)rJrLrIrIrKrscCs|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 rrI)rJrIrIrKrszWaterfall.measurecCs ||d<dS)NrrI)rJrLrIrIrKrscCs|dS)z Sets the source reference on Chart Studio Cloud for measure . The 'measuresrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rrI)rJrIrIrKrs zWaterfall.measuresrccCs ||d<dS)NrrI)rJrLrIrIrKrscCs|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 rrI)rJrIrIrKrszWaterfall.metacCs ||d<dS)NrrI)rJrLrIrIrKrscCs|dS)z Sets the source reference on Chart Studio Cloud for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r rI)rJrIrIrKr s zWaterfall.metasrccCs ||d<dS)Nr rI)rJrLrIrIrKr 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!rI)rJrIrIrKr!szWaterfall.namecCs ||d<dS)Nr!rI)rJrLrIrIrKr!)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 r"rI)rJrIrIrKr"/szWaterfall.offsetcCs ||d<dS)Nr"rI)rJrLrIrIrKr"@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#rI)rJrIrIrKr#FszWaterfall.offsetgroupcCs ||d<dS)Nr#rI)rJrLrIrIrKr#WscCs|dS)z Sets the source reference on Chart Studio Cloud for offset . The 'offsetsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r$rI)rJrIrIrKr$]s zWaterfall.offsetsrccCs ||d<dS)Nr$rI)rJrLrIrIrKr$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%rI)rJrIrIrKr%qs zWaterfall.opacitycCs ||d<dS)Nr%rI)rJrLrIrIrKr%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&rI)rJrIrIrKr&szWaterfall.orientationcCs ||d<dS)Nr&rI)rJrLrIrIrKr&scCs|dS)a 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 Chart Studio Cloud 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 Chart Studio Cloud (at https://chart-studio.plotly.com 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 Chart Studio Cloud for family . size sizesrc Sets the source reference on Chart Studio Cloud for size . Returns ------- plotly.graph_objs.waterfall.Outsidetextfont r'rI)rJrIrIrKr's0zWaterfall.outsidetextfontcCs ||d<dS)Nr'rI)rJrLrIrIrKr'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(rI)rJrIrIrKr(szWaterfall.selectedpointscCs ||d<dS)Nr(rI)rJrLrIrIrKr(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)rI)rJrIrIrKr)s zWaterfall.showlegendcCs ||d<dS)Nr)rI)rJrLrIrIrKr)scCs|dS)a} 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://chart- studio.plotly.com/settings for more details. Returns ------- plotly.graph_objs.waterfall.Stream r*rI)rJrIrIrKr*szWaterfall.streamcCs ||d<dS)Nr*rI)rJrLrIrIrKr*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+rI)rJrIrIrKr+!szWaterfall.textcCs ||d<dS)Nr+rI)rJrLrIrIrKr+6scCs|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,rI)rJrIrIrKr,<szWaterfall.textanglecCs ||d<dS)Nr,rI)rJrLrIrIrKr,OscCs|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 Chart Studio Cloud 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 Chart Studio Cloud (at https://chart-studio.plotly.com 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 Chart Studio Cloud for family . size sizesrc Sets the source reference on Chart Studio Cloud for size . Returns ------- plotly.graph_objs.waterfall.Textfont r-rI)rJrIrIrKr-Us0zWaterfall.textfontcCs ||d<dS)Nr-rI)rJrLrIrIrKr-scCs|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 r.rI)rJrIrIrKr.szWaterfall.textinfocCs ||d<dS)Nr.rI)rJrLrIrIrKr.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 r/rI)rJrIrIrKr/szWaterfall.textpositioncCs ||d<dS)Nr/rI)rJrLrIrIrKr/scCs|dS)a Sets the source reference on Chart Studio Cloud for textposition . The 'textpositionsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r0rI)rJrIrIrKr0s zWaterfall.textpositionsrccCs ||d<dS)Nr0rI)rJrLrIrIrKr0scCs|dS)z Sets the source reference on Chart Studio Cloud for text . The 'textsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r1rI)rJrIrIrKr1s zWaterfall.textsrccCs ||d<dS)Nr1rI)rJrLrIrIrKr1scCs|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-time- format#locale_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 r2rI)rJrIrIrKr2szWaterfall.texttemplatecCs ||d<dS)Nr2rI)rJrLrIrIrKr2scCs|dS)a Sets the source reference on Chart Studio Cloud for texttemplate . The 'texttemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r3rI)rJrIrIrKr3s zWaterfall.texttemplatesrccCs ||d<dS)Nr3rI)rJrLrIrIrKr3scCs|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 r4rI)rJrIrIrKr4#szWaterfall.totalscCs ||d<dS)Nr4rI)rJrLrIrIrKr49scCs|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 r6rI)rJrIrIrKr6?sz Waterfall.uidcCs ||d<dS)Nr6rI)rJrLrIrIrKr6OscCs|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 r7rI)rJrIrIrKr7UszWaterfall.uirevisioncCs ||d<dS)Nr7rI)rJrLrIrIrKr7pscCs|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 r8rI)rJrIrIrKr8vszWaterfall.visiblecCs ||d<dS)Nr8rI)rJrLrIrIrKr8scCs|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 r9rI)rJrIrIrKr9s zWaterfall.widthcCs ||d<dS)Nr9rI)rJrLrIrIrKr9scCs|dS)z Sets the source reference on Chart Studio Cloud for width . The 'widthsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str r:rI)rJrIrIrKr:s zWaterfall.widthsrccCs ||d<dS)Nr:rI)rJrLrIrIrKr: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;rI)rJrIrIrKr;s z Waterfall.xcCs ||d<dS)Nr;rI)rJrLrIrIrKr;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<rI)rJrIrIrKr<s z Waterfall.x0cCs ||d<dS)Nr<rI)rJrLrIrIrKr<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=rI)rJrIrIrKr=szWaterfall.xaxiscCs ||d<dS)Nr=rI)rJrLrIrIrKr=scCs|dS)a Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M" on the x axis. Special values in the form of "M" could be used to declare the number of months. In this case `n` must be a positive integer. The 'xperiod' property accepts values of any type Returns ------- Any r>rI)rJrIrIrKr>szWaterfall.xperiodcCs ||d<dS)Nr>rI)rJrLrIrIrKr>scCs|dS)a Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. The 'xperiod0' property accepts values of any type Returns ------- Any r?rI)rJrIrIrKr?szWaterfall.xperiod0cCs ||d<dS)Nr?rI)rJrLrIrIrKr?scCs|dS)a^ Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - One of the following enumeration values: ['start', 'middle', 'end'] Returns ------- Any r@rI)rJrIrIrKr@%szWaterfall.xperiodalignmentcCs ||d<dS)Nr@rI)rJrLrIrIrKr@5scCs|dS)z Sets the source reference on Chart Studio Cloud for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rArI)rJrIrIrKrA;s zWaterfall.xsrccCs ||d<dS)NrArI)rJrLrIrIrKrAIscCs|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 rBrI)rJrIrIrKrBOs z Waterfall.ycCs ||d<dS)NrBrI)rJrLrIrIrKrB]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 rCrI)rJrIrIrKrCcs z Waterfall.y0cCs ||d<dS)NrCrI)rJrLrIrIrKrCrscCs|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 rDrI)rJrIrIrKrDxszWaterfall.yaxiscCs ||d<dS)NrDrI)rJrLrIrIrKrDscCs|dS)a Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M" on the y axis. Special values in the form of "M" could be used to declare the number of months. In this case `n` must be a positive integer. The 'yperiod' property accepts values of any type Returns ------- Any rErI)rJrIrIrKrEszWaterfall.yperiodcCs ||d<dS)NrErI)rJrLrIrIrKrEscCs|dS)a Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. The 'yperiod0' property accepts values of any type Returns ------- Any rFrI)rJrIrIrKrFszWaterfall.yperiod0cCs ||d<dS)NrFrI)rJrLrIrIrKrFscCs|dS)a^ Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - One of the following enumeration values: ['start', 'middle', 'end'] Returns ------- Any rGrI)rJrIrIrKrGszWaterfall.yperiodalignmentcCs ||d<dS)NrGrI)rJrLrIrIrKrGscCs|dS)z Sets the source reference on Chart Studio Cloud for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str rHrI)rJrIrIrKrHs zWaterfall.ysrccCs ||d<dS)NrHrI)rJrLrIrIrKrHscCs |jdS)Nr5)_props)rJrIrIrKr5szWaterfall.typecCsdS)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. 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 Chart Studio Cloud 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 Chart Studio Cloud 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-time-format#locale_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://plotly.com/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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud for textposition . textsrc Sets the source reference on Chart Studio Cloud 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-time-format#locale_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 Chart Studio Cloud 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 Chart Studio Cloud 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. xperiod Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M" on the x axis. Special values in the form of "M" could be used to declare the number of months. In this case `n` must be a positive integer. xperiod0 Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. xperiodalignment Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis. xsrc Sets the source reference on Chart Studio Cloud 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. yperiod Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M" on the y axis. Special values in the form of "M" could be used to declare the number of months. In this case `n` must be a positive integer. yperiod0 Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. yperiodalignment Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis. ysrc Sets the source reference on Chart Studio Cloud for y . rI)rJrIrIrK_prop_descriptionss;zWaterfall._prop_descriptionsNcDF s tt|dd|Dkr&|Dd|_dS|dkr4i}n4t||jrJ|}nt|tr`t |}nt d|D dd|_ |D dd|_ | d d}E|dk r|n|E}E|Edk r|E|d <| d d}E|dk r|n|E}E|Edk r|E|d <| d d}E|dk r|n|E}E|Edk r |E|d <| d d}E|dk r$|n|E}E|Edk r:|E|d <| d d}E|dk rT|n|E}E|Edk rj|E|d <| dd}E|dk r|n|E}E|Edk r|E|d<| dd}E|dk r|n|E}E|Edk r|E|d<| dd}E| dk r| n|E}E|Edk r|E|d<| dd}E| dk r| n|E}E|Edk r*|E|d<| dd}E| dk rD| n|E}E|Edk rZ|E|d<| dd}E| dk rt| n|E}E|Edk r|E|d<| dd}E| dk r| n|E}E|Edk r|E|d<| dd}E|dk r|n|E}E|Edk r|E|d<| dd}E|dk r|n|E}E|Edk r|E|d<| dd}E|dk r4|n|E}E|Edk rJ|E|d<| dd}E|dk rd|n|E}E|Edk rz|E|d<| dd}E|dk r|n|E}E|Edk r|E|d<| dd}E|dk r|n|E}E|Edk r|E|d<| dd}E|dk r|n|E}E|Edk r |E|d<| dd}E|dk r$|n|E}E|Edk r:|E|d<| dd}E|dk rT|n|E}E|Edk rj|E|d<| dd}E|dk r|n|E}E|Edk r|E|d<| dd}E|dk r|n|E}E|Edk r|E|d<| d d}E|dk r|n|E}E|Edk r|E|d <| d!d}E|dk r|n|E}E|Edk r*|E|d!<| d"d}E|dk rD|n|E}E|Edk rZ|E|d"<| d#d}E|dk rt|n|E}E|Edk r|E|d#<| d$d}E|dk r|n|E}E|Edk r|E|d$<| d%d}E|dk r|n|E}E|Edk r|E|d%<| d&d}E|dk r|n|E}E|Edk r|E|d&<| d'd}E| dk r4| n|E}E|Edk rJ|E|d'<| d(d}E|!dk rd|!n|E}E|Edk rz|E|d(<| d)d}E|"dk r|"n|E}E|Edk r|E|d)<| d*d}E|#dk r|#n|E}E|Edk r|E|d*<| d+d}E|$dk r|$n|E}E|Edk r |E|d+<| d,d}E|%dk r$|%n|E}E|Edk r:|E|d,<| d-d}E|&dk rT|&n|E}E|Edk rj|E|d-<| d.d}E|'dk r|'n|E}E|Edk r|E|d.<| d/d}E|(dk r|(n|E}E|Edk r|E|d/<| d0d}E|)dk r|)n|E}E|Edk r|E|d0<| d1d}E|*dk r|*n|E}E|Edk r*|E|d1<| d2d}E|+dk rD|+n|E}E|Edk rZ|E|d2<| d3d}E|,dk rt|,n|E}E|Edk r|E|d3<| d4d}E|-dk r|-n|E}E|Edk r|E|d4<| d5d}E|.dk r|.n|E}E|Edk r|E|d5<| d6d}E|/dk r|/n|E}E|Edk r|E|d6<| d7d}E|0dk r4|0n|E}E|Edk rJ|E|d7<| d8d}E|1dk rd|1n|E}E|Edk rz|E|d8<| d9d}E|2dk r|2n|E}E|Edk r|E|d9<| d:d}E|3dk r|3n|E}E|Edk r|E|d:<| d;d}E|4dk r|4n|E}E|Edk r |E|d;<| dd}E|7dk r|7n|E}E|Edk r|E|d><| d?d}E|8dk r|8n|E}E|Edk r|E|d?<| d@d}E|9dk r|9n|E}E|Edk r|E|d@<| dAd}E|:dk r|:n|E}E|Edk r*|E|dA<| dBd}E|;dk rD|;n|E}E|Edk rZ|E|dB<| dCd}E|dk r|>n|E}E|Edk r|E|dE<| dFd}E|?dk r|?n|E}E|Edk r|E|dF<| dGd}E|@dk r4|@n|E}E|Edk rJ|E|dG<| dHd}E|Adk rd|An|E}E|Edk rz|E|dH<| dId}E|Bdk r|Bn|E}E|Edk r|E|dI<| dJd}E|Cdk r|Cn|E}E|Edk r|E|dJ<d|jdK<| dKd|jft|f|Dd|_ dS)La8> 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 Chart Studio Cloud 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 Chart Studio Cloud 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-time-format#locale_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://plotly.com/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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud 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 Chart Studio Cloud for textposition . textsrc Sets the source reference on Chart Studio Cloud 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-time-format#locale_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 Chart Studio Cloud 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 Chart Studio Cloud 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. xperiod Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M" on the x axis. Special values in the form of "M" could be used to declare the number of months. In this case `n` must be a positive integer. xperiod0 Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. xperiodalignment Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis. xsrc Sets the source reference on Chart Studio Cloud 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. yperiod Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M" on the y axis. Special values in the form of "M" could be used to declare the number of months. In this case `n` must be a positive integer. yperiod0 Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. yperiodalignment Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis. ysrc Sets the source reference on Chart Studio Cloud for y . Returns ------- Waterfall r_parentNzThe first argument to the plotly.graph_objs.Waterfall constructor must be a dict or an instance of :class:`plotly.graph_objs.Waterfall`Z skip_invalidF _validateTrrrr r r r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r6r7r8r9r:r;r<r=r>r?r@rArBrCrDrErFrGrHr5)superr__init__rO isinstance __class__Zto_plotly_jsondict_copycopy ValueErrorpopZ _skip_invalidrPrMZ_process_kwargs)FrJargrrrr r r r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r6r7r8r9r:r;r<r=r>r?r@rArBrCrDrErFrGrHkwargsZ_v)rTrIrKrR)s:                                                                                                                                         zWaterfall.__init__)CNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)N__name__ __module__ __qualname__Z_parent_path_strZ _path_strZ _valid_propspropertyrsetterrrr r r r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r6r7r8r9r:r;r<r=r>r?r@rArBrCrDrErFrGrHr5rNrR __classcell__rIrI)rTrKrs              5 #        2            2      2                      ?r)Zplotly.basedatatypesrZ_BaseTraceTyperWrVrrIrIrIrKs