R  Figure Reference
Suggest an edit to this page

R Figure Reference

How are Plotly attributes organized?

plotly charts are described declaratively in the call signature of plotly::plot_ly, plotly::add_trace, and plotly::layout. Every aspect of a plotly chart (the colors, the grid-lines, the data, and so on) has a corresponding key in these call signatures. This page contains an extensive list of these attributes.

Plotly's graph description places attributes into two categories: traces (which describe a single series of data in a graph) and layout attributes that apply to the rest of the chart, like the title, xaxis, or annotations).

Here is a simple example of a plotly chart inlined with links to each attribute's reference section. 

library(plotly)

    p <- plot_ly(economics,
                 type = "scatter",        # all "scatter" attributes: https://plotly.com/r/reference/#scatter
                 x = ~date,               # more about scatter's "x": /r/reference/#scatter-x
                 y = ~uempmed,            # more about scatter's "y": /r/reference/#scatter-y
                 name = "unemployment",   # more about scatter's "name": /r/reference/#scatter-name
                 marker = list(           # marker is a named list, valid keys: /r/reference/#scatter-marker
                   color="#264E86"        # more about marker's "color" attribute: /r/reference/#scatter-marker-color
                 )) %>%

      add_trace(x = ~date,                                         # scatter's "x": /r/reference/#scatter-x
                y = ~fitted((loess(uempmed ~ as.numeric(date)))),  # scatter's "y": /r/reference/#scatter-y
                mode = 'lines',                                    # scatter's "y": /r/reference/#scatter-mode
                line = list(                                       # line is a named list, valid keys: /r/reference/#scatter-line
                  color = "#5E88FC",                               # line's "color": /r/reference/#scatter-line-color
                  dash = "dashed"                                  # line's "dash" property: /r/reference/#scatter-line-dash
                )
      ) %>%

      layout(                        # all of layout's properties: /r/reference/#layout
             title = "Unemployment", # layout's title: /r/reference/#layout-title
             xaxis = list(           # layout's xaxis is a named list. List of valid keys: /r/reference/#layout-xaxis
                title = "Time",      # xaxis's title: /r/reference/#layout-xaxis-title
                showgrid = F),       # xaxis's showgrid: /r/reference/#layout-xaxis-showgrid
             yaxis = list(           # layout's yaxis is a named list. List of valid keys: /r/reference/#layout-yaxis
                title = "uidx")     # yaxis's title: /r/reference/#layout-yaxis-title
      )

scatter traces
A scatter trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scatter"[, ...])
add_trace(p, type="scatter"[, ...])
A scatter trace accepts any of the keys listed below.

The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in `x` and `y`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to numerical arrays.

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

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

  • visible
    Parent: data[type=scatter]
    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=scatter]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=scatter]
    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=scatter]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • mode
    Parent: data[type=scatter]
    Type: flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    Examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"

    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".

  • ids
    Parent: data[type=scatter]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=scatter]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=scatter]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=scatter]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • y
    Parent: data[type=scatter]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=scatter]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=scatter]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

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

    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.

  • textposition
    Parent: data[type=scatter]
    Type: enumerated or array of enumerateds , one of ( "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    Default: "middle center"

    Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • texttemplate
    Parent: data[type=scatter]
    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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available.

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

    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.

  • hoverinfo
    Parent: data[type=scatter]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=scatter]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. 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=scatter]
    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=scatter]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=scatter]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=scatter]
    Type: subplotid
    Default: y

    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.

  • orientation
    Parent: data[type=scatter]
    Type: enumerated , one of ( "v" | "h" )

    Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `FALSE`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.

  • groupnorm
    Parent: data[type=scatter]
    Type: enumerated , one of ( "" | "fraction" | "percent" )
    Default: ""

    Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `FALSE`. Sets the normalization for the sum of this `stackgroup`. With "fraction", the value of each trace at each location is divided by the sum of all trace values at that location. "percent" is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.

  • stackgroup
    Parent: data[type=scatter]
    Type: string
    Default: ""

    Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is "h"). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets the default `mode` to "lines" irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • marker
    Parent: data[type=scatter]
    Type: named list containing one or more of the keys listed below.
    • symbol
      Parent: data[type=scatter].marker
      Type: enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      Default: "circle"

      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.

    • opacity
      Parent: data[type=scatter].marker
      Type: number or array of numbers between or equal to 0 and 1

      Sets the marker opacity.

    • size
      Parent: data[type=scatter].marker
      Type: number or array of numbers greater than or equal to 0
      Default: 6

      Sets the marker size (in px).

    • maxdisplayed
      Parent: data[type=scatter].marker
      Type: number greater than or equal to 0
      Default: 0

      Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.

    • sizeref
      Parent: data[type=scatter].marker
      Type: number
      Default: 1

      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.

    • sizemin
      Parent: data[type=scatter].marker
      Type: number greater than or equal to 0
      Default: 0

      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

    • sizemode
      Parent: data[type=scatter].marker
      Type: enumerated , one of ( "diameter" | "area" )
      Default: "diameter"

      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.

    • line
      Parent: data[type=scatter].marker
      Type: named list containing one or more of the keys listed below.
      • width
        Parent: data[type=scatter].marker.line
        Type: number or array of numbers greater than or equal to 0

        Sets the width (in px) of the lines bounding the marker points.

      • color
        Parent: data[type=scatter].marker.line
        Type: color or array of colors

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • cauto
        Parent: data[type=scatter].marker.line
        Type: boolean
        Default: TRUE

        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.

      • cmin
        Parent: data[type=scatter].marker.line
        Type: number

        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.

      • cmax
        Parent: data[type=scatter].marker.line
        Type: number

        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.

      • cmid
        Parent: data[type=scatter].marker.line
        Type: number

        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.

      • colorscale
        Parent: data[type=scatter].marker.line
        Type: colorscale

        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

      • autocolorscale
        Parent: data[type=scatter].marker.line
        Type: boolean
        Default: TRUE

        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

      • reversescale
        Parent: data[type=scatter].marker.line
        Type: boolean

        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.

      • coloraxis
        Parent: data[type=scatter].marker.line
        Type: subplotid

        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • gradient
      Parent: data[type=scatter].marker
      Type: named list containing one or more of the keys listed below.
      • type
        Parent: data[type=scatter].marker.gradient
        Type: enumerated or array of enumerateds , one of ( "radial" | "horizontal" | "vertical" | "none" )
        Default: "none"

        Sets the type of gradient used to fill the markers

      • color
        Parent: data[type=scatter].marker.gradient
        Type: color or array of colors

        Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

    • color
      Parent: data[type=scatter].marker
      Type: color or array of colors

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • cauto
      Parent: data[type=scatter].marker
      Type: boolean
      Default: TRUE

      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.

    • cmin
      Parent: data[type=scatter].marker
      Type: number

      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.

    • cmax
      Parent: data[type=scatter].marker
      Type: number

      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.

    • cmid
      Parent: data[type=scatter].marker
      Type: number

      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.

    • colorscale
      Parent: data[type=scatter].marker
      Type: colorscale

      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    • autocolorscale
      Parent: data[type=scatter].marker
      Type: boolean
      Default: TRUE

      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

    • reversescale
      Parent: data[type=scatter].marker
      Type: boolean

      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.

    • showscale
      Parent: data[type=scatter].marker
      Type: boolean

      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

    • colorbar
      Parent: data[type=scatter].marker
      Type: named list containing one or more of the keys listed below.
      • thicknessmode
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

      • thickness
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 30

        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

      • lenmode
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

      • len
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

      • x
        Parent: data[type=scatter].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the x direction.

      • y
        Parent: data[type=scatter].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the y direction.

      • outlinecolor
        Parent: data[type=scatter].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • bordercolor
        Parent: data[type=scatter].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • bgcolor
        Parent: data[type=scatter].marker.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=scatter].marker.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=scatter].marker.colorbar
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=scatter].marker.colorbar
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=scatter].marker.colorbar
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=scatter].marker.colorbar
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=scatter].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=scatter].marker.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=scatter].marker.colorbar
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=scatter].marker.colorbar
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=scatter].marker.colorbar.tickfont
          Type: string

          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=scatter].marker.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=scatter].marker.colorbar.tickfont
          Type: color
      • tickangle
        Parent: data[type=scatter].marker.colorbar
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=scatter].marker.colorbar
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=scatter].marker.colorbar
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=scatter].marker.colorbar.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=scatter].marker.colorbar.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=scatter].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=scatter].marker.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=scatter].marker.colorbar.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

      • tickprefix
        Parent: data[type=scatter].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=scatter].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=scatter].marker.colorbar
        Type: boolean

        If "TRUE", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=scatter].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

      • title
        Parent: data[type=scatter].marker.colorbar
        Type: named list containing one or more of the keys listed below.
        • text
          Parent: data[type=scatter].marker.colorbar.title
          Type: string

          Sets the title of the color bar. 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=scatter].marker.colorbar.title
          Type: named list containing one or more of the keys listed below.

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

          • family
            Parent: data[type=scatter].marker.colorbar.title.font
            Type: string

            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=scatter].marker.colorbar.title.font
            Type: number greater than or equal to 1
          • color
            Parent: data[type=scatter].marker.colorbar.title.font
            Type: color
        • side
          Parent: data[type=scatter].marker.colorbar.title
          Type: enumerated , one of ( "right" | "top" | "bottom" )
          Default: "top"

          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

    • coloraxis
      Parent: data[type=scatter].marker
      Type: subplotid

      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

  • line
    Parent: data[type=scatter]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=scatter].line
      Type: color

      Sets the line color.

    • width
      Parent: data[type=scatter].line
      Type: number greater than or equal to 0
      Default: 2

      Sets the line width (in px).

    • shape
      Parent: data[type=scatter].line
      Type: enumerated , one of ( "linear" | "spline" | "hv" | "vh" | "hvh" | "vhv" )
      Default: "linear"

      Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

    • smoothing
      Parent: data[type=scatter].line
      Type: number between or equal to 0 and 1.3
      Default: 1

      Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).

    • dash
      Parent: data[type=scatter].line
      Type: string
      Default: "solid"

      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

    • simplify
      Parent: data[type=scatter].line
      Type: boolean
      Default: TRUE

      Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.

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

    Sets the text font.

    • family
      Parent: data[type=scatter].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=scatter].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=scatter].textfont
      Type: color or array of colors
  • error_x
    Parent: data[type=scatter]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=scatter].error_x
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=scatter].error_x
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=scatter].error_x
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=scatter].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=scatter].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=scatter].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=scatter].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=scatter].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=scatter].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • copy_ystyle
      Parent: data[type=scatter].error_x
      Type: boolean
    • color
      Parent: data[type=scatter].error_x
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=scatter].error_x
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=scatter].error_x
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • error_y
    Parent: data[type=scatter]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=scatter].error_y
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=scatter].error_y
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=scatter].error_y
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=scatter].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=scatter].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=scatter].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=scatter].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=scatter].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=scatter].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • color
      Parent: data[type=scatter].error_y
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=scatter].error_y
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=scatter].error_y
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • selectedpoints
    Parent: data[type=scatter]
    Type: number or categorical coordinate string

    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.

  • selected
    Parent: data[type=scatter]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=scatter].selected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=scatter].selected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of selected points.

      • color
        Parent: data[type=scatter].selected.marker
        Type: color

        Sets the marker color of selected points.

      • size
        Parent: data[type=scatter].selected.marker
        Type: number greater than or equal to 0

        Sets the marker size of selected points.

    • textfont
      Parent: data[type=scatter].selected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=scatter].selected.textfont
        Type: color

        Sets the text font color of selected points.

  • unselected
    Parent: data[type=scatter]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=scatter].unselected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=scatter].unselected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of unselected points, applied only when a selection exists.

      • color
        Parent: data[type=scatter].unselected.marker
        Type: color

        Sets the marker color of unselected points, applied only when a selection exists.

      • size
        Parent: data[type=scatter].unselected.marker
        Type: number greater than or equal to 0

        Sets the marker size of unselected points, applied only when a selection exists.

    • textfont
      Parent: data[type=scatter].unselected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=scatter].unselected.textfont
        Type: color

        Sets the text font color of unselected points, applied only when a selection exists.

  • cliponaxis
    Parent: data[type=scatter]
    Type: boolean
    Default: TRUE

    Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".

  • connectgaps
    Parent: data[type=scatter]
    Type: boolean

    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • fill
    Parent: data[type=scatter]
    Type: enumerated , one of ( "none" | "tozeroy" | "tozerox" | "tonexty" | "tonextx" | "toself" | "tonext" )

    Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • fillcolor
    Parent: data[type=scatter]
    Type: color

    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=scatter].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=scatter].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=scatter].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=scatter].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=scatter].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.

  • hoveron
    Parent: data[type=scatter]
    Type: flaglist string. Any combination of "points", "fills" joined with a "+"
    Examples: "points", "fills", "points+fills"

    Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points".

  • stackgaps
    Parent: data[type=scatter]
    Type: enumerated , one of ( "infer zero" | "interpolate" )
    Default: "infer zero"

    Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `FALSE`. Determines how we handle locations at which other traces in this group have data but this one does not. With "infer zero" we insert a zero at these locations. With "interpolate" we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.

  • xcalendar
    Parent: data[type=scatter]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=scatter]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=scatter]
    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.

scattergl traces
A scattergl trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scattergl"[, ...])
add_trace(p, type="scattergl"[, ...])
A scattergl trace accepts any of the keys listed below.

The data visualized as scatter point or lines is set in `x` and `y` using the WebGL plotting engine. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.

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

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

  • visible
    Parent: data[type=scattergl]
    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=scattergl]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=scattergl]
    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=scattergl]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • mode
    Parent: data[type=scattergl]
    Type: flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    Examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"

    Determines the drawing mode for this scatter trace.

  • ids
    Parent: data[type=scattergl]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=scattergl]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=scattergl]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=scattergl]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • y
    Parent: data[type=scattergl]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=scattergl]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=scattergl]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

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

    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.

  • textposition
    Parent: data[type=scattergl]
    Type: enumerated or array of enumerateds , one of ( "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    Default: "middle center"

    Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • texttemplate
    Parent: data[type=scattergl]
    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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available.

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

    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.

  • hoverinfo
    Parent: data[type=scattergl]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=scattergl]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. 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=scattergl]
    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=scattergl]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=scattergl]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=scattergl]
    Type: subplotid
    Default: y

    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.

  • marker
    Parent: data[type=scattergl]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=scattergl].marker
      Type: color or array of colors

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • cauto
      Parent: data[type=scattergl].marker
      Type: boolean
      Default: TRUE

      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.

    • cmin
      Parent: data[type=scattergl].marker
      Type: number

      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.

    • cmax
      Parent: data[type=scattergl].marker
      Type: number

      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.

    • cmid
      Parent: data[type=scattergl].marker
      Type: number

      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.

    • colorscale
      Parent: data[type=scattergl].marker
      Type: colorscale

      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    • autocolorscale
      Parent: data[type=scattergl].marker
      Type: boolean
      Default: TRUE

      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

    • reversescale
      Parent: data[type=scattergl].marker
      Type: boolean

      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.

    • showscale
      Parent: data[type=scattergl].marker
      Type: boolean

      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

    • colorbar
      Parent: data[type=scattergl].marker
      Type: named list containing one or more of the keys listed below.
      • thicknessmode
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

      • thickness
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 30

        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

      • lenmode
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

      • len
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

      • x
        Parent: data[type=scattergl].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the x direction.

      • y
        Parent: data[type=scattergl].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the y direction.

      • outlinecolor
        Parent: data[type=scattergl].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • bordercolor
        Parent: data[type=scattergl].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • bgcolor
        Parent: data[type=scattergl].marker.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=scattergl].marker.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=scattergl].marker.colorbar
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=scattergl].marker.colorbar
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=scattergl].marker.colorbar
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=scattergl].marker.colorbar
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=scattergl].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=scattergl].marker.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=scattergl].marker.colorbar
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=scattergl].marker.colorbar
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=scattergl].marker.colorbar.tickfont
          Type: string

          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=scattergl].marker.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=scattergl].marker.colorbar.tickfont
          Type: color
      • tickangle
        Parent: data[type=scattergl].marker.colorbar
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=scattergl].marker.colorbar
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=scattergl].marker.colorbar
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=scattergl].marker.colorbar.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=scattergl].marker.colorbar.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=scattergl].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=scattergl].marker.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=scattergl].marker.colorbar.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

      • tickprefix
        Parent: data[type=scattergl].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=scattergl].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=scattergl].marker.colorbar
        Type: boolean

        If "TRUE", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=scattergl].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

      • title
        Parent: data[type=scattergl].marker.colorbar
        Type: named list containing one or more of the keys listed below.
        • text
          Parent: data[type=scattergl].marker.colorbar.title
          Type: string

          Sets the title of the color bar. 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=scattergl].marker.colorbar.title
          Type: named list containing one or more of the keys listed below.

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

          • family
            Parent: data[type=scattergl].marker.colorbar.title.font
            Type: string

            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=scattergl].marker.colorbar.title.font
            Type: number greater than or equal to 1
          • color
            Parent: data[type=scattergl].marker.colorbar.title.font
            Type: color
        • side
          Parent: data[type=scattergl].marker.colorbar.title
          Type: enumerated , one of ( "right" | "top" | "bottom" )
          Default: "top"

          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

    • coloraxis
      Parent: data[type=scattergl].marker
      Type: subplotid

      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • symbol
      Parent: data[type=scattergl].marker
      Type: enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      Default: "circle"

      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.

    • size
      Parent: data[type=scattergl].marker
      Type: number or array of numbers greater than or equal to 0
      Default: 6

      Sets the marker size (in px).

    • sizeref
      Parent: data[type=scattergl].marker
      Type: number
      Default: 1

      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.

    • sizemin
      Parent: data[type=scattergl].marker
      Type: number greater than or equal to 0
      Default: 0

      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

    • sizemode
      Parent: data[type=scattergl].marker
      Type: enumerated , one of ( "diameter" | "area" )
      Default: "diameter"

      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.

    • opacity
      Parent: data[type=scattergl].marker
      Type: number or array of numbers between or equal to 0 and 1

      Sets the marker opacity.

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

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • cauto
        Parent: data[type=scattergl].marker.line
        Type: boolean
        Default: TRUE

        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.

      • cmin
        Parent: data[type=scattergl].marker.line
        Type: number

        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.

      • cmax
        Parent: data[type=scattergl].marker.line
        Type: number

        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.

      • cmid
        Parent: data[type=scattergl].marker.line
        Type: number

        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.

      • colorscale
        Parent: data[type=scattergl].marker.line
        Type: colorscale

        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

      • autocolorscale
        Parent: data[type=scattergl].marker.line
        Type: boolean
        Default: TRUE

        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

      • reversescale
        Parent: data[type=scattergl].marker.line
        Type: boolean

        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.

      • coloraxis
        Parent: data[type=scattergl].marker.line
        Type: subplotid

        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

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

        Sets the width (in px) of the lines bounding the marker points.

  • line
    Parent: data[type=scattergl]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=scattergl].line
      Type: color

      Sets the line color.

    • width
      Parent: data[type=scattergl].line
      Type: number greater than or equal to 0
      Default: 2

      Sets the line width (in px).

    • shape
      Parent: data[type=scattergl].line
      Type: enumerated , one of ( "linear" | "hv" | "vh" | "hvh" | "vhv" )
      Default: "linear"

      Determines the line shape. The values correspond to step-wise line shapes.

    • dash
      Parent: data[type=scattergl].line
      Type: enumerated , one of ( "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
      Default: "solid"

      Sets the style of the lines.

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

    Sets the text font.

    • family
      Parent: data[type=scattergl].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=scattergl].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=scattergl].textfont
      Type: color or array of colors
  • error_x
    Parent: data[type=scattergl]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=scattergl].error_x
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=scattergl].error_x
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=scattergl].error_x
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=scattergl].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=scattergl].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=scattergl].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=scattergl].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=scattergl].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=scattergl].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • copy_ystyle
      Parent: data[type=scattergl].error_x
      Type: boolean
    • color
      Parent: data[type=scattergl].error_x
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=scattergl].error_x
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=scattergl].error_x
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • error_y
    Parent: data[type=scattergl]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=scattergl].error_y
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=scattergl].error_y
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=scattergl].error_y
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=scattergl].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=scattergl].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=scattergl].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=scattergl].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=scattergl].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=scattergl].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • color
      Parent: data[type=scattergl].error_y
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=scattergl].error_y
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=scattergl].error_y
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • selectedpoints
    Parent: data[type=scattergl]
    Type: number or categorical coordinate string

    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.

  • selected
    Parent: data[type=scattergl]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=scattergl].selected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=scattergl].selected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of selected points.

      • color
        Parent: data[type=scattergl].selected.marker
        Type: color

        Sets the marker color of selected points.

      • size
        Parent: data[type=scattergl].selected.marker
        Type: number greater than or equal to 0

        Sets the marker size of selected points.

    • textfont
      Parent: data[type=scattergl].selected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=scattergl].selected.textfont
        Type: color

        Sets the text font color of selected points.

  • unselected
    Parent: data[type=scattergl]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=scattergl].unselected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=scattergl].unselected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of unselected points, applied only when a selection exists.

      • color
        Parent: data[type=scattergl].unselected.marker
        Type: color

        Sets the marker color of unselected points, applied only when a selection exists.

      • size
        Parent: data[type=scattergl].unselected.marker
        Type: number greater than or equal to 0

        Sets the marker size of unselected points, applied only when a selection exists.

    • textfont
      Parent: data[type=scattergl].unselected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=scattergl].unselected.textfont
        Type: color

        Sets the text font color of unselected points, applied only when a selection exists.

  • connectgaps
    Parent: data[type=scattergl]
    Type: boolean

    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • fill
    Parent: data[type=scattergl]
    Type: enumerated , one of ( "none" | "tozeroy" | "tozerox" | "tonexty" | "tonextx" | "toself" | "tonext" )
    Default: "none"

    Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • fillcolor
    Parent: data[type=scattergl]
    Type: color

    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=scattergl].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=scattergl].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=scattergl].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=scattergl].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=scattergl].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.

  • xcalendar
    Parent: data[type=scattergl]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=scattergl]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=scattergl]
    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.

