PlotlyWidget.add_funnelarea

PlotlyWidget.add_funnelarea(aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs)

Add a new Funnelarea trace

Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a “pie” trace, wherein each item appears in a single stage. See also the “funnel” trace type for a different approach to visualizing funnel data.

Parameters

  • 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 Chart Studio Cloud for customdata .

  • dlabel – Sets the label step. See label0 for more info.

  • domain – 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 Chart Studio Cloud for hoverinfo .

  • hoverlabel – 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-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 label, color, value, text and percent. Anything contained in tag <extra> is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag <extra></extra>.

  • hovertemplatesrc – Sets the source reference on Chart Studio Cloud 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 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 .

  • 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 Chart Studio Cloud 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 – 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 Chart Studio Cloud 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 – 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 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 label, color, value, text and percent.

  • texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate .

  • title – 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 Chart Studio Cloud 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).

  • row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

  • col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

PlotlyWidget.add_funnel PlotlyWidget.add_heatmap