GeezerVison is showing plotly.com — plotly.graph_objects.Funnelarea — 7.1.0 documentation
-
class
plotly.graph_objects.Funnelarea(arg=None, aspectratio=None, baseratio=None, customdata=None, dlabel=None, domain=None, hoverinfo=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertext=None, ids=None, insidetextfont=None, label0=None, labels=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, name=None, opacity=None, scalegroup=None, showlegend=None, text=None, textfont=None, textinfo=None, textposition=None, texttemplate=None, texttemplatefallback=None, title=None, uid=None, uirevision=None, values=None, visible=None, **kwargs)¶
-
__init__(arg=None, aspectratio=None, baseratio=None, customdata=None, dlabel=None, domain=None, hoverinfo=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertext=None, ids=None, insidetextfont=None, label0=None, labels=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, name=None, opacity=None, scalegroup=None, showlegend=None, text=None, textfont=None, textinfo=None, textposition=None, texttemplate=None, texttemplatefallback=None, title=None, uid=None, uirevision=None, values=None, visible=None, **kwargs)¶
Construct a new Funnelarea object
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
arg – dict of properties compatible with this constructor or
an instance of plotly.graph_objects.Funnelarea
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
dlabel – Sets the label step. See label0 for more info.
domain – plotly.graph_objects.funnelarea.Domain
instance or dict with compatible properties
hoverinfo – Determines what trace information appears on hover.
Flags are rendered in a fixed order; use
hovertemplate if you need explicit control over the
rendered string, including the order of fields and
surrounding text.
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}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#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/tree/v2.2.3#locale_format for details on the
date formatting syntax. Variables that can’t be found
will be replaced with the specifier. For example, a
template of “data: %{x}, %{y}” will result in a value
of “data: 1, %{y}” if x is 1 and y is missing.
Variables with an undefined value will be replaced with
the fallback value. 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, all attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to 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>.
hovertemplatefallback – Fallback string that’s displayed when a variable
referenced in a template is missing. If the boolean
value ‘false’ is passed in, the specifier with the
missing variable will be displayed.
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.
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.
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.
legend – Sets the reference to a legend to show this trace in.
References to these legends are “legend”, “legend2”,
“legend3”, etc. Settings for these legends are set in
the layout, under layout.legend, layout.legend2,
etc.
legendgroup – Sets the legend group for this trace. Traces and shapes
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle – plotly.graph_objects.funnelarea.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
with “reversed” legend.traceorder they are on
bottom/right side. The default legendrank is 1000, so
that you can use ranks less than 1000 to place certain
items before all unranked items, and ranks greater than
1000 to go after all unranked items. When having
unranked or equal rank items shapes would be displayed
after traces i.e. according to their order in data and
layout.
legendwidth – Sets the width (in px or fraction) of the legend for
this trace.
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.
name – Sets the trace name. The trace name appears 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.
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 what trace information appears on the graph.
Flags are rendered in a fixed order; use texttemplate
if you need explicit control over the rendered string,
including the order of fields and surrounding text.
textposition – Specifies the location of the textinfo.
texttemplate – Template string used for rendering the information text
that appears 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-format/tree/v1.4.5#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/tree/v2.2.3#locale_format for details on the
date formatting syntax. Variables that can’t be found
will be replaced with the specifier. For example, a
template of “data: %{x}, %{y}” will result in a value
of “data: 1, %{y}” if x is 1 and y is missing.
Variables with an undefined value will be replaced with
the fallback value. All attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables label, color, value, text and
percent.
texttemplatefallback – Fallback string that’s displayed when a variable
referenced in a template is missing. If the boolean
value ‘false’ is passed in, the specifier with the
missing variable will be displayed.
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.
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
-
- Return type
Funnelarea
-
class
plotly.graph_objects.funnelarea.Domain(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶
-
property
column¶
If there is a layout grid, use the domain for this column in
the grid for this funnelarea trace.
- The ‘column’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
row¶
If there is a layout grid, use the domain for this row in the
grid for this funnelarea trace.
- The ‘row’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
x¶
- Sets the horizontal domain of this funnelarea trace (in plot
fraction).
The ‘x’ property is an info array that may be specified as:
- The ‘x[0]’ property is a number and may be specified as:
-
- The ‘x[1]’ property is a number and may be specified as:
-
list
-
property
y¶
- Sets the vertical domain of this funnelarea trace (in plot
fraction).
The ‘y’ property is an info array that may be specified as:
- The ‘y[0]’ property is a number and may be specified as:
-
- The ‘y[1]’ property is a number and may be specified as:
-
list
-
class
plotly.graph_objects.funnelarea.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=None, showarrow=None, **kwargs)¶
-
property
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
- The ‘align’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
bgcolor¶
Sets the background color of the hover labels for this trace
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
bordercolor¶
Sets the border color of the hover labels for this trace.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
font¶
Sets the font used in hover labels.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.funnelarea.hoverlabel.Font
-
property
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.
- The ‘namelength’ property is an integer and may be specified as:
An int (or float that will be cast to an int)
in the interval [-1, 9223372036854775807]
A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|numpy.ndarray
-
property
showarrow¶
Sets whether or not to show the hover label arrow/triangle
pointing to the data point.
- The ‘showarrow’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.funnelarea.Insidetextfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶
-
property
color¶
- The ‘color’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
family¶
HTML font family - the typeface that will be applied by the web
browser. The web browser can only apply a font if it is
available on the system where it runs. Provide multiple font
families, separated by commas, to indicate the order in which
to apply fonts if they aren’t available.
- The ‘family’ property is a string and must be specified as:
-
- Returns
-
- Return type
str|numpy.ndarray
-
property
lineposition¶
Sets the kind of decoration line(s) with text, such as an
“under”, “over” or “through” as well as combinations e.g.
“under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified
as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters
(e.g. ‘under+over’)
OR exactly one of [‘none’] (e.g. ‘none’)
A list or array of the above
- Returns
-
- Return type
Any|numpy.ndarray
-
property
shadow¶
Sets the shape and color of the shadow behind text. “auto”
places minimal shadow and applies contrast text font color. See
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
for additional options.
- The ‘shadow’ 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
-
- Return type
str|numpy.ndarray
-
property
size¶
- The ‘size’ 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
-
- Return type
int|float|numpy.ndarray
-
property
style¶
Sets whether a font should be styled with a normal or italic
face from its family.
- The ‘style’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
textcase¶
Sets capitalization of text. It can be used to make text appear
in all-uppercase or all-lowercase, or with each word
capitalized.
- The ‘textcase’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
variant¶
Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
weight¶
Sets the weight (or boldness) of the font.
- The ‘weight’ property is an integer and may be specified as:
An int (or float that will be cast to an int)
in the interval [1, 1000]
OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|numpy.ndarray
-
class
plotly.graph_objects.funnelarea.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶
-
property
font¶
Sets this legend group’s title font.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.funnelarea.legendgrouptitle.Font
-
property
text¶
Sets the title of the legend group.
- The ‘text’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
class
plotly.graph_objects.funnelarea.Marker(arg=None, colors=None, line=None, pattern=None, **kwargs)¶
-
property
colors¶
Sets the color of each sector. If not specified, the default
trace color set is used to pick the sector colors.
The ‘colors’ property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
- Returns
-
- Return type
numpy.ndarray
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.funnelarea.marker.Line
-
property
pattern¶
Sets the pattern within the marker.
The ‘pattern’ property is an instance of Pattern
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.funnelarea.marker.Pattern
-
class
plotly.graph_objects.funnelarea.Textfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶
-
property
color¶
- The ‘color’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
family¶
HTML font family - the typeface that will be applied by the web
browser. The web browser can only apply a font if it is
available on the system where it runs. Provide multiple font
families, separated by commas, to indicate the order in which
to apply fonts if they aren’t available.
- The ‘family’ property is a string and must be specified as:
-
- Returns
-
- Return type
str|numpy.ndarray
-
property
lineposition¶
Sets the kind of decoration line(s) with text, such as an
“under”, “over” or “through” as well as combinations e.g.
“under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified
as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters
(e.g. ‘under+over’)
OR exactly one of [‘none’] (e.g. ‘none’)
A list or array of the above
- Returns
-
- Return type
Any|numpy.ndarray
-
property
shadow¶
Sets the shape and color of the shadow behind text. “auto”
places minimal shadow and applies contrast text font color. See
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
for additional options.
- The ‘shadow’ 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
-
- Return type
str|numpy.ndarray
-
property
size¶
- The ‘size’ 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
-
- Return type
int|float|numpy.ndarray
-
property
style¶
Sets whether a font should be styled with a normal or italic
face from its family.
- The ‘style’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
textcase¶
Sets capitalization of text. It can be used to make text appear
in all-uppercase or all-lowercase, or with each word
capitalized.
- The ‘textcase’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
variant¶
Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
weight¶
Sets the weight (or boldness) of the font.
- The ‘weight’ property is an integer and may be specified as:
An int (or float that will be cast to an int)
in the interval [1, 1000]
OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|numpy.ndarray
-
class
plotly.graph_objects.funnelarea.Title(arg=None, font=None, position=None, text=None, **kwargs)¶
-
property
font¶
Sets the font used for title.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.funnelarea.title.Font
-
property
position¶
Specifies the location of the title.
- The ‘position’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top left’, ‘top center’, ‘top right’]
- Returns
-
- Return type
Any
-
property
text¶
Sets the title of the chart. If it is empty, no title is
displayed.
- The ‘text’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
|