bar traces
A bar trace is initialized with plot_ly or add_trace:
plot_ly(df, type="bar"[, ...])
add_trace(p, type="bar"[, ...])
A bar trace accepts any of the keys listed below.

The data visualized by the span of the bars is set in `y` if `orientation` is set th "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.

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

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

  • visible
    Parent: data[type=bar]
    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=bar]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=bar]
    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=bar]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=bar]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=bar]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=bar]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=bar]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • y
    Parent: data[type=bar]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=bar]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=bar]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

  • base
    Parent: data[type=bar]
    Type: number or categorical coordinate string

    Sets where the bar base is drawn (in position axis units). In "stack" or "relative" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead.

  • width
    Parent: data[type=bar]
    Type: number or array of numbers greater than or equal to 0

    Sets the bar width (in position axis units).

  • offset
    Parent: data[type=bar]
    Type: number or array of numbers

    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.

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

    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.

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

    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.

  • texttemplate
    Parent: data[type=bar]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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 `value` and `label`.

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

    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.

  • hoverinfo
    Parent: data[type=bar]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=bar]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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 `value` and `label`. 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=bar]
    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=bar]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=bar]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=bar]
    Type: subplotid
    Default: y

    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.

  • orientation
    Parent: data[type=bar]
    Type: enumerated , one of ( "v" | "h" )

    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).

  • alignmentgroup
    Parent: data[type=bar]
    Type: string
    Default: ""

    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.

  • offsetgroup
    Parent: data[type=bar]
    Type: string
    Default: ""

    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.

  • marker
    Parent: data[type=bar]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=bar].marker
      Type: named list containing one or more of the keys listed below.
      • width
        Parent: data[type=bar].marker.line
        Type: number or array of numbers greater than or equal to 0
        Default: 0

        Sets the width (in px) of the lines bounding the marker points.

      • color
        Parent: data[type=bar].marker.line
        Type: color or array of colors

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • cauto
        Parent: data[type=bar].marker.line
        Type: boolean
        Default: TRUE

        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.

      • cmin
        Parent: data[type=bar].marker.line
        Type: number

        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.

      • cmax
        Parent: data[type=bar].marker.line
        Type: number

        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.

      • cmid
        Parent: data[type=bar].marker.line
        Type: number

        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.

      • colorscale
        Parent: data[type=bar].marker.line
        Type: colorscale

        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

      • autocolorscale
        Parent: data[type=bar].marker.line
        Type: boolean
        Default: TRUE

        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

      • reversescale
        Parent: data[type=bar].marker.line
        Type: boolean

        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.

      • coloraxis
        Parent: data[type=bar].marker.line
        Type: subplotid

        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • color
      Parent: data[type=bar].marker
      Type: color or array of colors

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • cauto
      Parent: data[type=bar].marker
      Type: boolean
      Default: TRUE

      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.

    • cmin
      Parent: data[type=bar].marker
      Type: number

      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.

    • cmax
      Parent: data[type=bar].marker
      Type: number

      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.

    • cmid
      Parent: data[type=bar].marker
      Type: number

      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.

    • colorscale
      Parent: data[type=bar].marker
      Type: colorscale

      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    • autocolorscale
      Parent: data[type=bar].marker
      Type: boolean
      Default: TRUE

      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

    • reversescale
      Parent: data[type=bar].marker
      Type: boolean

      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.

    • showscale
      Parent: data[type=bar].marker
      Type: boolean

      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

    • colorbar
      Parent: data[type=bar].marker
      Type: named list containing one or more of the keys listed below.
      • thicknessmode
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

      • thickness
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 30

        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

      • lenmode
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

      • len
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

      • x
        Parent: data[type=bar].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the x direction.

      • y
        Parent: data[type=bar].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the y direction.

      • outlinecolor
        Parent: data[type=bar].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • bordercolor
        Parent: data[type=bar].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • bgcolor
        Parent: data[type=bar].marker.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=bar].marker.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=bar].marker.colorbar
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=bar].marker.colorbar
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=bar].marker.colorbar
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=bar].marker.colorbar
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=bar].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=bar].marker.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=bar].marker.colorbar
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=bar].marker.colorbar
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=bar].marker.colorbar.tickfont
          Type: string

          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=bar].marker.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=bar].marker.colorbar.tickfont
          Type: color
      • tickangle
        Parent: data[type=bar].marker.colorbar
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=bar].marker.colorbar
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=bar].marker.colorbar
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=bar].marker.colorbar.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=bar].marker.colorbar.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=bar].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=bar].marker.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=bar].marker.colorbar.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

      • tickprefix
        Parent: data[type=bar].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=bar].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=bar].marker.colorbar
        Type: boolean

        If "TRUE", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=bar].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

      • title
        Parent: data[type=bar].marker.colorbar
        Type: named list containing one or more of the keys listed below.
        • text
          Parent: data[type=bar].marker.colorbar.title
          Type: string

          Sets the title of the color bar. 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=bar].marker.colorbar.title
          Type: named list containing one or more of the keys listed below.

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

          • family
            Parent: data[type=bar].marker.colorbar.title.font
            Type: string

            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=bar].marker.colorbar.title.font
            Type: number greater than or equal to 1
          • color
            Parent: data[type=bar].marker.colorbar.title.font
            Type: color
        • side
          Parent: data[type=bar].marker.colorbar.title
          Type: enumerated , one of ( "right" | "top" | "bottom" )
          Default: "top"

          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

    • coloraxis
      Parent: data[type=bar].marker
      Type: subplotid

      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • opacity
      Parent: data[type=bar].marker
      Type: number or array of numbers between or equal to 0 and 1
      Default: 1

      Sets the opacity of the bars.

  • textangle
    Parent: data[type=bar]
    Type: angle
    Default: "auto"

    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.

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

    Sets the font used for `text`.

    • family
      Parent: data[type=bar].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=bar].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=bar].textfont
      Type: color or array of colors
  • error_x
    Parent: data[type=bar]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=bar].error_x
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=bar].error_x
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=bar].error_x
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=bar].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=bar].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=bar].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=bar].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=bar].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=bar].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • copy_ystyle
      Parent: data[type=bar].error_x
      Type: boolean
    • color
      Parent: data[type=bar].error_x
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=bar].error_x
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=bar].error_x
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • error_y
    Parent: data[type=bar]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=bar].error_y
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=bar].error_y
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=bar].error_y
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=bar].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=bar].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=bar].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=bar].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=bar].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=bar].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • color
      Parent: data[type=bar].error_y
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=bar].error_y
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=bar].error_y
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • selectedpoints
    Parent: data[type=bar]
    Type: number or categorical coordinate string

    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.

  • selected
    Parent: data[type=bar]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=bar].selected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=bar].selected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of selected points.

      • color
        Parent: data[type=bar].selected.marker
        Type: color

        Sets the marker color of selected points.

    • textfont
      Parent: data[type=bar].selected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=bar].selected.textfont
        Type: color

        Sets the text font color of selected points.

  • unselected
    Parent: data[type=bar]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=bar].unselected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=bar].unselected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of unselected points, applied only when a selection exists.

      • color
        Parent: data[type=bar].unselected.marker
        Type: color

        Sets the marker color of unselected points, applied only when a selection exists.

    • textfont
      Parent: data[type=bar].unselected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=bar].unselected.textfont
        Type: color

        Sets the text font color of unselected points, applied only when a selection exists.

  • cliponaxis
    Parent: data[type=bar]
    Type: boolean
    Default: TRUE

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

  • constraintext
    Parent: data[type=bar]
    Type: enumerated , one of ( "inside" | "outside" | "both" | "none" )
    Default: "both"

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

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=bar].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=bar].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=bar].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=bar].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=bar].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.

  • insidetextanchor
    Parent: data[type=bar]
    Type: enumerated , one of ( "end" | "middle" | "start" )
    Default: "end"

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

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

    Sets the font used for `text` lying inside the bar.

    • family
      Parent: data[type=bar].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=bar].insidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=bar].insidetextfont
      Type: color or array of colors
  • outsidetextfont
    Parent: data[type=bar]
    Type: named list containing one or more of the keys listed below.

    Sets the font used for `text` lying outside the bar.

    • family
      Parent: data[type=bar].outsidetextfont
      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=bar].outsidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=bar].outsidetextfont
      Type: color or array of colors
  • xcalendar
    Parent: data[type=bar]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=bar]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=bar]
    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.

pie traces
A pie trace is initialized with plot_ly or add_trace:
plot_ly(df, type="pie"[, ...])
add_trace(p, type="pie"[, ...])
A pie trace accepts any of the keys listed below.

