Type Alias: FunnelareaTrace
ts
type FunnelareaTrace = Omit<CommonTraceAttributes, 'hoverinfo'> & DomainTraceAttributes & object;Funnel area: stages of a process as stacked trapezoids with areas proportional to their values.
Type Declaration
| Name | Type | Description |
|---|---|---|
aspectratio? | number | Height of the funnel relative to its width. Minimum: 0 |
baseratio? | number | Width of the funnel's narrow end relative to its wide end. Range: 0 – 1 |
dlabel? | number | Label step, see label0. |
hoverinfo? | PerPoint< | "label" | "text" | "value" | "percent" | "name" | `${"label" | "text" | "value" | "percent" | "name"}+${string}` | "all" | "none" | "skip"> | Which fields hover labels show, in a fixed order; 'skip' also turns hover events off for this trace. Default 'all'. |
insidetextfont? | PieTraceInsidetextfont | Font of labels inside slices. Defaults to textfont, with a color contrasting the slice. |
label0? | number | Without labels: numeric labels label0 + i·dlabel (only used when values is set). |
labels? | DataColumn | Slice labels. Slices with the same label are merged: their values are summed (or occurrences counted without values), and other per-slice attributes use the first non-empty entry. |
marker? | FunnelareaTraceMarker | Stage style. |
scalegroup? | string | Funnel areas with the same non-empty scale group are sized by their totals: their areas are proportional to the sums of their values. |
text? | DataColumn | Text per slice, shown on the slice with the text flag of textinfo, and in hover labels unless hovertext is set. |
textfont? | PieTraceTextfont | Font of slice labels. Defaults to layout.font. |
textinfo? | | "label" | "text" | "value" | "percent" | `${"label" | "text" | "value" | "percent"}+${string}` | "none" | What stage labels show, in a fixed order (label, text, value, percent of the total), one per line. Default 'percent', or 'text+percent' when text is an array. Use texttemplate for other layouts. |
textposition? | PerPoint<"inside" | "none"> | Where stage labels go: inside (centered in the stage, shrunk to fit) or none. |
texttemplate? | PerPoint<string | number> | Template for stage labels, overriding textinfo: %{label}, %{value}, %{percent}, %{text}, %{color}, %{customdata}, %{meta}, with optional d3 formats (%{percent:.1%}). Without a format, value and percent are formatted like textinfo. |
title? | FunnelareaTraceTitle | The funnel area title. |
type | "funnelarea" | Trace type. |
values? | DataColumn | Slice values. Non-numeric entries are skipped; merged slices whose total is negative are dropped. Without values every label counts 1. |