Funnel

Corresponding Plotly trace type.

Switch indicating whether the trace supports animation of its data.

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).

Determines whether or not an item corresponding to this trace is shown in the legend.

Sets the legend group for this trace.

Traces part of the same legend group hide/show at the same time when toggling legend items.

Sets the opacity of the trace.

Sets the trace name.

The trace name appear as the legend item and on hover.

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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.

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

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.

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.

Undocumented

Undocumented

Undocumented

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.

Sets the x coordinates.

Alternate to x.

Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Sets the x coordinate step.

See x0 for more info.

Sets the y coordinates.

Alternate to y.

Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Sets the y coordinate step.

See y0 for more info.

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.

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.

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.

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.

Only relevant when the axis type is date.

Sets the alignment of data points on the x axis.

Only relevant when the axis type is date.

Sets the alignment of data points on the y axis.

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.

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 percentInitial, percentPrevious and percentTotal. Anything contained in tag <extra> is displayed in the secondary box, for example “{fullData.name}”. To hide the secondary box completely, use an empty tag <extra></extra>.

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.

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.

Determines which trace information appear on the graph.

In the case of having multiple funnels, percentages & totals are computed separately (per trace).

Determines which trace information appear on the graph.

In the case of having multiple funnels, percentages & totals are computed separately (per trace).

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 percentInitial, percentPrevious, percentTotal, label and value.

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.

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.

Determines if texts are kept at center or start/end points in textposition inside mode.

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.

Sets the font used for text.

Sets the font used for text lying inside the bar.

Sets the font used for text lying outside the bar.

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

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.

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.

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.

Sets the bar width (in position axis units).

Undocumented

Undocumented

Undocumented

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.

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.

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.

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.

Creates Funnel object from the most frequently used properties.

Creates Funnel object with specified properties.

Encodes the object in a format compatible with Plotly.