A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`

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

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

  • title
    Parent: data[type=pie]
    Type: named list containing one or more of the keys listed below.
    • text
      Parent: data[type=pie].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=pie].title
      Type: named list 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=pie].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=pie].title.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=pie].title.font
        Type: color or array of colors
    • position
      Parent: data[type=pie].title
      Type: enumerated , one of ( "top left" | "top center" | "top right" | "middle center" | "bottom left" | "bottom center" | "bottom right" )

      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=pie]
    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=pie]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=pie]
    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=pie]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=pie]
    Type: dataframe column, list, vector

    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=pie]
    Type: dataframe column, list, vector

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

  • labels
    Parent: data[type=pie]
    Type: dataframe column, list, vector

    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=pie]
    Type: number
    Default: 1

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

  • label0
    Parent: data[type=pie]
    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.

  • pull
    Parent: data[type=pie]
    Type: number or array of numbers between or equal to 0 and 1
    Default: 0

    Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.

  • text
    Parent: data[type=pie]
    Type: dataframe column, list, vector

    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=pie]
    Type: enumerated or array of enumerateds , one of ( "inside" | "outside" | "auto" | "none" )
    Default: "auto"

    Specifies the location of the `textinfo`.

  • texttemplate
    Parent: data[type=pie]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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`, `percent` and `text`.

  • hovertext
    Parent: data[type=pie]
    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=pie]
    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=pie]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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`, `percent` and `text`. 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=pie]
    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=pie]
    Type: dataframe column, list, vector

    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=pie]
    Type: named list containing one or more of the keys listed below.
    • x
      Parent: data[type=pie].domain
      Type: list
      Default: [0, 1]

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

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

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

    • row
      Parent: data[type=pie].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 pie trace .

    • column
      Parent: data[type=pie].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 pie trace .

  • automargin
    Parent: data[type=pie]
    Type: boolean

    Determines whether outside text labels can push the margins.

  • marker
    Parent: data[type=pie]
    Type: named list containing one or more of the keys listed below.
    • colors
      Parent: data[type=pie].marker
      Type: dataframe column, list, vector

      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=pie].marker
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=pie].marker.line
        Type: color or array of colors
        Default: "#444"

        Sets the color of the line enclosing each sector.

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

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

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

    Sets the font used for `textinfo`.

    • family
      Parent: data[type=pie].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=pie].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=pie].textfont
      Type: color or array of colors
  • textinfo
    Parent: data[type=pie]
    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.

  • direction
    Parent: data[type=pie]
    Type: enumerated , one of ( "clockwise" | "counterclockwise" )
    Default: "counterclockwise"

    Specifies the direction at which succeeding sectors follow one another.

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

    Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=pie].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=pie].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=pie].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=pie].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=pie].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=pie]
    Type: named list containing one or more of the keys listed below.

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

    • family
      Parent: data[type=pie].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=pie].insidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=pie].insidetextfont
      Type: color or array of colors
  • insidetextorientation
    Parent: data[type=pie]
    Type: enumerated , one of ( "horizontal" | "radial" | "tangential" | "auto" )
    Default: "auto"

    Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector.

  • outsidetextfont
    Parent: data[type=pie]
    Type: named list containing one or more of the keys listed below.

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

    • family
      Parent: data[type=pie].outsidetextfont
      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=pie].outsidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=pie].outsidetextfont
      Type: color or array of colors
  • rotation
    Parent: data[type=pie]
    Type: number between or equal to -360 and 360
    Default: 0

    Instead of the first slice starting at 12 o'clock, rotate to some other angle.

  • scalegroup
    Parent: data[type=pie]
    Type: string
    Default: ""

    If there are multiple pie charts 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.

  • sort
    Parent: data[type=pie]
    Type: boolean
    Default: TRUE

    Determines whether or not the sectors are reordered from largest to smallest.

  • uirevision
    Parent: data[type=pie]
    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.

heatmap traces
A heatmap trace is initialized with plot_ly or add_trace:
plot_ly(df, type="heatmap"[, ...])
add_trace(p, type="heatmap"[, ...])
A heatmap trace accepts any of the keys listed below.

The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a 2D list of values (ragged or not) or a 1D array of values. In the case where `z` is a 2D list, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements. If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D list, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets.

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

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

  • visible
    Parent: data[type=heatmap]
    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=heatmap]
    Type: boolean

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

  • legendgroup
    Parent: data[type=heatmap]
    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=heatmap]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=heatmap]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=heatmap]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=heatmap]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=heatmap]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • xtype
    Parent: data[type=heatmap]
    Type: enumerated , one of ( "array" | "scaled" )

    If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).

  • xgap
    Parent: data[type=heatmap]
    Type: number greater than or equal to 0
    Default: 0

    Sets the horizontal gap (in pixels) between bricks.

  • y
    Parent: data[type=heatmap]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=heatmap]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=heatmap]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

  • ytype
    Parent: data[type=heatmap]
    Type: enumerated , one of ( "array" | "scaled" )

    If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)

  • ygap
    Parent: data[type=heatmap]
    Type: number greater than or equal to 0
    Default: 0

    Sets the vertical gap (in pixels) between bricks.

  • z
    Parent: data[type=heatmap]
    Type: dataframe column, list, vector

    Sets the z data.

  • text
    Parent: data[type=heatmap]
    Type: dataframe column, list, vector

    Sets the text elements associated with each z value.

  • hovertext
    Parent: data[type=heatmap]
    Type: dataframe column, list, vector

    Same as `text`.

  • hoverinfo
    Parent: data[type=heatmap]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=heatmap]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. 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=heatmap]
    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=heatmap]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=heatmap]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=heatmap]
    Type: subplotid
    Default: y

    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.

  • coloraxis
    Parent: data[type=heatmap]
    Type: subplotid

    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

  • colorbar
    Parent: data[type=heatmap]
    Type: named list containing one or more of the keys listed below.
    • thicknessmode
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "pixels"

      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

    • thickness
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 30

      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    • lenmode
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "fraction"

      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

    • len
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

    • x
      Parent: data[type=heatmap].colorbar
      Type: number between or equal to -2 and 3
      Default: 1.02

      Sets the x position of the color bar (in plot fraction).

    • xanchor
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "left" | "center" | "right" )
      Default: "left"

      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

    • xpad
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the x direction.

    • y
      Parent: data[type=heatmap].colorbar
      Type: number between or equal to -2 and 3
      Default: 0.5

      Sets the y position of the color bar (in plot fraction).

    • yanchor
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "top" | "middle" | "bottom" )
      Default: "middle"

      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

    • ypad
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the y direction.

    • outlinecolor
      Parent: data[type=heatmap].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • outlinewidth
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • bordercolor
      Parent: data[type=heatmap].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • borderwidth
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 0

      Sets the width (in px) or the border enclosing this color bar.

    • bgcolor
      Parent: data[type=heatmap].colorbar
      Type: color
      Default: "rgba(0,0,0,0)"

      Sets the color of padded area.

    • tickmode
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "auto" | "linear" | "array" )

      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

    • nticks
      Parent: data[type=heatmap].colorbar
      Type: integer greater than or equal to 0
      Default: 0

      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

    • tick0
      Parent: data[type=heatmap].colorbar
      Type: number or categorical coordinate string

      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick
      Parent: data[type=heatmap].colorbar
      Type: number or categorical coordinate string

      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

    • tickvals
      Parent: data[type=heatmap].colorbar
      Type: dataframe column, list, vector

      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

    • ticktext
      Parent: data[type=heatmap].colorbar
      Type: dataframe column, list, vector

      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

    • ticks
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "outside" | "inside" | "" )
      Default: ""

      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

    • ticklen
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 5

      Sets the tick length (in px).

    • tickwidth
      Parent: data[type=heatmap].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the tick width (in px).

    • tickcolor
      Parent: data[type=heatmap].colorbar
      Type: color
      Default: "#444"

      Sets the tick color.

    • showticklabels
      Parent: data[type=heatmap].colorbar
      Type: boolean
      Default: TRUE

      Determines whether or not the tick labels are drawn.

    • tickfont
      Parent: data[type=heatmap].colorbar
      Type: named list containing one or more of the keys listed below.

      Sets the color bar's tick label font

      • family
        Parent: data[type=heatmap].colorbar.tickfont
        Type: string

        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=heatmap].colorbar.tickfont
        Type: number greater than or equal to 1
      • color
        Parent: data[type=heatmap].colorbar.tickfont
        Type: color
    • tickangle
      Parent: data[type=heatmap].colorbar
      Type: angle
      Default: "auto"

      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickformat
      Parent: data[type=heatmap].colorbar
      Type: string
      Default: ""

      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

    • tickformatstops
      Parent: data[type=heatmap].colorbar
      Type: list of named list where each named list has one or more of the keys listed below.
      • enabled
        Parent: data[type=heatmap].colorbar.tickformatstops[]
        Type: boolean
        Default: TRUE

        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

      • dtickrange
        Parent: data[type=heatmap].colorbar.tickformatstops[]
        Type: list

        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

      • value
        Parent: data[type=heatmap].colorbar.tickformatstops[]
        Type: string
        Default: ""

        string - dtickformat for described zoom level, the same as "tickformat"

      • name
        Parent: data[type=heatmap].colorbar.tickformatstops[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=heatmap].colorbar.tickformatstops[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

    • tickprefix
      Parent: data[type=heatmap].colorbar
      Type: string
      Default: ""

      Sets a tick label prefix.

    • showtickprefix
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

    • ticksuffix
      Parent: data[type=heatmap].colorbar
      Type: string
      Default: ""

      Sets a tick label suffix.

    • showticksuffix
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • separatethousands
      Parent: data[type=heatmap].colorbar
      Type: boolean

      If "TRUE", even 4-digit integers are separated

    • exponentformat
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
      Default: "B"

      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

    • showexponent
      Parent: data[type=heatmap].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

    • title
      Parent: data[type=heatmap].colorbar
      Type: named list containing one or more of the keys listed below.
      • text
        Parent: data[type=heatmap].colorbar.title
        Type: string

        Sets the title of the color bar. 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=heatmap].colorbar.title
        Type: named list containing one or more of the keys listed below.

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

        • family
          Parent: data[type=heatmap].colorbar.title.font
          Type: string

          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=heatmap].colorbar.title.font
          Type: number greater than or equal to 1
        • color
          Parent: data[type=heatmap].colorbar.title.font
          Type: color
      • side
        Parent: data[type=heatmap].colorbar.title
        Type: enumerated , one of ( "right" | "top" | "bottom" )
        Default: "top"

        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

  • autocolorscale
    Parent: data[type=heatmap]
    Type: boolean

    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

  • colorscale
    Parent: data[type=heatmap]
    Type: colorscale

    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • showscale
    Parent: data[type=heatmap]
    Type: boolean
    Default: TRUE

    Determines whether or not a colorbar is displayed for this trace.

  • reversescale
    Parent: data[type=heatmap]
    Type: boolean

    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

  • zauto
    Parent: data[type=heatmap]
    Type: boolean
    Default: TRUE

    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.

  • zhoverformat
    Parent: data[type=heatmap]
    Type: string
    Default: ""

    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • zmax
    Parent: data[type=heatmap]
    Type: number

    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid
    Parent: data[type=heatmap]
    Type: number

    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.

  • zmin
    Parent: data[type=heatmap]
    Type: number

    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zsmooth
    Parent: data[type=heatmap]
    Type: enumerated , one of ( "fast" | "best" | FALSE )

    Picks a smoothing algorithm use to smooth `z` data.

  • connectgaps
    Parent: data[type=heatmap]
    Type: boolean

    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to TRUE if `z` is a one dimensional array and `zsmooth` is not FALSE; otherwise it is defaulted to FALSE.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=heatmap].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=heatmap].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=heatmap].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=heatmap].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=heatmap].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.

  • hoverongaps
    Parent: data[type=heatmap]
    Type: boolean
    Default: TRUE

    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.

  • transpose
    Parent: data[type=heatmap]
    Type: boolean

    Transposes the z data.

  • xcalendar
    Parent: data[type=heatmap]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=heatmap]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=heatmap]
    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.

heatmapgl traces
A heatmapgl trace is initialized with plot_ly or add_trace:
plot_ly(df, type="heatmapgl"[, ...])
add_trace(p, type="heatmapgl"[, ...])
A heatmapgl trace accepts any of the keys listed below.

WebGL version of the heatmap trace type.

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

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

  • visible
    Parent: data[type=heatmapgl]
    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).

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

    Sets the opacity of the trace.

  • ids
    Parent: data[type=heatmapgl]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=heatmapgl]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=heatmapgl]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=heatmapgl]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • xtype
    Parent: data[type=heatmapgl]
    Type: enumerated , one of ( "array" | "scaled" )

    If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).

  • y
    Parent: data[type=heatmapgl]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=heatmapgl]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=heatmapgl]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

  • ytype
    Parent: data[type=heatmapgl]
    Type: enumerated , one of ( "array" | "scaled" )

    If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)

  • z
    Parent: data[type=heatmapgl]
    Type: dataframe column, list, vector

    Sets the z data.

  • text
    Parent: data[type=heatmapgl]
    Type: dataframe column, list, vector

    Sets the text elements associated with each z value.

  • hoverinfo
    Parent: data[type=heatmapgl]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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.

  • meta
    Parent: data[type=heatmapgl]
    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=heatmapgl]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=heatmapgl]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=heatmapgl]
    Type: subplotid
    Default: y

    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.

  • coloraxis
    Parent: data[type=heatmapgl]
    Type: subplotid

    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

  • colorbar
    Parent: data[type=heatmapgl]
    Type: named list containing one or more of the keys listed below.
    • thicknessmode
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "pixels"

      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

    • thickness
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 30

      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    • lenmode
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "fraction"

      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

    • len
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

    • x
      Parent: data[type=heatmapgl].colorbar
      Type: number between or equal to -2 and 3
      Default: 1.02

      Sets the x position of the color bar (in plot fraction).

    • xanchor
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "left" | "center" | "right" )
      Default: "left"

      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

    • xpad
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the x direction.

    • y
      Parent: data[type=heatmapgl].colorbar
      Type: number between or equal to -2 and 3
      Default: 0.5

      Sets the y position of the color bar (in plot fraction).

    • yanchor
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "top" | "middle" | "bottom" )
      Default: "middle"

      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

    • ypad
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the y direction.

    • outlinecolor
      Parent: data[type=heatmapgl].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • outlinewidth
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • bordercolor
      Parent: data[type=heatmapgl].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • borderwidth
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 0

      Sets the width (in px) or the border enclosing this color bar.

    • bgcolor
      Parent: data[type=heatmapgl].colorbar
      Type: color
      Default: "rgba(0,0,0,0)"

      Sets the color of padded area.

    • tickmode
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "auto" | "linear" | "array" )

      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

    • nticks
      Parent: data[type=heatmapgl].colorbar
      Type: integer greater than or equal to 0
      Default: 0

      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

    • tick0
      Parent: data[type=heatmapgl].colorbar
      Type: number or categorical coordinate string

      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick
      Parent: data[type=heatmapgl].colorbar
      Type: number or categorical coordinate string

      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

    • tickvals
      Parent: data[type=heatmapgl].colorbar
      Type: dataframe column, list, vector

      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

    • ticktext
      Parent: data[type=heatmapgl].colorbar
      Type: dataframe column, list, vector

      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

    • ticks
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "outside" | "inside" | "" )
      Default: ""

      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

    • ticklen
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 5

      Sets the tick length (in px).

    • tickwidth
      Parent: data[type=heatmapgl].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the tick width (in px).

    • tickcolor
      Parent: data[type=heatmapgl].colorbar
      Type: color
      Default: "#444"

      Sets the tick color.

    • showticklabels
      Parent: data[type=heatmapgl].colorbar
      Type: boolean
      Default: TRUE

      Determines whether or not the tick labels are drawn.

    • tickfont
      Parent: data[type=heatmapgl].colorbar
      Type: named list containing one or more of the keys listed below.

      Sets the color bar's tick label font

      • family
        Parent: data[type=heatmapgl].colorbar.tickfont
        Type: string

        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=heatmapgl].colorbar.tickfont
        Type: number greater than or equal to 1
      • color
        Parent: data[type=heatmapgl].colorbar.tickfont
        Type: color
    • tickangle
      Parent: data[type=heatmapgl].colorbar
      Type: angle
      Default: "auto"

      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickformat
      Parent: data[type=heatmapgl].colorbar
      Type: string
      Default: ""

      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

    • tickformatstops
      Parent: data[type=heatmapgl].colorbar
      Type: list of named list where each named list has one or more of the keys listed below.
      • enabled
        Parent: data[type=heatmapgl].colorbar.tickformatstops[]
        Type: boolean
        Default: TRUE

        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

      • dtickrange
        Parent: data[type=heatmapgl].colorbar.tickformatstops[]
        Type: list

        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

      • value
        Parent: data[type=heatmapgl].colorbar.tickformatstops[]
        Type: string
        Default: ""

        string - dtickformat for described zoom level, the same as "tickformat"

      • name
        Parent: data[type=heatmapgl].colorbar.tickformatstops[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=heatmapgl].colorbar.tickformatstops[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

    • tickprefix
      Parent: data[type=heatmapgl].colorbar
      Type: string
      Default: ""

      Sets a tick label prefix.

    • showtickprefix
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

    • ticksuffix
      Parent: data[type=heatmapgl].colorbar
      Type: string
      Default: ""

      Sets a tick label suffix.

    • showticksuffix
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • separatethousands
      Parent: data[type=heatmapgl].colorbar
      Type: boolean

      If "TRUE", even 4-digit integers are separated

    • exponentformat
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
      Default: "B"

      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

    • showexponent
      Parent: data[type=heatmapgl].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

    • title
      Parent: data[type=heatmapgl].colorbar
      Type: named list containing one or more of the keys listed below.
      • text
        Parent: data[type=heatmapgl].colorbar.title
        Type: string

        Sets the title of the color bar. 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=heatmapgl].colorbar.title
        Type: named list containing one or more of the keys listed below.

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

        • family
          Parent: data[type=heatmapgl].colorbar.title.font
          Type: string

          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=heatmapgl].colorbar.title.font
          Type: number greater than or equal to 1
        • color
          Parent: data[type=heatmapgl].colorbar.title.font
          Type: color
      • side
        Parent: data[type=heatmapgl].colorbar.title
        Type: enumerated , one of ( "right" | "top" | "bottom" )
        Default: "top"

        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

  • autocolorscale
    Parent: data[type=heatmapgl]
    Type: boolean

    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

  • colorscale
    Parent: data[type=heatmapgl]
    Type: colorscale

    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • showscale
    Parent: data[type=heatmapgl]
    Type: boolean
    Default: TRUE

    Determines whether or not a colorbar is displayed for this trace.

  • reversescale
    Parent: data[type=heatmapgl]
    Type: boolean

    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

  • zauto
    Parent: data[type=heatmapgl]
    Type: boolean
    Default: TRUE

    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.

  • zmax
    Parent: data[type=heatmapgl]
    Type: number

    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid
    Parent: data[type=heatmapgl]
    Type: number

    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.

  • zmin
    Parent: data[type=heatmapgl]
    Type: number

    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=heatmapgl].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=heatmapgl].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=heatmapgl].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=heatmapgl].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=heatmapgl].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.

  • transpose
    Parent: data[type=heatmapgl]
    Type: boolean

    Transposes the z data.

  • uirevision
    Parent: data[type=heatmapgl]
    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.

image traces
A image trace is initialized with plot_ly or add_trace:
plot_ly(df, type="image"[, ...])
add_trace(p, type="image"[, ...])
A image trace accepts any of the keys listed below.

Display an image, i.e. data on a 2D regular raster. By default, when an image is displayed in a subplot, its y axis will be reversed (ie. `autorange: 'reversed'`), constrained to the domain (ie. `constrain: 'domain'`) and it will have the same scale as its x axis (ie. `scaleanchor: 'x,`) in order for pixels to be rendered as squares.

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

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

  • visible
    Parent: data[type=image]
    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).

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

    Sets the opacity of the trace.

  • ids
    Parent: data[type=image]
    Type: dataframe column, list, vector

    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.

  • x0
    Parent: data[type=image]
    Type: number or categorical coordinate string
    Default: 0

    Set the image's x position.

  • dx
    Parent: data[type=image]
    Type: number
    Default: 1

    Set the pixel's horizontal size.

  • y0
    Parent: data[type=image]
    Type: number or categorical coordinate string
    Default: 0

    Set the image's y position.

  • dy
    Parent: data[type=image]
    Type: number
    Default: 1

    Set the pixel's vertical size

  • z
    Parent: data[type=image]
    Type: dataframe column, list, vector

    A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.

  • text
    Parent: data[type=image]
    Type: dataframe column, list, vector

    Sets the text elements associated with each z value.

  • hovertext
    Parent: data[type=image]
    Type: dataframe column, list, vector

    Same as `text`.

  • hoverinfo
    Parent: data[type=image]
    Type: flaglist string. Any combination of "x", "y", "z", "color", "name", "text" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "all"
    Default: "x+y+z+text+name"

    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=image]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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 `z`, `color` and `colormodel`. 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=image]
    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=image]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=image]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=image]
    Type: subplotid
    Default: y

    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.

  • colormodel
    Parent: data[type=image]
    Type: enumerated , one of ( "rgb" | "rgba" | "hsl" | "hsla" )
    Default: "rgb"

    Color model used to map the numerical color components described in `z` into colors.

  • zmax
    Parent: data[type=image]
    Type: list

    Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1].

  • zmin
    Parent: data[type=image]
    Type: list

    Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0].

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=image].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=image].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=image].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=image].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=image].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.

  • uirevision
    Parent: data[type=image]
    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.

contour traces
A contour trace is initialized with plot_ly or add_trace:
plot_ly(df, type="contour"[, ...])
add_trace(p, type="contour"[, ...])
A contour trace accepts any of the keys listed below.

The data from which contour lines are computed is set in `z`. Data in `z` must be a 2D list of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto-generated). By setting `transpose` to "TRUE", the above behavior is flipped.

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

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

  • visible
    Parent: data[type=contour]
    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=contour]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=contour]
    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=contour]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=contour]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=contour]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=contour]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=contour]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • xtype
    Parent: data[type=contour]
    Type: enumerated , one of ( "array" | "scaled" )

    If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).

  • y
    Parent: data[type=contour]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=contour]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=contour]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

  • ytype
    Parent: data[type=contour]
    Type: enumerated , one of ( "array" | "scaled" )

    If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)

  • z
    Parent: data[type=contour]
    Type: dataframe column, list, vector

    Sets the z data.

  • text
    Parent: data[type=contour]
    Type: dataframe column, list, vector

    Sets the text elements associated with each z value.

  • hovertext
    Parent: data[type=contour]
    Type: dataframe column, list, vector

    Same as `text`.

  • hoverinfo
    Parent: data[type=contour]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=contour]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. 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=contour]
    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=contour]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=contour]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=contour]
    Type: subplotid
    Default: y

    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.

  • coloraxis
    Parent: data[type=contour]
    Type: subplotid

    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

  • line
    Parent: data[type=contour]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=contour].line
      Type: color

      Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".

    • width
      Parent: data[type=contour].line
      Type: number greater than or equal to 0

      Sets the contour line width in (in px) Defaults to "0.5" when `contours.type` is "levels". Defaults to "2" when `contour.type` is "constraint".

    • dash
      Parent: data[type=contour].line
      Type: string
      Default: "solid"

      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

    • smoothing
      Parent: data[type=contour].line
      Type: number between or equal to 0 and 1.3
      Default: 1

      Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.

  • colorbar
    Parent: data[type=contour]
    Type: named list containing one or more of the keys listed below.
    • thicknessmode
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "pixels"

      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

    • thickness
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 30

      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    • lenmode
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "fraction"

      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

    • len
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

    • x
      Parent: data[type=contour].colorbar
      Type: number between or equal to -2 and 3
      Default: 1.02

      Sets the x position of the color bar (in plot fraction).

    • xanchor
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "left" | "center" | "right" )
      Default: "left"

      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

    • xpad
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the x direction.

    • y
      Parent: data[type=contour].colorbar
      Type: number between or equal to -2 and 3
      Default: 0.5

      Sets the y position of the color bar (in plot fraction).

    • yanchor
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "top" | "middle" | "bottom" )
      Default: "middle"

      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

    • ypad
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the y direction.

    • outlinecolor
      Parent: data[type=contour].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • outlinewidth
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • bordercolor
      Parent: data[type=contour].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • borderwidth
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 0

      Sets the width (in px) or the border enclosing this color bar.

    • bgcolor
      Parent: data[type=contour].colorbar
      Type: color
      Default: "rgba(0,0,0,0)"

      Sets the color of padded area.

    • tickmode
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "auto" | "linear" | "array" )

      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

    • nticks
      Parent: data[type=contour].colorbar
      Type: integer greater than or equal to 0
      Default: 0

      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

    • tick0
      Parent: data[type=contour].colorbar
      Type: number or categorical coordinate string

      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick
      Parent: data[type=contour].colorbar
      Type: number or categorical coordinate string

      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

    • tickvals
      Parent: data[type=contour].colorbar
      Type: dataframe column, list, vector

      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

    • ticktext
      Parent: data[type=contour].colorbar
      Type: dataframe column, list, vector

      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

    • ticks
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "outside" | "inside" | "" )
      Default: ""

      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

    • ticklen
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 5

      Sets the tick length (in px).

    • tickwidth
      Parent: data[type=contour].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the tick width (in px).

    • tickcolor
      Parent: data[type=contour].colorbar
      Type: color
      Default: "#444"

      Sets the tick color.

    • showticklabels
      Parent: data[type=contour].colorbar
      Type: boolean
      Default: TRUE

      Determines whether or not the tick labels are drawn.

    • tickfont
      Parent: data[type=contour].colorbar
      Type: named list containing one or more of the keys listed below.

      Sets the color bar's tick label font

      • family
        Parent: data[type=contour].colorbar.tickfont
        Type: string

        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=contour].colorbar.tickfont
        Type: number greater than or equal to 1
      • color
        Parent: data[type=contour].colorbar.tickfont
        Type: color
    • tickangle
      Parent: data[type=contour].colorbar
      Type: angle
      Default: "auto"

      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickformat
      Parent: data[type=contour].colorbar
      Type: string
      Default: ""

      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

    • tickformatstops
      Parent: data[type=contour].colorbar
      Type: list of named list where each named list has one or more of the keys listed below.
      • enabled
        Parent: data[type=contour].colorbar.tickformatstops[]
        Type: boolean
        Default: TRUE

        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

      • dtickrange
        Parent: data[type=contour].colorbar.tickformatstops[]
        Type: list

        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

      • value
        Parent: data[type=contour].colorbar.tickformatstops[]
        Type: string
        Default: ""

        string - dtickformat for described zoom level, the same as "tickformat"

      • name
        Parent: data[type=contour].colorbar.tickformatstops[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=contour].colorbar.tickformatstops[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

    • tickprefix
      Parent: data[type=contour].colorbar
      Type: string
      Default: ""

      Sets a tick label prefix.

    • showtickprefix
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

    • ticksuffix
      Parent: data[type=contour].colorbar
      Type: string
      Default: ""

      Sets a tick label suffix.

    • showticksuffix
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • separatethousands
      Parent: data[type=contour].colorbar
      Type: boolean

      If "TRUE", even 4-digit integers are separated

    • exponentformat
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
      Default: "B"

      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

    • showexponent
      Parent: data[type=contour].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

    • title
      Parent: data[type=contour].colorbar
      Type: named list containing one or more of the keys listed below.
      • text
        Parent: data[type=contour].colorbar.title
        Type: string

        Sets the title of the color bar. 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=contour].colorbar.title
        Type: named list containing one or more of the keys listed below.

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

        • family
          Parent: data[type=contour].colorbar.title.font
          Type: string

          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=contour].colorbar.title.font
          Type: number greater than or equal to 1
        • color
          Parent: data[type=contour].colorbar.title.font
          Type: color
      • side
        Parent: data[type=contour].colorbar.title
        Type: enumerated , one of ( "right" | "top" | "bottom" )
        Default: "top"

        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

  • autocolorscale
    Parent: data[type=contour]
    Type: boolean

    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

  • colorscale
    Parent: data[type=contour]
    Type: colorscale

    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • showscale
    Parent: data[type=contour]
    Type: boolean
    Default: TRUE

    Determines whether or not a colorbar is displayed for this trace.

  • reversescale
    Parent: data[type=contour]
    Type: boolean

    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

  • zauto
    Parent: data[type=contour]
    Type: boolean
    Default: TRUE

    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.

  • zhoverformat
    Parent: data[type=contour]
    Type: string
    Default: ""

    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • zmax
    Parent: data[type=contour]
    Type: number

    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid
    Parent: data[type=contour]
    Type: number

    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.

  • zmin
    Parent: data[type=contour]
    Type: number

    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • autocontour
    Parent: data[type=contour]
    Type: boolean
    Default: TRUE

    Determines whether or not the contour level attributes are picked by an algorithm. If "TRUE", the number of contour levels can be set in `ncontours`. If "FALSE", set the contour level attributes in `contours`.

  • connectgaps
    Parent: data[type=contour]
    Type: boolean

    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to TRUE if `z` is a one dimensional array otherwise it is defaulted to FALSE.

  • contours
    Parent: data[type=contour]
    Type: named list containing one or more of the keys listed below.
    • type
      Parent: data[type=contour].contours
      Type: enumerated , one of ( "levels" | "constraint" )
      Default: "levels"

      If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.

    • start
      Parent: data[type=contour].contours
      Type: number

      Sets the starting contour level value. Must be less than `contours.end`

    • end
      Parent: data[type=contour].contours
      Type: number

      Sets the end contour level value. Must be more than `contours.start`

    • size
      Parent: data[type=contour].contours
      Type: number greater than or equal to 0

      Sets the step between each contour level. Must be positive.

    • coloring
      Parent: data[type=contour].contours
      Type: enumerated , one of ( "fill" | "heatmap" | "lines" | "none" )
      Default: "fill"

      Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace.

    • showlines
      Parent: data[type=contour].contours
      Type: boolean
      Default: TRUE

      Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".

    • showlabels
      Parent: data[type=contour].contours
      Type: boolean

      Determines whether to label the contour lines with their values.

    • labelfont
      Parent: data[type=contour].contours
      Type: named list containing one or more of the keys listed below.

      Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.

      • family
        Parent: data[type=contour].contours.labelfont
        Type: string

        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=contour].contours.labelfont
        Type: number greater than or equal to 1
      • color
        Parent: data[type=contour].contours.labelfont
        Type: color
    • labelformat
      Parent: data[type=contour].contours
      Type: string
      Default: ""

      Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • operation
      Parent: data[type=contour].contours
      Type: enumerated , one of ( "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
      Default: "="

      Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.

    • value
      Parent: data[type=contour].contours
      Type: number or categorical coordinate string
      Default: 0

      Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.

  • fillcolor
    Parent: data[type=contour]
    Type: color

    Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=contour].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=contour].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=contour].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=contour].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=contour].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.

  • hoverongaps
    Parent: data[type=contour]
    Type: boolean
    Default: TRUE

    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.

  • ncontours
    Parent: data[type=contour]
    Type: integer greater than or equal to 1
    Default: 15

    Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "TRUE" or if `contours.size` is missing.

  • transpose
    Parent: data[type=contour]
    Type: boolean

    Transposes the z data.

  • xcalendar
    Parent: data[type=contour]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=contour]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=contour]
    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.

