Black Lives Matter. Please consider donating to Black Girls Code today.

JavaScript Figure Reference: funnelarea Traces

A funnelarea trace is an object with the key "type" equal to "funnelarea" (i.e. {"type": "funnelarea"}) and any of the keys listed below.

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.

  • type
    Parent: data[type=funnelarea]
    Type: "funnelarea"
  • name
    Parent: data[type=funnelarea]
    Type: string

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

  • title
    Parent: data[type=funnelarea]
    Type: object containing one or more of the keys listed below.
    • text
      Parent: data[type=funnelarea].title
      Type: string
      Default: ""

      Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

    • font
      Parent: data[type=funnelarea].title
      Type: object containing one or more of the keys listed below.

      Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

      • family
        Parent: data[type=funnelarea].title.font
        Type: string or array of strings

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

      • size
        Parent: data[type=funnelarea].title.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=funnelarea].title.font
        Type: color or array of colors
    • position
      Parent: data[type=funnelarea].title
      Type: enumerated , one of ( "top left" | "top center" | "top right" )
      Default: "top center"

      Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.

  • visible
    Parent: data[type=funnelarea]
    Type: enumerated , one of ( true | false | "legendonly" )
    Default: true

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

  • showlegend
    Parent: data[type=funnelarea]
    Type: boolean
    Default: true

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

  • legendgroup
    Parent: data[type=funnelarea]
    Type: string
    Default: ""

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

  • opacity
    Parent: data[type=funnelarea]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=funnelarea]
    Type: data array

    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.

  • values
    Parent: data[type=funnelarea]
    Type: data array

    Sets the values of the sectors. If omitted, we count occurrences of each label.

  • labels
    Parent: data[type=funnelarea]
    Type: data array

    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.

  • dlabel
    Parent: data[type=funnelarea]
    Type: number
    Default: 1

    Sets the label step. See `label0` for more info.

  • label0
    Parent: data[type=funnelarea]
    Type: number
    Default: 0

    Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.

  • text
    Parent: data[type=funnelarea]
    Type: data array

    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.

  • textposition
    Parent: data[type=funnelarea]
    Type: enumerated or array of enumerateds , one of ( "inside" | "none" )
    Default: "inside"

    Specifies the location of the `textinfo`.

  • texttemplate
    Parent: data[type=funnelarea]
    Type: string or array of strings
    Default: ""

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

  • hovertext
    Parent: data[type=funnelarea]
    Type: string or array of strings
    Default: ""

    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.

  • hoverinfo
    Parent: data[type=funnelarea]
    Type: flaglist string. Any combination of "label", "text", "value", "percent", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "label", "text", "label+text", "label+text+value", "all"
    Default: "all"

    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.

  • hovertemplate
    Parent: data[type=funnelarea]
    Type: string or array of strings
    Default: ""

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

  • meta
    Parent: data[type=funnelarea]
    Type: number or categorical coordinate string

    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.

  • customdata
    Parent: data[type=funnelarea]
    Type: data array

    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

  • domain
    Parent: data[type=funnelarea]
    Type: object containing one or more of the keys listed below.
    • x
      Parent: data[type=funnelarea].domain
      Type: array
      Default: [0, 1]

      Sets the horizontal domain of this funnelarea trace (in plot fraction).

    • y
      Parent: data[type=funnelarea].domain
      Type: array
      Default: [0, 1]

      Sets the vertical domain of this funnelarea trace (in plot fraction).

    • row
      Parent: data[type=funnelarea].domain
      Type: integer greater than or equal to 0
      Default: 0

      If there is a layout grid, use the domain for this row in the grid for this funnelarea trace .

    • column
      Parent: data[type=funnelarea].domain
      Type: integer greater than or equal to 0
      Default: 0

      If there is a layout grid, use the domain for this column in the grid for this funnelarea trace .

  • marker
    Parent: data[type=funnelarea]
    Type: object containing one or more of the keys listed below.
    • colors
      Parent: data[type=funnelarea].marker
      Type: data array

      Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.

    • line
      Parent: data[type=funnelarea].marker
      Type: object containing one or more of the keys listed below.
      • color
        Parent: data[type=funnelarea].marker.line
        Type: color or array of colors

        Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.

      • width
        Parent: data[type=funnelarea].marker.line
        Type: number or array of numbers greater than or equal to 0
        Default: 1

        Sets the width (in px) of the line enclosing each sector.

  • textfont
    Parent: data[type=funnelarea]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `textinfo`.

    • family
      Parent: data[type=funnelarea].textfont
      Type: string or array of strings

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

    • size
      Parent: data[type=funnelarea].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=funnelarea].textfont
      Type: color or array of colors
  • textinfo
    Parent: data[type=funnelarea]
    Type: flaglist string. Any combination of "label", "text", "value", "percent" joined with a "+" OR "none".
    Examples: "label", "text", "label+text", "label+text+value", "none"

    Determines which trace information appear on the graph.

  • aspectratio
    Parent: data[type=funnelarea]
    Type: number greater than or equal to 0
    Default: 1

    Sets the ratio between height and width

  • baseratio
    Parent: data[type=funnelarea]
    Type: number between or equal to 0 and 1
    Default: 0.333

    Sets the ratio between bottom length and maximum top length.

  • hoverlabel
    Parent: data[type=funnelarea]
    Type: object containing one or more of the keys listed below.
    • bgcolor
      Parent: data[type=funnelarea].hoverlabel
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Parent: data[type=funnelarea].hoverlabel
      Type: color or array of colors

      Sets the border color of the hover labels for this trace.

    • font
      Parent: data[type=funnelarea].hoverlabel
      Type: object containing one or more of the keys listed below.

      Sets the font used in hover labels.

      • family
        Parent: data[type=funnelarea].hoverlabel.font
        Type: string or array of strings

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

      • size
        Parent: data[type=funnelarea].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=funnelarea].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=funnelarea].hoverlabel
      Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
      Default: "auto"

      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

    • namelength
      Parent: data[type=funnelarea].hoverlabel
      Type: integer or array of integers greater than or equal to -1
      Default: 15

      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.

  • insidetextfont
    Parent: data[type=funnelarea]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `textinfo` lying inside the sector.

    • family
      Parent: data[type=funnelarea].insidetextfont
      Type: string or array of strings

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

    • size
      Parent: data[type=funnelarea].insidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=funnelarea].insidetextfont
      Type: color or array of colors
  • scalegroup
    Parent: data[type=funnelarea]
    Type: string
    Default: ""

    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.

  • uirevision
    Parent: data[type=funnelarea]
    Type: number or categorical coordinate string

    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.