table traces
A table trace is initialized with plot_ly or add_trace:
plot_ly(df, type="table"[, ...])
add_trace(p, type="table"[, ...])
A table trace accepts any of the keys listed below.

Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column-major order, ie. the grid is represented as a vector of column vectors.

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

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

  • visible
    Parent: data[type=table]
    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).

  • ids
    Parent: data[type=table]
    Type: dataframe column, list, vector

    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.

  • columnorder
    Parent: data[type=table]
    Type: dataframe column, list, vector

    Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero.

  • columnwidth
    Parent: data[type=table]
    Type: number or array of numbers

    The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.

  • hoverinfo
    Parent: data[type=table]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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.

  • meta
    Parent: data[type=table]
    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=table]
    Type: dataframe column, list, vector

    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=table]
    Type: named list containing one or more of the keys listed below.
    • x
      Parent: data[type=table].domain
      Type: list
      Default: [0, 1]

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

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

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

    • row
      Parent: data[type=table].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 table trace .

    • column
      Parent: data[type=table].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 table trace .

  • cells
    Parent: data[type=table]
    Type: named list containing one or more of the keys listed below.
    • values
      Parent: data[type=table].cells
      Type: dataframe column, list, vector
      Default:

      Cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.

    • format
      Parent: data[type=table].cells
      Type: dataframe column, list, vector
      Default:

      Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • prefix
      Parent: data[type=table].cells
      Type: string or array of strings

      Prefix for cell values.

    • suffix
      Parent: data[type=table].cells
      Type: string or array of strings

      Suffix for cell values.

    • height
      Parent: data[type=table].cells
      Type: number
      Default: 20

      The height of cells.

    • align
      Parent: data[type=table].cells
      Type: enumerated or array of enumerateds , one of ( "left" | "center" | "right" )
      Default: "center"

      Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.

    • line
      Parent: data[type=table].cells
      Type: named list containing one or more of the keys listed below.
      • width
        Parent: data[type=table].cells.line
        Type: number or array of numbers
        Default: 1
      • color
        Parent: data[type=table].cells.line
        Type: color or array of colors
        Default: "grey"
    • fill
      Parent: data[type=table].cells
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=table].cells.fill
        Type: color or array of colors
        Default: "white"

        Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.

    • font
      Parent: data[type=table].cells
      Type: named list containing one or more of the keys listed below.
      • family
        Parent: data[type=table].cells.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=table].cells.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=table].cells.font
        Type: color or array of colors
  • header
    Parent: data[type=table]
    Type: named list containing one or more of the keys listed below.
    • values
      Parent: data[type=table].header
      Type: dataframe column, list, vector
      Default:

      Header cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.

    • format
      Parent: data[type=table].header
      Type: dataframe column, list, vector
      Default:

      Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • prefix
      Parent: data[type=table].header
      Type: string or array of strings

      Prefix for cell values.

    • suffix
      Parent: data[type=table].header
      Type: string or array of strings

      Suffix for cell values.

    • height
      Parent: data[type=table].header
      Type: number
      Default: 28

      The height of cells.

    • align
      Parent: data[type=table].header
      Type: enumerated or array of enumerateds , one of ( "left" | "center" | "right" )
      Default: "center"

      Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.

    • line
      Parent: data[type=table].header
      Type: named list containing one or more of the keys listed below.
      • width
        Parent: data[type=table].header.line
        Type: number or array of numbers
        Default: 1
      • color
        Parent: data[type=table].header.line
        Type: color or array of colors
        Default: "grey"
    • fill
      Parent: data[type=table].header
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=table].header.fill
        Type: color or array of colors
        Default: "white"

        Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.

    • font
      Parent: data[type=table].header
      Type: named list containing one or more of the keys listed below.
      • family
        Parent: data[type=table].header.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=table].header.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=table].header.font
        Type: color or array of colors
  • hoverlabel
    Parent: data[type=table]
    Type: named list containing one or more of the keys listed below.
    • bgcolor
      Parent: data[type=table].hoverlabel
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=table].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=table].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=table].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=table].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=table].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.

  • uirevision
    Parent: data[type=table]
    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.

box traces
A box trace is initialized with plot_ly or add_trace:
plot_ly(df, type="box"[, ...])
add_trace(p, type="box"[, ...])
A box trace accepts any of the keys listed below.

Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow outward from the boxes' edges, by default they span +/- 1.5 times the interquartile range (IQR: Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and suspected outliers points can be optionally added to the box plot. The values and positions corresponding to each boxes can be input using two signatures. The first signature expects users to supply the sample values in the `y` data array for vertical boxes (`x` for horizontal boxes). By supplying an `x` (`y`) array, one box per distinct `x` (`y`) value is drawn If no `x` (`y`) list is provided, a single box is drawn. In this case, the box is positioned with the trace `name` or with `x0` (`y0`) if provided. The second signature expects users to supply the boxes corresponding Q1, median and Q3 statistics in the `q1`, `median` and `q3` data arrays respectively. Other box features relying on statistics namely `lowerfence`, `upperfence`, `notchspan` can be set directly by the users. To have plotly compute them or to show sample points besides the boxes, users can set the `y` data array for vertical boxes (`x` for horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in the traces and the inner length corresponding the sample size.

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

    Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical

  • visible
    Parent: data[type=box]
    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=box]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=box]
    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=box]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=box]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the x sample data or coordinates. See overview for more info.

  • x0
    Parent: data[type=box]
    Type: number or categorical coordinate string

    Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • dx
    Parent: data[type=box]
    Type: number

    Sets the x coordinate step for multi-box traces set using q1/median/q3.

  • y
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the y sample data or coordinates. See overview for more info.

  • y0
    Parent: data[type=box]
    Type: number or categorical coordinate string

    Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • dy
    Parent: data[type=box]
    Type: number

    Sets the y coordinate step for multi-box traces set using q1/median/q3.

  • width
    Parent: data[type=box]
    Type: number greater than or equal to 0
    Default: 0

    Sets the width of the box in data coordinate If "0" (default value) the width is automatically selected based on the positions of other box traces in the same subplot.

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

    Sets the text elements associated with each sample value. 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.

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

    Same as `text`.

  • hoverinfo
    Parent: data[type=box]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=box]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. 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=box]
    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=box]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=box]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=box]
    Type: subplotid
    Default: y

    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.

  • orientation
    Parent: data[type=box]
    Type: enumerated , one of ( "v" | "h" )

    Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal).

  • alignmentgroup
    Parent: data[type=box]
    Type: string
    Default: ""

    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.

  • offsetgroup
    Parent: data[type=box]
    Type: string
    Default: ""

    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.

  • marker
    Parent: data[type=box]
    Type: named list containing one or more of the keys listed below.
    • outliercolor
      Parent: data[type=box].marker
      Type: color
      Default: "rgba(0, 0, 0, 0)"

      Sets the color of the outlier sample points.

    • symbol
      Parent: data[type=box].marker
      Type: enumerated , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      Default: "circle"

      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.

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

      Sets the marker opacity.

    • size
      Parent: data[type=box].marker
      Type: number greater than or equal to 0
      Default: 6

      Sets the marker size (in px).

    • color
      Parent: data[type=box].marker
      Type: color

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • line
      Parent: data[type=box].marker
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=box].marker.line
        Type: color
        Default: "#444"

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • width
        Parent: data[type=box].marker.line
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) of the lines bounding the marker points.

      • outliercolor
        Parent: data[type=box].marker.line
        Type: color

        Sets the border line color of the outlier sample points. Defaults to marker.color

      • outlierwidth
        Parent: data[type=box].marker.line
        Type: number greater than or equal to 0
        Default: 1

        Sets the border line width (in px) of the outlier sample points.

  • line
    Parent: data[type=box]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=box].line
      Type: color

      Sets the color of line bounding the box(es).

    • width
      Parent: data[type=box].line
      Type: number greater than or equal to 0
      Default: 2

      Sets the width (in px) of line bounding the box(es).

  • boxmean
    Parent: data[type=box]
    Type: enumerated , one of ( TRUE | "sd" | FALSE )

    If "TRUE", the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn. Defaults to "TRUE" when `mean` is set. Defaults to "sd" when `sd` is set Otherwise defaults to "FALSE".

  • boxpoints
    Parent: data[type=box]
    Type: enumerated , one of ( "all" | "outliers" | "suspectedoutliers" | FALSE )

    If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If "FALSE", only the box(es) are shown with no sample points Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to "all" under the q1/median/q3 signature. Otherwise defaults to "outliers".

  • notched
    Parent: data[type=box]
    Type: boolean

    Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 " IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to "FALSE" unless `notchwidth` or `notchspan` is set.

  • notchwidth
    Parent: data[type=box]
    Type: number between or equal to 0 and 0.5
    Default: 0.25

    Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).

  • whiskerwidth
    Parent: data[type=box]
    Type: number between or equal to 0 and 1
    Default: 0.5

    Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

  • q1
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the Quartile 1 values. There should be as many items as the number of boxes desired.

  • median
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the median values. There should be as many items as the number of boxes desired.

  • q3
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the Quartile 3 values. There should be as many items as the number of boxes desired.

  • lowerfence
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR.

  • upperfence
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point above 1.5 times the IQR.

  • notchspan
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 " IQR / sqrt(N), where N is the sample size.

  • mean
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values.

  • sd
    Parent: data[type=box]
    Type: dataframe column, list, vector

    Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values.

  • quartilemethod
    Parent: data[type=box]
    Type: enumerated , one of ( "linear" | "exclusive" | "inclusive" )
    Default: "linear"

    Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publications/jse/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

  • selectedpoints
    Parent: data[type=box]
    Type: number or categorical coordinate string

    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.

  • selected
    Parent: data[type=box]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=box].selected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=box].selected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of selected points.

      • color
        Parent: data[type=box].selected.marker
        Type: color

        Sets the marker color of selected points.

      • size
        Parent: data[type=box].selected.marker
        Type: number greater than or equal to 0

        Sets the marker size of selected points.

  • unselected
    Parent: data[type=box]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=box].unselected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=box].unselected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of unselected points, applied only when a selection exists.

      • color
        Parent: data[type=box].unselected.marker
        Type: color

        Sets the marker color of unselected points, applied only when a selection exists.

      • size
        Parent: data[type=box].unselected.marker
        Type: number greater than or equal to 0

        Sets the marker size of unselected points, applied only when a selection exists.

  • fillcolor
    Parent: data[type=box]
    Type: color

    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=box].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=box].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=box].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=box].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=box].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.

  • hoveron
    Parent: data[type=box]
    Type: flaglist string. Any combination of "boxes", "points" joined with a "+"
    Examples: "boxes", "points", "boxes+points"
    Default: "boxes+points"

    Do the hover effects highlight individual boxes or sample points or both?

  • pointpos
    Parent: data[type=box]
    Type: number between or equal to -2 and 2

    Sets the position of the sample points in relation to the box(es). If "0", the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes

  • jitter
    Parent: data[type=box]
    Type: number between or equal to 0 and 1

    Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the box(es).

  • xcalendar
    Parent: data[type=box]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=box]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=box]
    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.

violin traces
A violin trace is initialized with plot_ly or add_trace:
plot_ly(df, type="violin"[, ...])
add_trace(p, type="violin"[, ...])
A violin trace accepts any of the keys listed below.

In vertical (horizontal) violin plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one violin per distinct x (y) value is drawn If no `x` (`y`) list is provided, a single violin is drawn. That violin position is then positioned with with `name` or with `x0` (`y0`) if provided.

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

    Sets the trace name. The trace name appear as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details).

  • visible
    Parent: data[type=violin]
    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=violin]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=violin]
    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=violin]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=violin]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=violin]
    Type: dataframe column, list, vector

    Sets the x sample data or coordinates. See overview for more info.

  • x0
    Parent: data[type=violin]
    Type: number or categorical coordinate string

    Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • y
    Parent: data[type=violin]
    Type: dataframe column, list, vector

    Sets the y sample data or coordinates. See overview for more info.

  • y0
    Parent: data[type=violin]
    Type: number or categorical coordinate string

    Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • width
    Parent: data[type=violin]
    Type: number greater than or equal to 0
    Default: 0

    Sets the width of the violin in data coordinates. If "0" (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.

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

    Sets the text elements associated with each sample value. 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.

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

    Same as `text`.

  • hoverinfo
    Parent: data[type=violin]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=violin]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. 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=violin]
    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=violin]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=violin]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=violin]
    Type: subplotid
    Default: y

    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.

  • orientation
    Parent: data[type=violin]
    Type: enumerated , one of ( "v" | "h" )

    Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal).

  • alignmentgroup
    Parent: data[type=violin]
    Type: string
    Default: ""

    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.

  • offsetgroup
    Parent: data[type=violin]
    Type: string
    Default: ""

    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.

  • marker
    Parent: data[type=violin]
    Type: named list containing one or more of the keys listed below.
    • outliercolor
      Parent: data[type=violin].marker
      Type: color
      Default: "rgba(0, 0, 0, 0)"

      Sets the color of the outlier sample points.

    • symbol
      Parent: data[type=violin].marker
      Type: enumerated , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      Default: "circle"

      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.

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

      Sets the marker opacity.

    • size
      Parent: data[type=violin].marker
      Type: number greater than or equal to 0
      Default: 6

      Sets the marker size (in px).

    • color
      Parent: data[type=violin].marker
      Type: color

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • line
      Parent: data[type=violin].marker
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=violin].marker.line
        Type: color
        Default: "#444"

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • width
        Parent: data[type=violin].marker.line
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) of the lines bounding the marker points.

      • outliercolor
        Parent: data[type=violin].marker.line
        Type: color

        Sets the border line color of the outlier sample points. Defaults to marker.color

      • outlierwidth
        Parent: data[type=violin].marker.line
        Type: number greater than or equal to 0
        Default: 1

        Sets the border line width (in px) of the outlier sample points.

  • line
    Parent: data[type=violin]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=violin].line
      Type: color

      Sets the color of line bounding the violin(s).

    • width
      Parent: data[type=violin].line
      Type: number greater than or equal to 0
      Default: 2

      Sets the width (in px) of line bounding the violin(s).

  • box
    Parent: data[type=violin]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=violin].box
      Type: boolean

      Determines if an miniature box plot is drawn inside the violins.

    • width
      Parent: data[type=violin].box
      Type: number between or equal to 0 and 1
      Default: 0.25

      Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins.

    • fillcolor
      Parent: data[type=violin].box
      Type: color

      Sets the inner box plot fill color.

    • line
      Parent: data[type=violin].box
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=violin].box.line
        Type: color

        Sets the inner box plot bounding line color.

      • width
        Parent: data[type=violin].box.line
        Type: number greater than or equal to 0

        Sets the inner box plot bounding line width.

  • selectedpoints
    Parent: data[type=violin]
    Type: number or categorical coordinate string

    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.

  • selected
    Parent: data[type=violin]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=violin].selected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=violin].selected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of selected points.

      • color
        Parent: data[type=violin].selected.marker
        Type: color

        Sets the marker color of selected points.

      • size
        Parent: data[type=violin].selected.marker
        Type: number greater than or equal to 0

        Sets the marker size of selected points.

  • unselected
    Parent: data[type=violin]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=violin].unselected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=violin].unselected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of unselected points, applied only when a selection exists.

      • color
        Parent: data[type=violin].unselected.marker
        Type: color

        Sets the marker color of unselected points, applied only when a selection exists.

      • size
        Parent: data[type=violin].unselected.marker
        Type: number greater than or equal to 0

        Sets the marker size of unselected points, applied only when a selection exists.

  • bandwidth
    Parent: data[type=violin]
    Type: number greater than or equal to 0

    Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.

  • fillcolor
    Parent: data[type=violin]
    Type: color

    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=violin].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=violin].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=violin].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=violin].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=violin].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.

  • hoveron
    Parent: data[type=violin]
    Type: flaglist string. Any combination of "violins", "points", "kde" joined with a "+" OR "all".
    Examples: "violins", "points", "violins+points", "violins+points+kde", "all"
    Default: "violins+points+kde"

    Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?

  • pointpos
    Parent: data[type=violin]
    Type: number between or equal to -2 and 2

    Sets the position of the sample points in relation to the violins. If "0", the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

  • jitter
    Parent: data[type=violin]
    Type: number between or equal to 0 and 1

    Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the violins.

  • meanline
    Parent: data[type=violin]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=violin].meanline
      Type: boolean

      Determines if a line corresponding to the sample's mean is shown inside the violins. If `box.visible` is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.

    • color
      Parent: data[type=violin].meanline
      Type: color

      Sets the mean line color.

    • width
      Parent: data[type=violin].meanline
      Type: number greater than or equal to 0

      Sets the mean line width.

  • points
    Parent: data[type=violin]
    Type: enumerated , one of ( "all" | "outliers" | "suspectedoutliers" | FALSE )

    If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If "FALSE", only the violins are shown with no sample points. Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to "outliers".

  • scalegroup
    Parent: data[type=violin]
    Type: string
    Default: ""

    If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together

  • scalemode
    Parent: data[type=violin]
    Type: enumerated , one of ( "width" | "count" )
    Default: "width"

    Sets the metric by which the width of each violin is determined."width" means each violin has the same (max) width"count" means the violins are scaled by the number of sample points makingup each violin.

  • side
    Parent: data[type=violin]
    Type: enumerated , one of ( "both" | "positive" | "negative" )
    Default: "both"

    Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under "overlay" mode, where one trace has `side` set to "positive" and the other to "negative".

  • span
    Parent: data[type=violin]
    Type: list

    Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual".

  • spanmode
    Parent: data[type=violin]
    Type: enumerated , one of ( "soft" | "hard" | "manual" )
    Default: "soft"

    Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the `span` attribute.

  • uirevision
    Parent: data[type=violin]
    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.

histogram traces
A histogram trace is initialized with plot_ly or add_trace:
plot_ly(df, type="histogram"[, ...])
add_trace(p, type="histogram"[, ...])
A histogram trace accepts any of the keys listed below.

The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided.

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

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

  • visible
    Parent: data[type=histogram]
    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=histogram]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=histogram]
    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=histogram]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=histogram]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=histogram]
    Type: dataframe column, list, vector

    Sets the sample data to be binned on the x axis.

  • y
    Parent: data[type=histogram]
    Type: dataframe column, list, vector

    Sets the sample data to be binned on the y axis.

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

    Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.

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

    Same as `text`.

  • hoverinfo
    Parent: data[type=histogram]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=histogram]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. variable `binNumber` 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=histogram]
    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=histogram]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=histogram]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=histogram]
    Type: subplotid
    Default: y

    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.

  • orientation
    Parent: data[type=histogram]
    Type: enumerated , one of ( "v" | "h" )

    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).

  • histfunc
    Parent: data[type=histogram]
    Type: enumerated , one of ( "count" | "sum" | "avg" | "min" | "max" )
    Default: "count"

    Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

  • histnorm
    Parent: data[type=histogram]
    Type: enumerated , one of ( "" | "percent" | "probability" | "density" | "probability density" )
    Default: ""

    Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

  • alignmentgroup
    Parent: data[type=histogram]
    Type: string
    Default: ""

    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.

  • offsetgroup
    Parent: data[type=histogram]
    Type: string
    Default: ""

    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.

  • nbinsx
    Parent: data[type=histogram]
    Type: integer greater than or equal to 0
    Default: 0

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.

  • nbinsy
    Parent: data[type=histogram]
    Type: integer greater than or equal to 0
    Default: 0

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.

  • autobinx
    Parent: data[type=histogram]
    Type: boolean

    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: TRUE` or `FALSE` and will update `xbins` accordingly before deleting `autobinx` from the trace.

  • autobiny
    Parent: data[type=histogram]
    Type: boolean

    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: TRUE` or `FALSE` and will update `ybins` accordingly before deleting `autobiny` from the trace.

  • bingroup
    Parent: data[type=histogram]
    Type: string
    Default: ""

    Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same "orientation" under `barmode` "stack", "relative" and "group" are forced into the same bingroup, Using `bingroup`, traces under `barmode` "overlay" and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d" trace can share the same `bingroup`

  • xbins
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • start
      Parent: data[type=histogram].xbins
      Type: number or categorical coordinate string

      Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.

    • end
      Parent: data[type=histogram].xbins
      Type: number or categorical coordinate string

      Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.

    • size
      Parent: data[type=histogram].xbins
      Type: number or categorical coordinate string

      Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.

  • ybins
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • start
      Parent: data[type=histogram].ybins
      Type: number or categorical coordinate string

      Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.

    • end
      Parent: data[type=histogram].ybins
      Type: number or categorical coordinate string

      Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.

    • size
      Parent: data[type=histogram].ybins
      Type: number or categorical coordinate string

      Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.

  • marker
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=histogram].marker
      Type: named list containing one or more of the keys listed below.
      • width
        Parent: data[type=histogram].marker.line
        Type: number or array of numbers greater than or equal to 0
        Default: 0

        Sets the width (in px) of the lines bounding the marker points.

      • color
        Parent: data[type=histogram].marker.line
        Type: color or array of colors

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • cauto
        Parent: data[type=histogram].marker.line
        Type: boolean
        Default: TRUE

        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.

      • cmin
        Parent: data[type=histogram].marker.line
        Type: number

        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.

      • cmax
        Parent: data[type=histogram].marker.line
        Type: number

        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.

      • cmid
        Parent: data[type=histogram].marker.line
        Type: number

        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.

      • colorscale
        Parent: data[type=histogram].marker.line
        Type: colorscale

        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

      • autocolorscale
        Parent: data[type=histogram].marker.line
        Type: boolean
        Default: TRUE

        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

      • reversescale
        Parent: data[type=histogram].marker.line
        Type: boolean

        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.

      • coloraxis
        Parent: data[type=histogram].marker.line
        Type: subplotid

        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • color
      Parent: data[type=histogram].marker
      Type: color or array of colors

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • cauto
      Parent: data[type=histogram].marker
      Type: boolean
      Default: TRUE

      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.

    • cmin
      Parent: data[type=histogram].marker
      Type: number

      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.

    • cmax
      Parent: data[type=histogram].marker
      Type: number

      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.

    • cmid
      Parent: data[type=histogram].marker
      Type: number

      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.

    • colorscale
      Parent: data[type=histogram].marker
      Type: colorscale

      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    • autocolorscale
      Parent: data[type=histogram].marker
      Type: boolean
      Default: TRUE

      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

    • reversescale
      Parent: data[type=histogram].marker
      Type: boolean

      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.

    • showscale
      Parent: data[type=histogram].marker
      Type: boolean

      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

    • colorbar
      Parent: data[type=histogram].marker
      Type: named list containing one or more of the keys listed below.
      • thicknessmode
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

      • thickness
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 30

        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

      • lenmode
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

      • len
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

      • x
        Parent: data[type=histogram].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the x direction.

      • y
        Parent: data[type=histogram].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the y direction.

      • outlinecolor
        Parent: data[type=histogram].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • bordercolor
        Parent: data[type=histogram].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • bgcolor
        Parent: data[type=histogram].marker.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=histogram].marker.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=histogram].marker.colorbar
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=histogram].marker.colorbar
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=histogram].marker.colorbar
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=histogram].marker.colorbar
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=histogram].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=histogram].marker.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=histogram].marker.colorbar
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=histogram].marker.colorbar
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=histogram].marker.colorbar.tickfont
          Type: string

          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=histogram].marker.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=histogram].marker.colorbar.tickfont
          Type: color
      • tickangle
        Parent: data[type=histogram].marker.colorbar
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=histogram].marker.colorbar
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=histogram].marker.colorbar
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=histogram].marker.colorbar.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=histogram].marker.colorbar.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=histogram].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=histogram].marker.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=histogram].marker.colorbar.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

      • tickprefix
        Parent: data[type=histogram].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=histogram].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=histogram].marker.colorbar
        Type: boolean

        If "TRUE", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=histogram].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

      • title
        Parent: data[type=histogram].marker.colorbar
        Type: named list containing one or more of the keys listed below.
        • text
          Parent: data[type=histogram].marker.colorbar.title
          Type: string

          Sets the title of the color bar. 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=histogram].marker.colorbar.title
          Type: named list containing one or more of the keys listed below.

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

          • family
            Parent: data[type=histogram].marker.colorbar.title.font
            Type: string

            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=histogram].marker.colorbar.title.font
            Type: number greater than or equal to 1
          • color
            Parent: data[type=histogram].marker.colorbar.title.font
            Type: color
        • side
          Parent: data[type=histogram].marker.colorbar.title
          Type: enumerated , one of ( "right" | "top" | "bottom" )
          Default: "top"

          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

    • coloraxis
      Parent: data[type=histogram].marker
      Type: subplotid

      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • opacity
      Parent: data[type=histogram].marker
      Type: number or array of numbers between or equal to 0 and 1
      Default: 1

      Sets the opacity of the bars.

  • error_x
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=histogram].error_x
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=histogram].error_x
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=histogram].error_x
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=histogram].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=histogram].error_x
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=histogram].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=histogram].error_x
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=histogram].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=histogram].error_x
      Type: integer greater than or equal to 0
      Default: 0
    • copy_ystyle
      Parent: data[type=histogram].error_x
      Type: boolean
    • color
      Parent: data[type=histogram].error_x
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=histogram].error_x
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=histogram].error_x
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • error_y
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • visible
      Parent: data[type=histogram].error_y
      Type: boolean

      Determines whether or not this set of error bars is visible.

    • type
      Parent: data[type=histogram].error_y
      Type: enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )

      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.

    • symmetric
      Parent: data[type=histogram].error_y
      Type: boolean

      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

    • array
      Parent: data[type=histogram].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

    • arrayminus
      Parent: data[type=histogram].error_y
      Type: dataframe column, list, vector

      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

    • value
      Parent: data[type=histogram].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

    • valueminus
      Parent: data[type=histogram].error_y
      Type: number greater than or equal to 0
      Default: 10

      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

    • traceref
      Parent: data[type=histogram].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • tracerefminus
      Parent: data[type=histogram].error_y
      Type: integer greater than or equal to 0
      Default: 0
    • color
      Parent: data[type=histogram].error_y
      Type: color

      Sets the stoke color of the error bars.

    • thickness
      Parent: data[type=histogram].error_y
      Type: number greater than or equal to 0
      Default: 2

      Sets the thickness (in px) of the error bars.

    • width
      Parent: data[type=histogram].error_y
      Type: number greater than or equal to 0

      Sets the width (in px) of the cross-bar at both ends of the error bars.

  • selectedpoints
    Parent: data[type=histogram]
    Type: number or categorical coordinate string

    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.

  • selected
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=histogram].selected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=histogram].selected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of selected points.

      • color
        Parent: data[type=histogram].selected.marker
        Type: color

        Sets the marker color of selected points.

    • textfont
      Parent: data[type=histogram].selected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=histogram].selected.textfont
        Type: color

        Sets the text font color of selected points.

  • unselected
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=histogram].unselected
      Type: named list containing one or more of the keys listed below.
      • opacity
        Parent: data[type=histogram].unselected.marker
        Type: number between or equal to 0 and 1

        Sets the marker opacity of unselected points, applied only when a selection exists.

      • color
        Parent: data[type=histogram].unselected.marker
        Type: color

        Sets the marker color of unselected points, applied only when a selection exists.

    • textfont
      Parent: data[type=histogram].unselected
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=histogram].unselected.textfont
        Type: color

        Sets the text font color of unselected points, applied only when a selection exists.

  • cumulative
    Parent: data[type=histogram]
    Type: named list containing one or more of the keys listed below.
    • enabled
      Parent: data[type=histogram].cumulative
      Type: boolean

      If TRUE, display the cumulative distribution by summing the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the same as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and "probability density" both rise to the number of sample points.

    • direction
      Parent: data[type=histogram].cumulative
      Type: enumerated , one of ( "increasing" | "decreasing" )
      Default: "increasing"

      Only applies if cumulative is enabled. If "increasing" (default) we sum all prior bins, so the result increases from left to right. If "decreasing" we sum later bins so the result decreases from left to right.

    • currentbin
      Parent: data[type=histogram].cumulative
      Type: enumerated , one of ( "include" | "exclude" | "half" )
      Default: "include"

      Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. "include" is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. "exclude" makes the opposite half-bin bias, and "half" removes it.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=histogram].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=histogram].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=histogram].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=histogram].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=histogram].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.

  • xcalendar
    Parent: data[type=histogram]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=histogram]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=histogram]
    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.

histogram2d traces
A histogram2d trace is initialized with plot_ly or add_trace:
plot_ly(df, type="histogram2d"[, ...])
add_trace(p, type="histogram2d"[, ...])
A histogram2d trace accepts any of the keys listed below.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a heatmap.

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

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

  • visible
    Parent: data[type=histogram2d]
    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=histogram2d]
    Type: boolean

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

  • legendgroup
    Parent: data[type=histogram2d]
    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=histogram2d]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=histogram2d]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=histogram2d]
    Type: dataframe column, list, vector

    Sets the sample data to be binned on the x axis.

  • xgap
    Parent: data[type=histogram2d]
    Type: number greater than or equal to 0
    Default: 0

    Sets the horizontal gap (in pixels) between bricks.

  • y
    Parent: data[type=histogram2d]
    Type: dataframe column, list, vector

    Sets the sample data to be binned on the y axis.

  • ygap
    Parent: data[type=histogram2d]
    Type: number greater than or equal to 0
    Default: 0

    Sets the vertical gap (in pixels) between bricks.

  • z
    Parent: data[type=histogram2d]
    Type: dataframe column, list, vector

    Sets the aggregation data.

  • hoverinfo
    Parent: data[type=histogram2d]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=histogram2d]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. variable `z` 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=histogram2d]
    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=histogram2d]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=histogram2d]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=histogram2d]
    Type: subplotid
    Default: y

    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.

  • coloraxis
    Parent: data[type=histogram2d]
    Type: subplotid

    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

  • histfunc
    Parent: data[type=histogram2d]
    Type: enumerated , one of ( "count" | "sum" | "avg" | "min" | "max" )
    Default: "count"

    Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

  • histnorm
    Parent: data[type=histogram2d]
    Type: enumerated , one of ( "" | "percent" | "probability" | "density" | "probability density" )
    Default: ""

    Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

  • nbinsx
    Parent: data[type=histogram2d]
    Type: integer greater than or equal to 0
    Default: 0

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.

  • nbinsy
    Parent: data[type=histogram2d]
    Type: integer greater than or equal to 0
    Default: 0

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.

  • autobinx
    Parent: data[type=histogram2d]
    Type: boolean

    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: TRUE` or `FALSE` and will update `xbins` accordingly before deleting `autobinx` from the trace.

  • autobiny
    Parent: data[type=histogram2d]
    Type: boolean

    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: TRUE` or `FALSE` and will update `ybins` accordingly before deleting `autobiny` from the trace.

  • bingroup
    Parent: data[type=histogram2d]
    Type: string
    Default: ""

    Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of "1" on two histogram2d traces will make them their x-bins and y-bins match separately.

  • xbingroup
    Parent: data[type=histogram2d]
    Type: string
    Default: ""

    Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`

  • xbins
    Parent: data[type=histogram2d]
    Type: named list containing one or more of the keys listed below.
    • start
      Parent: data[type=histogram2d].xbins
      Type: number or categorical coordinate string

      Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.

    • end
      Parent: data[type=histogram2d].xbins
      Type: number or categorical coordinate string

      Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.

    • size
      Parent: data[type=histogram2d].xbins
      Type: number or categorical coordinate string

      Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).

  • ybingroup
    Parent: data[type=histogram2d]
    Type: string
    Default: ""

    Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`

  • ybins
    Parent: data[type=histogram2d]
    Type: named list containing one or more of the keys listed below.
    • start
      Parent: data[type=histogram2d].ybins
      Type: number or categorical coordinate string

      Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.

    • end
      Parent: data[type=histogram2d].ybins
      Type: number or categorical coordinate string

      Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.

    • size
      Parent: data[type=histogram2d].ybins
      Type: number or categorical coordinate string

      Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).

  • marker
    Parent: data[type=histogram2d]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=histogram2d].marker
      Type: dataframe column, list, vector

      Sets the aggregation data.

  • colorbar
    Parent: data[type=histogram2d]
    Type: named list containing one or more of the keys listed below.
    • thicknessmode
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "pixels"

      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

    • thickness
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 30

      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    • lenmode
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "fraction"

      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

    • len
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

    • x
      Parent: data[type=histogram2d].colorbar
      Type: number between or equal to -2 and 3
      Default: 1.02

      Sets the x position of the color bar (in plot fraction).

    • xanchor
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "left" | "center" | "right" )
      Default: "left"

      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

    • xpad
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the x direction.

    • y
      Parent: data[type=histogram2d].colorbar
      Type: number between or equal to -2 and 3
      Default: 0.5

      Sets the y position of the color bar (in plot fraction).

    • yanchor
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "top" | "middle" | "bottom" )
      Default: "middle"

      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

    • ypad
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the y direction.

    • outlinecolor
      Parent: data[type=histogram2d].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • outlinewidth
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • bordercolor
      Parent: data[type=histogram2d].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • borderwidth
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 0

      Sets the width (in px) or the border enclosing this color bar.

    • bgcolor
      Parent: data[type=histogram2d].colorbar
      Type: color
      Default: "rgba(0,0,0,0)"

      Sets the color of padded area.

    • tickmode
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "auto" | "linear" | "array" )

      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

    • nticks
      Parent: data[type=histogram2d].colorbar
      Type: integer greater than or equal to 0
      Default: 0

      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

    • tick0
      Parent: data[type=histogram2d].colorbar
      Type: number or categorical coordinate string

      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick
      Parent: data[type=histogram2d].colorbar
      Type: number or categorical coordinate string

      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

    • tickvals
      Parent: data[type=histogram2d].colorbar
      Type: dataframe column, list, vector

      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

    • ticktext
      Parent: data[type=histogram2d].colorbar
      Type: dataframe column, list, vector

      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

    • ticks
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "outside" | "inside" | "" )
      Default: ""

      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

    • ticklen
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 5

      Sets the tick length (in px).

    • tickwidth
      Parent: data[type=histogram2d].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the tick width (in px).

    • tickcolor
      Parent: data[type=histogram2d].colorbar
      Type: color
      Default: "#444"

      Sets the tick color.

    • showticklabels
      Parent: data[type=histogram2d].colorbar
      Type: boolean
      Default: TRUE

      Determines whether or not the tick labels are drawn.

    • tickfont
      Parent: data[type=histogram2d].colorbar
      Type: named list containing one or more of the keys listed below.

      Sets the color bar's tick label font

      • family
        Parent: data[type=histogram2d].colorbar.tickfont
        Type: string

        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=histogram2d].colorbar.tickfont
        Type: number greater than or equal to 1
      • color
        Parent: data[type=histogram2d].colorbar.tickfont
        Type: color
    • tickangle
      Parent: data[type=histogram2d].colorbar
      Type: angle
      Default: "auto"

      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickformat
      Parent: data[type=histogram2d].colorbar
      Type: string
      Default: ""

      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

    • tickformatstops
      Parent: data[type=histogram2d].colorbar
      Type: list of named list where each named list has one or more of the keys listed below.
      • enabled
        Parent: data[type=histogram2d].colorbar.tickformatstops[]
        Type: boolean
        Default: TRUE

        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

      • dtickrange
        Parent: data[type=histogram2d].colorbar.tickformatstops[]
        Type: list

        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

      • value
        Parent: data[type=histogram2d].colorbar.tickformatstops[]
        Type: string
        Default: ""

        string - dtickformat for described zoom level, the same as "tickformat"

      • name
        Parent: data[type=histogram2d].colorbar.tickformatstops[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=histogram2d].colorbar.tickformatstops[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

    • tickprefix
      Parent: data[type=histogram2d].colorbar
      Type: string
      Default: ""

      Sets a tick label prefix.

    • showtickprefix
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

    • ticksuffix
      Parent: data[type=histogram2d].colorbar
      Type: string
      Default: ""

      Sets a tick label suffix.

    • showticksuffix
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • separatethousands
      Parent: data[type=histogram2d].colorbar
      Type: boolean

      If "TRUE", even 4-digit integers are separated

    • exponentformat
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
      Default: "B"

      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

    • showexponent
      Parent: data[type=histogram2d].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

    • title
      Parent: data[type=histogram2d].colorbar
      Type: named list containing one or more of the keys listed below.
      • text
        Parent: data[type=histogram2d].colorbar.title
        Type: string

        Sets the title of the color bar. 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=histogram2d].colorbar.title
        Type: named list containing one or more of the keys listed below.

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

        • family
          Parent: data[type=histogram2d].colorbar.title.font
          Type: string

          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=histogram2d].colorbar.title.font
          Type: number greater than or equal to 1
        • color
          Parent: data[type=histogram2d].colorbar.title.font
          Type: color
      • side
        Parent: data[type=histogram2d].colorbar.title
        Type: enumerated , one of ( "right" | "top" | "bottom" )
        Default: "top"

        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

  • autocolorscale
    Parent: data[type=histogram2d]
    Type: boolean

    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

  • colorscale
    Parent: data[type=histogram2d]
    Type: colorscale

    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • showscale
    Parent: data[type=histogram2d]
    Type: boolean
    Default: TRUE

    Determines whether or not a colorbar is displayed for this trace.

  • reversescale
    Parent: data[type=histogram2d]
    Type: boolean

    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

  • zauto
    Parent: data[type=histogram2d]
    Type: boolean
    Default: TRUE

    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.

  • zhoverformat
    Parent: data[type=histogram2d]
    Type: string
    Default: ""

    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • zmax
    Parent: data[type=histogram2d]
    Type: number

    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid
    Parent: data[type=histogram2d]
    Type: number

    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.

  • zmin
    Parent: data[type=histogram2d]
    Type: number

    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zsmooth
    Parent: data[type=histogram2d]
    Type: enumerated , one of ( "fast" | "best" | FALSE )

    Picks a smoothing algorithm use to smooth `z` data.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=histogram2d].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=histogram2d].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=histogram2d].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=histogram2d].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=histogram2d].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.

  • xcalendar
    Parent: data[type=histogram2d]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=histogram2d]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=histogram2d]
    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.

histogram2dcontour traces
A histogram2dcontour trace is initialized with plot_ly or add_trace:
plot_ly(df, type="histogram2dcontour"[, ...])
add_trace(p, type="histogram2dcontour"[, ...])
A histogram2dcontour trace accepts any of the keys listed below.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot.

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

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

  • visible
    Parent: data[type=histogram2dcontour]
    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=histogram2dcontour]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=histogram2dcontour]
    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=histogram2dcontour]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=histogram2dcontour]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=histogram2dcontour]
    Type: dataframe column, list, vector

    Sets the sample data to be binned on the x axis.

  • y
    Parent: data[type=histogram2dcontour]
    Type: dataframe column, list, vector

    Sets the sample data to be binned on the y axis.

  • z
    Parent: data[type=histogram2dcontour]
    Type: dataframe column, list, vector

    Sets the aggregation data.

  • hoverinfo
    Parent: data[type=histogram2dcontour]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=histogram2dcontour]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. variable `z` 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=histogram2dcontour]
    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=histogram2dcontour]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=histogram2dcontour]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=histogram2dcontour]
    Type: subplotid
    Default: y

    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.

  • coloraxis
    Parent: data[type=histogram2dcontour]
    Type: subplotid

    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

  • histfunc
    Parent: data[type=histogram2dcontour]
    Type: enumerated , one of ( "count" | "sum" | "avg" | "min" | "max" )
    Default: "count"

    Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

  • histnorm
    Parent: data[type=histogram2dcontour]
    Type: enumerated , one of ( "" | "percent" | "probability" | "density" | "probability density" )
    Default: ""

    Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

  • nbinsx
    Parent: data[type=histogram2dcontour]
    Type: integer greater than or equal to 0
    Default: 0

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.

  • nbinsy
    Parent: data[type=histogram2dcontour]
    Type: integer greater than or equal to 0
    Default: 0

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.

  • autobinx
    Parent: data[type=histogram2dcontour]
    Type: boolean

    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: TRUE` or `FALSE` and will update `xbins` accordingly before deleting `autobinx` from the trace.

  • autobiny
    Parent: data[type=histogram2dcontour]
    Type: boolean

    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: TRUE` or `FALSE` and will update `ybins` accordingly before deleting `autobiny` from the trace.

  • bingroup
    Parent: data[type=histogram2dcontour]
    Type: string
    Default: ""

    Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of "1" on two histogram2d traces will make them their x-bins and y-bins match separately.

  • xbingroup
    Parent: data[type=histogram2dcontour]
    Type: string
    Default: ""

    Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`

  • xbins
    Parent: data[type=histogram2dcontour]
    Type: named list containing one or more of the keys listed below.
    • start
      Parent: data[type=histogram2dcontour].xbins
      Type: number or categorical coordinate string

      Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.

    • end
      Parent: data[type=histogram2dcontour].xbins
      Type: number or categorical coordinate string

      Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.

    • size
      Parent: data[type=histogram2dcontour].xbins
      Type: number or categorical coordinate string

      Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).

  • ybingroup
    Parent: data[type=histogram2dcontour]
    Type: string
    Default: ""

    Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`

  • ybins
    Parent: data[type=histogram2dcontour]
    Type: named list containing one or more of the keys listed below.
    • start
      Parent: data[type=histogram2dcontour].ybins
      Type: number or categorical coordinate string

      Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.

    • end
      Parent: data[type=histogram2dcontour].ybins
      Type: number or categorical coordinate string

      Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.

    • size
      Parent: data[type=histogram2dcontour].ybins
      Type: number or categorical coordinate string

      Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).

  • marker
    Parent: data[type=histogram2dcontour]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=histogram2dcontour].marker
      Type: dataframe column, list, vector

      Sets the aggregation data.

  • line
    Parent: data[type=histogram2dcontour]
    Type: named list containing one or more of the keys listed below.
    • color
      Parent: data[type=histogram2dcontour].line
      Type: color

      Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".

    • width
      Parent: data[type=histogram2dcontour].line
      Type: number greater than or equal to 0
      Default: 0.5

      Sets the contour line width in (in px)

    • dash
      Parent: data[type=histogram2dcontour].line
      Type: string
      Default: "solid"

      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

    • smoothing
      Parent: data[type=histogram2dcontour].line
      Type: number between or equal to 0 and 1.3
      Default: 1

      Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.

  • colorbar
    Parent: data[type=histogram2dcontour]
    Type: named list containing one or more of the keys listed below.
    • thicknessmode
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "pixels"

      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

    • thickness
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 30

      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    • lenmode
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "fraction"

      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

    • len
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

    • x
      Parent: data[type=histogram2dcontour].colorbar
      Type: number between or equal to -2 and 3
      Default: 1.02

      Sets the x position of the color bar (in plot fraction).

    • xanchor
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "left" | "center" | "right" )
      Default: "left"

      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

    • xpad
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the x direction.

    • y
      Parent: data[type=histogram2dcontour].colorbar
      Type: number between or equal to -2 and 3
      Default: 0.5

      Sets the y position of the color bar (in plot fraction).

    • yanchor
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "top" | "middle" | "bottom" )
      Default: "middle"

      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

    • ypad
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 10

      Sets the amount of padding (in px) along the y direction.

    • outlinecolor
      Parent: data[type=histogram2dcontour].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • outlinewidth
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • bordercolor
      Parent: data[type=histogram2dcontour].colorbar
      Type: color
      Default: "#444"

      Sets the axis line color.

    • borderwidth
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 0

      Sets the width (in px) or the border enclosing this color bar.

    • bgcolor
      Parent: data[type=histogram2dcontour].colorbar
      Type: color
      Default: "rgba(0,0,0,0)"

      Sets the color of padded area.

    • tickmode
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "auto" | "linear" | "array" )

      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

    • nticks
      Parent: data[type=histogram2dcontour].colorbar
      Type: integer greater than or equal to 0
      Default: 0

      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

    • tick0
      Parent: data[type=histogram2dcontour].colorbar
      Type: number or categorical coordinate string

      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick
      Parent: data[type=histogram2dcontour].colorbar
      Type: number or categorical coordinate string

      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

    • tickvals
      Parent: data[type=histogram2dcontour].colorbar
      Type: dataframe column, list, vector

      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

    • ticktext
      Parent: data[type=histogram2dcontour].colorbar
      Type: dataframe column, list, vector

      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

    • ticks
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "outside" | "inside" | "" )
      Default: ""

      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

    • ticklen
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 5

      Sets the tick length (in px).

    • tickwidth
      Parent: data[type=histogram2dcontour].colorbar
      Type: number greater than or equal to 0
      Default: 1

      Sets the tick width (in px).

    • tickcolor
      Parent: data[type=histogram2dcontour].colorbar
      Type: color
      Default: "#444"

      Sets the tick color.

    • showticklabels
      Parent: data[type=histogram2dcontour].colorbar
      Type: boolean
      Default: TRUE

      Determines whether or not the tick labels are drawn.

    • tickfont
      Parent: data[type=histogram2dcontour].colorbar
      Type: named list containing one or more of the keys listed below.

      Sets the color bar's tick label font

      • family
        Parent: data[type=histogram2dcontour].colorbar.tickfont
        Type: string

        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=histogram2dcontour].colorbar.tickfont
        Type: number greater than or equal to 1
      • color
        Parent: data[type=histogram2dcontour].colorbar.tickfont
        Type: color
    • tickangle
      Parent: data[type=histogram2dcontour].colorbar
      Type: angle
      Default: "auto"

      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickformat
      Parent: data[type=histogram2dcontour].colorbar
      Type: string
      Default: ""

      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

    • tickformatstops
      Parent: data[type=histogram2dcontour].colorbar
      Type: list of named list where each named list has one or more of the keys listed below.
      • enabled
        Parent: data[type=histogram2dcontour].colorbar.tickformatstops[]
        Type: boolean
        Default: TRUE

        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

      • dtickrange
        Parent: data[type=histogram2dcontour].colorbar.tickformatstops[]
        Type: list

        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

      • value
        Parent: data[type=histogram2dcontour].colorbar.tickformatstops[]
        Type: string
        Default: ""

        string - dtickformat for described zoom level, the same as "tickformat"

      • name
        Parent: data[type=histogram2dcontour].colorbar.tickformatstops[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=histogram2dcontour].colorbar.tickformatstops[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

    • tickprefix
      Parent: data[type=histogram2dcontour].colorbar
      Type: string
      Default: ""

      Sets a tick label prefix.

    • showtickprefix
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

    • ticksuffix
      Parent: data[type=histogram2dcontour].colorbar
      Type: string
      Default: ""

      Sets a tick label suffix.

    • showticksuffix
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • separatethousands
      Parent: data[type=histogram2dcontour].colorbar
      Type: boolean

      If "TRUE", even 4-digit integers are separated

    • exponentformat
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
      Default: "B"

      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

    • showexponent
      Parent: data[type=histogram2dcontour].colorbar
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

    • title
      Parent: data[type=histogram2dcontour].colorbar
      Type: named list containing one or more of the keys listed below.
      • text
        Parent: data[type=histogram2dcontour].colorbar.title
        Type: string

        Sets the title of the color bar. 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=histogram2dcontour].colorbar.title
        Type: named list containing one or more of the keys listed below.

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

        • family
          Parent: data[type=histogram2dcontour].colorbar.title.font
          Type: string

          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=histogram2dcontour].colorbar.title.font
          Type: number greater than or equal to 1
        • color
          Parent: data[type=histogram2dcontour].colorbar.title.font
          Type: color
      • side
        Parent: data[type=histogram2dcontour].colorbar.title
        Type: enumerated , one of ( "right" | "top" | "bottom" )
        Default: "top"

        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

  • autocolorscale
    Parent: data[type=histogram2dcontour]
    Type: boolean
    Default: TRUE

    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

  • colorscale
    Parent: data[type=histogram2dcontour]
    Type: colorscale

    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • showscale
    Parent: data[type=histogram2dcontour]
    Type: boolean
    Default: TRUE

    Determines whether or not a colorbar is displayed for this trace.

  • reversescale
    Parent: data[type=histogram2dcontour]
    Type: boolean

    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

  • zauto
    Parent: data[type=histogram2dcontour]
    Type: boolean
    Default: TRUE

    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.

  • zhoverformat
    Parent: data[type=histogram2dcontour]
    Type: string
    Default: ""

    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • zmax
    Parent: data[type=histogram2dcontour]
    Type: number

    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid
    Parent: data[type=histogram2dcontour]
    Type: number

    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.

  • zmin
    Parent: data[type=histogram2dcontour]
    Type: number

    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • autocontour
    Parent: data[type=histogram2dcontour]
    Type: boolean
    Default: TRUE

    Determines whether or not the contour level attributes are picked by an algorithm. If "TRUE", the number of contour levels can be set in `ncontours`. If "FALSE", set the contour level attributes in `contours`.

  • contours
    Parent: data[type=histogram2dcontour]
    Type: named list containing one or more of the keys listed below.
    • type
      Parent: data[type=histogram2dcontour].contours
      Type: enumerated , one of ( "levels" | "constraint" )
      Default: "levels"

      If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.

    • start
      Parent: data[type=histogram2dcontour].contours
      Type: number

      Sets the starting contour level value. Must be less than `contours.end`

    • end
      Parent: data[type=histogram2dcontour].contours
      Type: number

      Sets the end contour level value. Must be more than `contours.start`

    • size
      Parent: data[type=histogram2dcontour].contours
      Type: number greater than or equal to 0

      Sets the step between each contour level. Must be positive.

    • coloring
      Parent: data[type=histogram2dcontour].contours
      Type: enumerated , one of ( "fill" | "heatmap" | "lines" | "none" )
      Default: "fill"

      Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace.

    • showlines
      Parent: data[type=histogram2dcontour].contours
      Type: boolean
      Default: TRUE

      Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".

    • showlabels
      Parent: data[type=histogram2dcontour].contours
      Type: boolean

      Determines whether to label the contour lines with their values.

    • labelfont
      Parent: data[type=histogram2dcontour].contours
      Type: named list containing one or more of the keys listed below.

      Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.

      • family
        Parent: data[type=histogram2dcontour].contours.labelfont
        Type: string

        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=histogram2dcontour].contours.labelfont
        Type: number greater than or equal to 1
      • color
        Parent: data[type=histogram2dcontour].contours.labelfont
        Type: color
    • labelformat
      Parent: data[type=histogram2dcontour].contours
      Type: string
      Default: ""

      Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • operation
      Parent: data[type=histogram2dcontour].contours
      Type: enumerated , one of ( "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
      Default: "="

      Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.

    • value
      Parent: data[type=histogram2dcontour].contours
      Type: number or categorical coordinate string
      Default: 0

      Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=histogram2dcontour].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=histogram2dcontour].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=histogram2dcontour].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=histogram2dcontour].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=histogram2dcontour].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.

  • ncontours
    Parent: data[type=histogram2dcontour]
    Type: integer greater than or equal to 1
    Default: 15

    Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "TRUE" or if `contours.size` is missing.

  • xcalendar
    Parent: data[type=histogram2dcontour]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • ycalendar
    Parent: data[type=histogram2dcontour]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `y` date data.

  • uirevision
    Parent: data[type=histogram2dcontour]
    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.

ohlc traces
A ohlc trace is initialized with plot_ly or add_trace:
plot_ly(df, type="ohlc"[, ...])
add_trace(p, type="ohlc"[, ...])
A ohlc trace accepts any of the keys listed below.

The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The tip of the lines represent the `low` and `high` values and the horizontal segments represent the `open` and `close` values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red.

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

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

  • visible
    Parent: data[type=ohlc]
    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=ohlc]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=ohlc]
    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=ohlc]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=ohlc]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=ohlc]
    Type: dataframe column, list, vector

    Sets the x coordinates. If absent, linear coordinate will be generated.

  • close
    Parent: data[type=ohlc]
    Type: dataframe column, list, vector

    Sets the close values.

  • open
    Parent: data[type=ohlc]
    Type: dataframe column, list, vector

    Sets the open values.

  • high
    Parent: data[type=ohlc]
    Type: dataframe column, list, vector

    Sets the high values.

  • low
    Parent: data[type=ohlc]
    Type: dataframe column, list, vector

    Sets the low values.

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

    Sets hover text elements associated with each sample point. 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 this trace's sample points.

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

    Same as `text`.

  • hoverinfo
    Parent: data[type=ohlc]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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.

  • meta
    Parent: data[type=ohlc]
    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=ohlc]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=ohlc]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=ohlc]
    Type: subplotid
    Default: y

    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.

  • line
    Parent: data[type=ohlc]
    Type: named list containing one or more of the keys listed below.
    • width
      Parent: data[type=ohlc].line
      Type: number greater than or equal to 0
      Default: 2

      [object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.

    • dash
      Parent: data[type=ohlc].line
      Type: string
      Default: "solid"

      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`.

  • selectedpoints
    Parent: data[type=ohlc]
    Type: number or categorical coordinate string

    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.

  • increasing
    Parent: data[type=ohlc]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=ohlc].increasing
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=ohlc].increasing.line
        Type: color
        Default: "#3D9970"

        Sets the line color.

      • width
        Parent: data[type=ohlc].increasing.line
        Type: number greater than or equal to 0
        Default: 2

        Sets the line width (in px).

      • dash
        Parent: data[type=ohlc].increasing.line
        Type: string
        Default: "solid"

        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

  • decreasing
    Parent: data[type=ohlc]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=ohlc].decreasing
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=ohlc].decreasing.line
        Type: color
        Default: "#FF4136"

        Sets the line color.

      • width
        Parent: data[type=ohlc].decreasing.line
        Type: number greater than or equal to 0
        Default: 2

        Sets the line width (in px).

      • dash
        Parent: data[type=ohlc].decreasing.line
        Type: string
        Default: "solid"

        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=ohlc].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=ohlc].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=ohlc].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=ohlc].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=ohlc].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.

    • split
      Parent: data[type=ohlc].hoverlabel
      Type: boolean

      Show hover information (open, close, high, low) in separate labels.

  • tickwidth
    Parent: data[type=ohlc]
    Type: number between or equal to 0 and 0.5
    Default: 0.3

    Sets the width of the open/close tick marks relative to the "x" minimal interval.

  • xcalendar
    Parent: data[type=ohlc]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • uirevision
    Parent: data[type=ohlc]
    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.

candlestick traces
A candlestick trace is initialized with plot_ly or add_trace:
plot_ly(df, type="candlestick"[, ...])
add_trace(p, type="candlestick"[, ...])
A candlestick trace accepts any of the keys listed below.

The candlestick is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The boxes represent the spread between the `open` and `close` values and the lines represent the spread between the `low` and `high` values Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red.

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

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

  • visible
    Parent: data[type=candlestick]
    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=candlestick]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=candlestick]
    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=candlestick]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=candlestick]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=candlestick]
    Type: dataframe column, list, vector

    Sets the x coordinates. If absent, linear coordinate will be generated.

  • close
    Parent: data[type=candlestick]
    Type: dataframe column, list, vector

    Sets the close values.

  • open
    Parent: data[type=candlestick]
    Type: dataframe column, list, vector

    Sets the open values.

  • high
    Parent: data[type=candlestick]
    Type: dataframe column, list, vector

    Sets the high values.

  • low
    Parent: data[type=candlestick]
    Type: dataframe column, list, vector

    Sets the low values.

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

    Sets hover text elements associated with each sample point. 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 this trace's sample points.

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

    Same as `text`.

  • hoverinfo
    Parent: data[type=candlestick]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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.

  • meta
    Parent: data[type=candlestick]
    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=candlestick]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=candlestick]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=candlestick]
    Type: subplotid
    Default: y

    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.

  • line
    Parent: data[type=candlestick]
    Type: named list containing one or more of the keys listed below.
    • width
      Parent: data[type=candlestick].line
      Type: number greater than or equal to 0
      Default: 2

      Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.

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

    Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

  • selectedpoints
    Parent: data[type=candlestick]
    Type: number or categorical coordinate string

    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.

  • increasing
    Parent: data[type=candlestick]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=candlestick].increasing
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=candlestick].increasing.line
        Type: color
        Default: "#3D9970"

        Sets the color of line bounding the box(es).

      • width
        Parent: data[type=candlestick].increasing.line
        Type: number greater than or equal to 0
        Default: 2

        Sets the width (in px) of line bounding the box(es).

    • fillcolor
      Parent: data[type=candlestick].increasing
      Type: color

      Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • decreasing
    Parent: data[type=candlestick]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=candlestick].decreasing
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=candlestick].decreasing.line
        Type: color
        Default: "#FF4136"

        Sets the color of line bounding the box(es).

      • width
        Parent: data[type=candlestick].decreasing.line
        Type: number greater than or equal to 0
        Default: 2

        Sets the width (in px) of line bounding the box(es).

    • fillcolor
      Parent: data[type=candlestick].decreasing
      Type: color

      Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=candlestick].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=candlestick].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=candlestick].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=candlestick].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=candlestick].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.

    • split
      Parent: data[type=candlestick].hoverlabel
      Type: boolean

      Show hover information (open, close, high, low) in separate labels.

  • xcalendar
    Parent: data[type=candlestick]
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

    Sets the calendar system to use with `x` date data.

  • uirevision
    Parent: data[type=candlestick]
    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.

waterfall traces
A waterfall trace is initialized with plot_ly or add_trace:
plot_ly(df, type="waterfall"[, ...])
add_trace(p, type="waterfall"[, ...])
A waterfall trace accepts any of the keys listed below.

Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in `y` if `orientation` is set th "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.

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

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

  • visible
    Parent: data[type=waterfall]
    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=waterfall]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=waterfall]
    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=waterfall]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=waterfall]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=waterfall]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=waterfall]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=waterfall]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • y
    Parent: data[type=waterfall]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=waterfall]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=waterfall]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

  • base
    Parent: data[type=waterfall]
    Type: number

    Sets where the bar base is drawn (in position axis units).

  • width
    Parent: data[type=waterfall]
    Type: number or array of numbers greater than or equal to 0

    Sets the bar width (in position axis units).

  • measure
    Parent: data[type=waterfall]
    Type: dataframe column, list, vector
    Default:

    An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.

  • offset
    Parent: data[type=waterfall]
    Type: number or array of numbers

    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.

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

    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.

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

    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.

  • texttemplate
    Parent: data[type=waterfall]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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 `initial`, `delta`, `final` and `label`.

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

    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.

  • hoverinfo
    Parent: data[type=waterfall]
    Type: flaglist string. Any combination of "name", "x", "y", "text", "initial", "delta", "final" joined with a "+" OR "all" or "none" or "skip".
    Examples: "name", "x", "name+x", "name+x+y", "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=waterfall]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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 `initial`, `delta` and `final`. 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=waterfall]
    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=waterfall]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=waterfall]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=waterfall]
    Type: subplotid
    Default: y

    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.

  • orientation
    Parent: data[type=waterfall]
    Type: enumerated , one of ( "v" | "h" )

    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).

  • alignmentgroup
    Parent: data[type=waterfall]
    Type: string
    Default: ""

    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.

  • offsetgroup
    Parent: data[type=waterfall]
    Type: string
    Default: ""

    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.

  • textangle
    Parent: data[type=waterfall]
    Type: angle
    Default: "auto"

    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.

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

    Sets the font used for `text`.

    • family
      Parent: data[type=waterfall].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=waterfall].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=waterfall].textfont
      Type: color or array of colors
  • textinfo
    Parent: data[type=waterfall]
    Type: flaglist string. Any combination of "label", "text", "initial", "delta", "final" joined with a "+" OR "none".
    Examples: "label", "text", "label+text", "label+text+initial", "none"

    Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

  • selectedpoints
    Parent: data[type=waterfall]
    Type: number or categorical coordinate string

    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.

  • cliponaxis
    Parent: data[type=waterfall]
    Type: boolean
    Default: TRUE

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

  • connector
    Parent: data[type=waterfall]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=waterfall].connector
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].connector.line
        Type: color
        Default: "#444"

        Sets the line color.

      • width
        Parent: data[type=waterfall].connector.line
        Type: number greater than or equal to 0
        Default: 2

        Sets the line width (in px).

      • dash
        Parent: data[type=waterfall].connector.line
        Type: string
        Default: "solid"

        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

    • mode
      Parent: data[type=waterfall].connector
      Type: enumerated , one of ( "spanning" | "between" )
      Default: "between"

      Sets the shape of connector lines.

    • visible
      Parent: data[type=waterfall].connector
      Type: boolean
      Default: TRUE

      Determines if connector lines are drawn.

  • constraintext
    Parent: data[type=waterfall]
    Type: enumerated , one of ( "inside" | "outside" | "both" | "none" )
    Default: "both"

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

  • increasing
    Parent: data[type=waterfall]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=waterfall].increasing
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].increasing.marker
        Type: color

        Sets the marker color of all increasing values.

      • line
        Parent: data[type=waterfall].increasing.marker
        Type: named list containing one or more of the keys listed below.
        • color
          Parent: data[type=waterfall].increasing.marker.line
          Type: color

          Sets the line color of all increasing values.

        • width
          Parent: data[type=waterfall].increasing.marker.line
          Type: number greater than or equal to 0
          Default: 0

          Sets the line width of all increasing values.

  • decreasing
    Parent: data[type=waterfall]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=waterfall].decreasing
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].decreasing.marker
        Type: color

        Sets the marker color of all decreasing values.

      • line
        Parent: data[type=waterfall].decreasing.marker
        Type: named list containing one or more of the keys listed below.
        • color
          Parent: data[type=waterfall].decreasing.marker.line
          Type: color

          Sets the line color of all decreasing values.

        • width
          Parent: data[type=waterfall].decreasing.marker.line
          Type: number greater than or equal to 0
          Default: 0

          Sets the line width of all decreasing values.

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=waterfall].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=waterfall].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=waterfall].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=waterfall].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=waterfall].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.

  • insidetextanchor
    Parent: data[type=waterfall]
    Type: enumerated , one of ( "end" | "middle" | "start" )
    Default: "end"

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

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

    Sets the font used for `text` lying inside the bar.

    • family
      Parent: data[type=waterfall].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=waterfall].insidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=waterfall].insidetextfont
      Type: color or array of colors
  • outsidetextfont
    Parent: data[type=waterfall]
    Type: named list containing one or more of the keys listed below.

    Sets the font used for `text` lying outside the bar.

    • family
      Parent: data[type=waterfall].outsidetextfont
      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=waterfall].outsidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=waterfall].outsidetextfont
      Type: color or array of colors
  • totals
    Parent: data[type=waterfall]
    Type: named list containing one or more of the keys listed below.
    • marker
      Parent: data[type=waterfall].totals
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].totals.marker
        Type: color

        Sets the marker color of all intermediate sums and total values.

      • line
        Parent: data[type=waterfall].totals.marker
        Type: named list containing one or more of the keys listed below.
        • color
          Parent: data[type=waterfall].totals.marker.line
          Type: color

          Sets the line color of all intermediate sums and total values.

        • width
          Parent: data[type=waterfall].totals.marker.line
          Type: number greater than or equal to 0
          Default: 0

          Sets the line width of all intermediate sums and total values.

  • uirevision
    Parent: data[type=waterfall]
    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.

funnel traces
A funnel trace is initialized with plot_ly or add_trace:
plot_ly(df, type="funnel"[, ...])
add_trace(p, type="funnel"[, ...])
A funnel trace accepts any of the keys listed below.

Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a "drop-off" representation wherein each item appears in each stage it traversed. See also the "funnelarea" trace type for a different approach to visualizing funnel data.

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

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

  • visible
    Parent: data[type=funnel]
    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=funnel]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=funnel]
    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=funnel]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=funnel]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=funnel]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • x0
    Parent: data[type=funnel]
    Type: number or categorical coordinate string
    Default: 0

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

  • dx
    Parent: data[type=funnel]
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

  • y
    Parent: data[type=funnel]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • y0
    Parent: data[type=funnel]
    Type: number or categorical coordinate string
    Default: 0

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

  • dy
    Parent: data[type=funnel]
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

  • width
    Parent: data[type=funnel]
    Type: number greater than or equal to 0

    Sets the bar width (in position axis units).

  • offset
    Parent: data[type=funnel]
    Type: number

    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.

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

    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.

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

    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.

  • texttemplate
    Parent: data[type=funnel]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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`.

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

    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.

  • hoverinfo
    Parent: data[type=funnel]
    Type: flaglist string. Any combination of "name", "x", "y", "text", "percent initial", "percent previous", "percent total" joined with a "+" OR "all" or "none" or "skip".
    Examples: "name", "x", "name+x", "name+x+y", "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=funnel]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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 "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.

  • meta
    Parent: data[type=funnel]
    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=funnel]
    Type: dataframe column, list, vector

    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

  • xaxis
    Parent: data[type=funnel]
    Type: subplotid
    Default: x

    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.

  • yaxis
    Parent: data[type=funnel]
    Type: subplotid
    Default: y

    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.

  • orientation
    Parent: data[type=funnel]
    Type: enumerated , one of ( "v" | "h" )

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

  • alignmentgroup
    Parent: data[type=funnel]
    Type: string
    Default: ""

    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.

  • offsetgroup
    Parent: data[type=funnel]
    Type: string
    Default: ""

    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.

  • marker
    Parent: data[type=funnel]
    Type: named list containing one or more of the keys listed below.
    • line
      Parent: data[type=funnel].marker
      Type: named list containing one or more of the keys listed below.
      • width
        Parent: data[type=funnel].marker.line
        Type: number or array of numbers greater than or equal to 0
        Default: 0

        Sets the width (in px) of the lines bounding the marker points.

      • color
        Parent: data[type=funnel].marker.line
        Type: color or array of colors

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • cauto
        Parent: data[type=funnel].marker.line
        Type: boolean
        Default: TRUE

        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.

      • cmin
        Parent: data[type=funnel].marker.line
        Type: number

        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.

      • cmax
        Parent: data[type=funnel].marker.line
        Type: number

        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.

      • cmid
        Parent: data[type=funnel].marker.line
        Type: number

        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.

      • colorscale
        Parent: data[type=funnel].marker.line
        Type: colorscale

        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

      • autocolorscale
        Parent: data[type=funnel].marker.line
        Type: boolean
        Default: TRUE

        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

      • reversescale
        Parent: data[type=funnel].marker.line
        Type: boolean

        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.

      • coloraxis
        Parent: data[type=funnel].marker.line
        Type: subplotid

        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • color
      Parent: data[type=funnel].marker
      Type: color or array of colors

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • cauto
      Parent: data[type=funnel].marker
      Type: boolean
      Default: TRUE

      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.

    • cmin
      Parent: data[type=funnel].marker
      Type: number

      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.

    • cmax
      Parent: data[type=funnel].marker
      Type: number

      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.

    • cmid
      Parent: data[type=funnel].marker
      Type: number

      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.

    • colorscale
      Parent: data[type=funnel].marker
      Type: colorscale

      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    • autocolorscale
      Parent: data[type=funnel].marker
      Type: boolean
      Default: TRUE

      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

    • reversescale
      Parent: data[type=funnel].marker
      Type: boolean

      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.

    • showscale
      Parent: data[type=funnel].marker
      Type: boolean

      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

    • colorbar
      Parent: data[type=funnel].marker
      Type: named list containing one or more of the keys listed below.
      • thicknessmode
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

      • thickness
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 30

        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

      • lenmode
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

      • len
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

      • x
        Parent: data[type=funnel].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the x direction.

      • y
        Parent: data[type=funnel].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the y direction.

      • outlinecolor
        Parent: data[type=funnel].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • bordercolor
        Parent: data[type=funnel].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • bgcolor
        Parent: data[type=funnel].marker.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=funnel].marker.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=funnel].marker.colorbar
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=funnel].marker.colorbar
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=funnel].marker.colorbar
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=funnel].marker.colorbar
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=funnel].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=funnel].marker.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=funnel].marker.colorbar
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=funnel].marker.colorbar
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=funnel].marker.colorbar.tickfont
          Type: string

          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=funnel].marker.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=funnel].marker.colorbar.tickfont
          Type: color
      • tickangle
        Parent: data[type=funnel].marker.colorbar
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=funnel].marker.colorbar
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=funnel].marker.colorbar
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=funnel].marker.colorbar.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=funnel].marker.colorbar.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=funnel].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=funnel].marker.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=funnel].marker.colorbar.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

      • tickprefix
        Parent: data[type=funnel].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=funnel].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=funnel].marker.colorbar
        Type: boolean

        If "TRUE", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=funnel].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

      • title
        Parent: data[type=funnel].marker.colorbar
        Type: named list containing one or more of the keys listed below.
        • text
          Parent: data[type=funnel].marker.colorbar.title
          Type: string

          Sets the title of the color bar. 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=funnel].marker.colorbar.title
          Type: named list containing one or more of the keys listed below.

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

          • family
            Parent: data[type=funnel].marker.colorbar.title.font
            Type: string

            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=funnel].marker.colorbar.title.font
            Type: number greater than or equal to 1
          • color
            Parent: data[type=funnel].marker.colorbar.title.font
            Type: color
        • side
          Parent: data[type=funnel].marker.colorbar.title
          Type: enumerated , one of ( "right" | "top" | "bottom" )
          Default: "top"

          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

    • coloraxis
      Parent: data[type=funnel].marker
      Type: subplotid

      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • opacity
      Parent: data[type=funnel].marker
      Type: number or array of numbers between or equal to 0 and 1
      Default: 1

      Sets the opacity of the bars.

  • textangle
    Parent: data[type=funnel]
    Type: angle
    Default: 0

    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.

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

    Sets the font used for `text`.

    • family
      Parent: data[type=funnel].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=funnel].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=funnel].textfont
      Type: color or array of colors
  • textinfo
    Parent: data[type=funnel]
    Type: flaglist string. Any combination of "label", "text", "percent initial", "percent previous", "percent total", "value" joined with a "+" OR "none".
    Examples: "label", "text", "label+text", "label+text+percent initial", "none"

    Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).

  • selectedpoints
    Parent: data[type=funnel]
    Type: number or categorical coordinate string

    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.

  • cliponaxis
    Parent: data[type=funnel]
    Type: boolean
    Default: TRUE

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

  • connector
    Parent: data[type=funnel]
    Type: named list containing one or more of the keys listed below.
    • fillcolor
      Parent: data[type=funnel].connector
      Type: color

      Sets the fill color.

    • line
      Parent: data[type=funnel].connector
      Type: named list containing one or more of the keys listed below.
      • color
        Parent: data[type=funnel].connector.line
        Type: color
        Default: "#444"

        Sets the line color.

      • width
        Parent: data[type=funnel].connector.line
        Type: number greater than or equal to 0
        Default: 0

        Sets the line width (in px).

      • dash
        Parent: data[type=funnel].connector.line
        Type: string
        Default: "solid"

        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

    • visible
      Parent: data[type=funnel].connector
      Type: boolean
      Default: TRUE

      Determines if connector regions and lines are drawn.

  • constraintext
    Parent: data[type=funnel]
    Type: enumerated , one of ( "inside" | "outside" | "both" | "none" )
    Default: "both"

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

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

      Sets the background color of the hover labels for this trace

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

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

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

      Sets the font used in hover labels.

      • family
        Parent: data[type=funnel].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=funnel].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=funnel].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=funnel].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=funnel].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.

  • insidetextanchor
    Parent: data[type=funnel]
    Type: enumerated , one of ( "end" | "middle" | "start" )
    Default: "middle"

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

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

    Sets the font used for `text` lying inside the bar.

    • family
      Parent: data[type=funnel].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=funnel].insidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=funnel].insidetextfont
      Type: color or array of colors
  • outsidetextfont
    Parent: data[type=funnel]
    Type: named list containing one or more of the keys listed below.

    Sets the font used for `text` lying outside the bar.

    • family
      Parent: data[type=funnel].outsidetextfont
      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=funnel].outsidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=funnel].outsidetextfont
      Type: color or array of colors
  • uirevision
    Parent: data[type=funnel]
    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.

funnelarea traces
A funnelarea trace is initialized with plot_ly or add_trace:
plot_ly(df, type="funnelarea"[, ...])
add_trace(p, type="funnelarea"[, ...])
A funnelarea trace accepts 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: named list 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: named list 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: dataframe column, list, vector

    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: dataframe column, list, vector

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

  • labels
    Parent: data[type=funnelarea]
    Type: dataframe column, list, vector

    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: dataframe column, list, vector

    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-3.x-api-reference/blob/master/Time-Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#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: dataframe column, list, vector

    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: named list containing one or more of the keys listed below.
    • x
      Parent: data[type=funnelarea].domain
      Type: list
      Default: [0, 1]

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

    • y
      Parent: data[type=funnelarea].domain
      Type: list
      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: named list containing one or more of the keys listed below.
    • colors
      Parent: data[type=funnelarea].marker
      Type: dataframe column, list, vector

      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: named list 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: named list 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: named list 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: named list 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: named list 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.

indicator traces
A indicator trace is initialized with plot_ly or add_trace:
plot_ly(df, type="indicator"[, ...])
add_trace(p, type="indicator"[, ...])
A indicator trace accepts any of the keys listed below.

An indicator is used to visualize a single `value` along with some contextual information such as `steps` or a `threshold`, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a `reference`. Gauges can be either angular or bullet (aka linear) gauges.

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

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

  • title
    Parent: data[type=indicator]
    Type: named list containing one or more of the keys listed below.
    • text
      Parent: data[type=indicator].title
      Type: string

      Sets the title of this indicator.

    • align
      Parent: data[type=indicator].title
      Type: enumerated , one of ( "left" | "center" | "right" )

      Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right.

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

      Set the font used to display the title

      • family
        Parent: data[type=indicator].title.font
        Type: string

        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=indicator].title.font
        Type: number greater than or equal to 1
      • color
        Parent: data[type=indicator].title.font
        Type: color
  • visible
    Parent: data[type=indicator]
    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).

  • mode
    Parent: data[type=indicator]
    Type: flaglist string. Any combination of "number", "delta", "gauge" joined with a "+"
    Examples: "number", "delta", "number+delta", "number+delta+gauge"
    Default: "number"

    Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis.

  • ids
    Parent: data[type=indicator]
    Type: dataframe column, list, vector

    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.

  • value
    Parent: data[type=indicator]
    Type: number

    Sets the number to be displayed.

  • meta
    Parent: data[type=indicator]
    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=indicator]
    Type: dataframe column, list, vector

    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=indicator]
    Type: named list containing one or more of the keys listed below.
    • x
      Parent: data[type=indicator].domain
      Type: list
      Default: [0, 1]

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

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

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

    • row
      Parent: data[type=indicator].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 indicator trace .

    • column
      Parent: data[type=indicator].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 indicator trace .

  • align
    Parent: data[type=indicator]
    Type: enumerated , one of ( "left" | "center" | "right" )

    Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

  • delta
    Parent: data[type=indicator]
    Type: named list containing one or more of the keys listed below.
    • reference
      Parent: data[type=indicator].delta
      Type: number

      Sets the reference value to compute the delta. By default, it is set to the current value.

    • position
      Parent: data[type=indicator].delta
      Type: enumerated , one of ( "top" | "bottom" | "left" | "right" )
      Default: "bottom"

      Sets the position of delta with respect to the number.

    • relative
      Parent: data[type=indicator].delta
      Type: boolean

      Show relative change

    • valueformat
      Parent: data[type=indicator].delta
      Type: string

      Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • increasing
      Parent: data[type=indicator].delta
      Type: named list containing one or more of the keys listed below.
      • symbol
        Parent: data[type=indicator].delta.increasing
        Type: string
        Default: "â–²"

        Sets the symbol to display for increasing value

      • color
        Parent: data[type=indicator].delta.increasing
        Type: color
        Default: "#3D9970"

        Sets the color for increasing value.

    • decreasing
      Parent: data[type=indicator].delta
      Type: named list containing one or more of the keys listed below.
      • symbol
        Parent: data[type=indicator].delta.decreasing
        Type: string
        Default: "â–¼"

        Sets the symbol to display for increasing value

      • color
        Parent: data[type=indicator].delta.decreasing
        Type: color
        Default: "#FF4136"

        Sets the color for increasing value.

    • font
      Parent: data[type=indicator].delta
      Type: named list containing one or more of the keys listed below.

      Set the font used to display the delta

      • family
        Parent: data[type=indicator].delta.font
        Type: string

        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=indicator].delta.font
        Type: number greater than or equal to 1
      • color
        Parent: data[type=indicator].delta.font
        Type: color
  • number
    Parent: data[type=indicator]
    Type: named list containing one or more of the keys listed below.
    • valueformat
      Parent: data[type=indicator].number
      Type: string
      Default: ""

      Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • font
      Parent: data[type=indicator].number
      Type: named list containing one or more of the keys listed below.

      Set the font used to display main number

      • family
        Parent: data[type=indicator].number.font
        Type: string

        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=indicator].number.font
        Type: number greater than or equal to 1
      • color
        Parent: data[type=indicator].number.font
        Type: color
    • prefix
      Parent: data[type=indicator].number
      Type: string
      Default: ""

      Sets a prefix appearing before the number.

    • suffix
      Parent: data[type=indicator].number
      Type: string
      Default: ""

      Sets a suffix appearing next to the number.

  • gauge
    Parent: data[type=indicator]
    Type: named list containing one or more of the keys listed below.

    The gauge of the Indicator plot.

    • shape
      Parent: data[type=indicator].gauge
      Type: enumerated , one of ( "angular" | "bullet" )
      Default: "angular"

      Set the shape of the gauge

    • bar
      Parent: data[type=indicator].gauge
      Type: named list containing one or more of the keys listed below.

      Set the appearance of the gauge's value

      • color
        Parent: data[type=indicator].gauge.bar
        Type: color
        Default: "green"

        Sets the background color of the arc.

      • line
        Parent: data[type=indicator].gauge.bar
        Type: named list containing one or more of the keys listed below.
        • color
          Parent: data[type=indicator].gauge.bar.line
          Type: color
          Default: "#444"

          Sets the color of the line enclosing each sector.

        • width
          Parent: data[type=indicator].gauge.bar.line
          Type: number greater than or equal to 0
          Default: 0

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

      • thickness
        Parent: data[type=indicator].gauge.bar
        Type: number between or equal to 0 and 1
        Default: 1

        Sets the thickness of the bar as a fraction of the total thickness of the gauge.

    • bgcolor
      Parent: data[type=indicator].gauge
      Type: color

      Sets the gauge background color.

    • bordercolor
      Parent: data[type=indicator].gauge
      Type: color
      Default: "#444"

      Sets the color of the border enclosing the gauge.

    • borderwidth
      Parent: data[type=indicator].gauge
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the border enclosing the gauge.

    • axis
      Parent: data[type=indicator].gauge
      Type: named list containing one or more of the keys listed below.
      • range
        Parent: data[type=indicator].gauge.axis
        Type: list

        Sets the range of this axis.

      • visible
        Parent: data[type=indicator].gauge.axis
        Type: boolean
        Default: TRUE

        A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE

      • tickmode
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=indicator].gauge.axis
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=indicator].gauge.axis
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=indicator].gauge.axis
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=indicator].gauge.axis
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=indicator].gauge.axis
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: "outside"

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=indicator].gauge.axis
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=indicator].gauge.axis
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=indicator].gauge.axis
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=indicator].gauge.axis
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=indicator].gauge.axis
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=indicator].gauge.axis.tickfont
          Type: string

          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=indicator].gauge.axis.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=indicator].gauge.axis.tickfont
          Type: color
      • tickangle
        Parent: data[type=indicator].gauge.axis
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=indicator].gauge.axis
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=indicator].gauge.axis
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

      • tickprefix
        Parent: data[type=indicator].gauge.axis
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=indicator].gauge.axis
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=indicator].gauge.axis
        Type: boolean

        If "TRUE", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

    • steps
      Parent: data[type=indicator].gauge
      Type: list of named list where each named list has one or more of the keys listed below.
      • color
        Parent: data[type=indicator].gauge.steps[]
        Type: color

        Sets the background color of the arc.

      • line
        Parent: data[type=indicator].gauge.steps[]
        Type: named list containing one or more of the keys listed below.
        • color
          Parent: data[type=indicator].gauge.steps[].line
          Type: color
          Default: "#444"

          Sets the color of the line enclosing each sector.

        • width
          Parent: data[type=indicator].gauge.steps[].line
          Type: number greater than or equal to 0
          Default: 0

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

      • thickness
        Parent: data[type=indicator].gauge.steps[]
        Type: number between or equal to 0 and 1
        Default: 1

        Sets the thickness of the bar as a fraction of the total thickness of the gauge.

      • range
        Parent: data[type=indicator].gauge.steps[]
        Type: list

        Sets the range of this axis.

      • name
        Parent: data[type=indicator].gauge.steps[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=indicator].gauge.steps[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

    • threshold
      Parent: data[type=indicator].gauge
      Type: named list containing one or more of the keys listed below.
      • line
        Parent: data[type=indicator].gauge.threshold
        Type: named list containing one or more of the keys listed below.
        • color
          Parent: data[type=indicator].gauge.threshold.line
          Type: color
          Default: "#444"

          Sets the color of the threshold line.

        • width
          Parent: data[type=indicator].gauge.threshold.line
          Type: number greater than or equal to 0
          Default: 1

          Sets the width (in px) of the threshold line.

      • thickness
        Parent: data[type=indicator].gauge.threshold
        Type: number between or equal to 0 and 1
        Default: 0.85

        Sets the thickness of the threshold line as a fraction of the thickness of the gauge.

      • value
        Parent: data[type=indicator].gauge.threshold
        Type: number

        Sets a treshold value drawn as a line.

  • uirevision
    Parent: data[type=indicator]
    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.

scatter3d traces
A scatter3d trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scatter3d"[, ...])
add_trace(p, type="scatter3d"[, ...])
A scatter3d trace accepts any of the keys listed below.

The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.

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

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

  • visible
    Parent: data[type=scatter3d]
    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=scatter3d]
    Type: boolean
    Default: TRUE

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

  • legendgroup
    Parent: data[type=scatter3d]
    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=scatter3d]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • mode
    Parent: data[type=scatter3d]
    Type: flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    Examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    Default: "lines+markers"

    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".

  • ids
    Parent: data[type=scatter3d]
    Type: dataframe column, list, vector

    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.

  • x
    Parent: data[type=scatter3d]
    Type: dataframe column, list, vector

    Sets the x coordinates.

  • y
    Parent: data[type=scatter3d]
    Type: dataframe column, list, vector

    Sets the y coordinates.

  • z
    Parent: data[type=scatter3d]
    Type: dataframe column, list, vector

    Sets the z coordinates.

  • surfacecolor
    Parent: data[type=scatter3d]
    Type: color

    Sets the surface fill color.

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

    Sets text elements associated with each (x,y,z) triplet. 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,z) coordinates. 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=scatter3d]
    Type: enumerated or array of enumerateds , one of ( "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    Default: "top center"

    Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • texttemplate
    Parent: data[type=scatter3d]
    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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available.

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

    Sets text elements associated with each (x,y,z) triplet. 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,z) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.

  • hoverinfo
    Parent: data[type=scatter3d]
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "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=scatter3d]
    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-3.x-api-reference/blob/master/Time-Formatting.md#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. 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=scatter3d]
    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=scatter3d]
    Type: dataframe column, list, vector

    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

  • scene
    Parent: data[type=scatter3d]
    Type: subplotid
    Default: scene

    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • marker
    Parent: data[type=scatter3d]
    Type: named list containing one or more of the keys listed below.
    • symbol
      Parent: data[type=scatter3d].marker
      Type: enumerated or array of enumerateds , one of ( "circle" | "circle-open" | "square" | "square-open" | "diamond" | "diamond-open" | "cross" | "x" )
      Default: "circle"

      Sets the marker symbol type.

    • size
      Parent: data[type=scatter3d].marker
      Type: number or array of numbers greater than or equal to 0
      Default: 8

      Sets the marker size (in px).

    • sizeref
      Parent: data[type=scatter3d].marker
      Type: number
      Default: 1

      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.

    • sizemin
      Parent: data[type=scatter3d].marker
      Type: number greater than or equal to 0
      Default: 0

      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

    • sizemode
      Parent: data[type=scatter3d].marker
      Type: enumerated , one of ( "diameter" | "area" )
      Default: "diameter"

      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.

    • opacity
      Parent: data[type=scatter3d].marker
      Type: number between or equal to 0 and 1

      Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set "marker.color" to an rgba color and use its alpha channel.

    • colorbar
      Parent: data[type=scatter3d].marker
      Type: named list containing one or more of the keys listed below.
      • thicknessmode
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

      • thickness
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 30

        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

      • lenmode
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

      • len
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

      • x
        Parent: data[type=scatter3d].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the x direction.

      • y
        Parent: data[type=scatter3d].marker.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the y direction.

      • outlinecolor
        Parent: data[type=scatter3d].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • bordercolor
        Parent: data[type=scatter3d].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • bgcolor
        Parent: data[type=scatter3d].marker.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=scatter3d].marker.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=scatter3d].marker.colorbar
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=scatter3d].marker.colorbar
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=scatter3d].marker.colorbar
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=scatter3d].marker.colorbar
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=scatter3d].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=scatter3d].marker.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=scatter3d].marker.colorbar
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=scatter3d].marker.colorbar
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=scatter3d].marker.colorbar.tickfont
          Type: string

          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=scatter3d].marker.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=scatter3d].marker.colorbar.tickfont
          Type: color
      • tickangle
        Parent: data[type=scatter3d].marker.colorbar
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=scatter3d].marker.colorbar
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=scatter3d].marker.colorbar
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=scatter3d].marker.colorbar.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=scatter3d].marker.colorbar.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=scatter3d].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=scatter3d].marker.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=scatter3d].marker.colorbar.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.

      • tickprefix
        Parent: data[type=scatter3d].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=scatter3d].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=scatter3d].marker.colorbar
        Type: boolean

        If "TRUE", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=scatter3d].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

      • title
        Parent: data[type=scatter3d].marker.colorbar
        Type: named list containing one or more of the keys listed below.
        • text
          Parent: data[type=scatter3d].marker.colorbar.title
          Type: string

          Sets the title of the color bar. 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=scatter3d].marker.colorbar.title
          Type: named list containing one or more of the keys listed below.

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

          • family
            Parent: data[type=scatter3d].marker.colorbar.title.font
            Type: string

            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=scatter3d].marker.colorbar.title.font
            Type: number greater than or equal to 1
          • color
            Parent: data[type=scatter3d].marker.colorbar.title.font
            Type: color
        • side
          Parent: data[type=scatter3d].marker.colorbar.title
          Type: enumerated , one of ( "right" | "top" | "bottom" )
          Default: "top"

          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

    • line
      Parent: data[type=scatter3d].marker
      Type: named list containing one or more of the keys listed below.
      • width
        Parent: data[type=scatter3d].marker.line
        Type: number greater than or equal to 0

        Sets the width (in px) of the lines bounding the marker points.

      • color
        Parent: data[type=scatter3d].marker.line
        Type: color or array of colors

        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.

      • cauto
        Parent: data[type=scatter3d].marker.line
        Type: boolean
        Default: TRUE

        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.

      • cmin
        Parent: data[type=scatter3d].marker.line
        Type: number

        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.

      • cmax
        Parent: data[type=scatter3d].marker.line
        Type: number

        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.

      • cmid
        Parent: data[type=scatter3d].marker.line
        Type: number

        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.

      • colorscale
        Parent: data[type=scatter3d].marker.line
        Type: colorscale

        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

      • autocolorscale
        Parent: data[type=scatter3d].marker.line
        Type: boolean
        Default: TRUE

        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

      • reversescale
        Parent: data[type=scatter3d].marker.line
        Type: boolean

        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.

      • coloraxis
        Parent: data[type=scatter3d].marker.line
        Type: subplotid

        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

    • color
      Parent: data[type=scatter3d].marker
      Type: color or array of colors

      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

    • cauto
      Parent: data[type=scatter3d].marker
      Type: boolean
      Default: TRUE

      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.

    • cmin
      Parent: data[type=scatter3d].marker
      Type: number

      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.

    • cmax
      Parent: data[type=scatter3d].marker
      Type: number

      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.

    • cmid
      Parent: data[type=scatter3d].marker
      Type: number

      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.

    • colorscale
      Parent: data[type=scatter3d].marker
      Type: colorscale

      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    • autocolorscale
      Parent: data[type=scatter3d].marker
      Type: boolean
      Default: TRUE

      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

    • reversescale
      Parent: data[type=scatter3d].marker
      Type: boolean

      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.

    • showscale
      Parent: data[type=scatter3d].marker
      Type: boolean

      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

    • coloraxis
      Parent: data[type=scatter3d].marker
      Type: subplotid

      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

  • line
    Parent: data[type=scatter3d]
    Type: named list containing one or more of the keys listed below.
    • width
      Parent: data[type=scatter3d].line
      Type: number greater than or equal to 0
      Default: 2

      Sets the line width (in px).

    • dash
      Parent: data[type=scatter3d].line
      Type: enumerated , one of ( "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
      Default: "solid"

      Sets the dash style of the lines.

    • color
      Parent: data[type=scatter3d].line
      Type: color or array of colors

      Sets thelinecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.

    • cauto
      Parent: data[type=scatter3d].line
      Type: boolean
      Default: TRUE

      Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `FALSE` when `line.cmin` and `line.cmax` are set by the user.

    • cmin
      Parent: data[type=scatter3d].line
      Type: number

      Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.

    • cmax
      Parent: data[type=scatter3d].line
      Type: number

      Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.

    • cmid
      Parent: data[type=scatter3d].line
      Type: number

      Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `FALSE`.

    • colorscale
      Parent: data[type=scatter3d].line
      Type: colorscale

      Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    • autocolorscale
      Parent: data[type=scatter3d].line
      Type: boolean
      Default: TRUE

      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

    • reversescale
      Parent: data[type=scatter3d].line
      Type: boolean

      Reverses the color mapping if TRUE. Has an effect only if in `line.color`is set to a numerical array. If TRUE, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.

    • showscale
      Parent: data[type=scatter3d].line
      Type: boolean

      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array.

    • colorbar
      Parent: data[type=scatter3d].line
      Type: named list containing one or more of the keys listed below.
      • thicknessmode
        Parent: data[type=scatter3d].line.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

      • thickness
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 30

        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

      • lenmode
        Parent: data[type=scatter3d].line.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

      • len
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

      • x
        Parent: data[type=scatter3d].line.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Parent: data[type=scatter3d].line.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the x direction.

      • y
        Parent: data[type=scatter3d].line.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Parent: data[type=scatter3d].line.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 10

        Sets the amount of padding (in px) along the y direction.

      • outlinecolor
        Parent: data[type=scatter3d].line.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • bordercolor
        Parent: data[type=scatter3d].line.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • bgcolor
        Parent: data[type=scatter3d].line.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: data[type=scatter3d].line.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=scatter3d].line.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=scatter3d].line.colorbar
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=scatter3d].line.colorbar
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=scatter3d].line.colorbar
        Type: dataframe column, list, vector

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=scatter3d].line.colorbar
        Type: dataframe column, list, vector

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=scatter3d].line.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=scatter3d].line.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=scatter3d].line.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=scatter3d].line.colorbar
        Type: boolean
        Default: TRUE

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=scatter3d].line.colorbar
        Type: named list containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=scatter3d].line.colorbar.tickfont
          Type: string

          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=scatter3d].line.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=scatter3d].line.colorbar.tickfont
          Type: color
      • tickangle
        Parent: data[type=scatter3d].line.colorbar
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=scatter3d].line.colorbar
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=scatter3d].line.colorbar
        Type: list of named list where each named list has one or more of the keys listed below.
        • enabled
          Parent: data[type=scatter3d].line.colorbar.tickformatstops[]
          Type: boolean
          Default: TRUE

          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=scatter3d].line.colorbar.tickformatstops[]
          Type: list

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=scatter3d].line.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=scatter3d].line.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.