Show Sidebar Hide Sidebar

plotly.js figure reference

How are Plotly attributes organized?

plotly.js charts are described declaratively as JSON objects. Every aspect of a plotly chart (the colors, the grids, the data, and so on) has a corresponding JSON attribute. This page contains an extensive list of these attributes.

Plotly's graph description places attributes into two categories: traces (objects that 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). Traces are categorized by chart type (e.g. scatter, heatmap).

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

    data = [
        {
            type: 'scatter',  // all "scatter" attributes: https://plot.ly/javascript/reference/#scatter
            x: [1, 2, 3],     // more about "x": #scatter-x
            y: [3, 1, 6],     // #scatter-y
            marker: {         // marker is an object, valid marker keys: #scatter-marker
                color: 'rgb(16, 32, 77)' // more about "marker.color": #scatter-marker-color
            }
        },
        {
            type: 'bar',      // all "bar" chart attributes: #bar
            x: [1, 2, 3],     // more about "x": #bar-x
            y: [3, 1, 6],     // #bar-y
            name: 'bar chart example' // #bar-name
        }
    ];

    layout = {                     // all "layout" attributes: #layout
        title: 'simple example',  // more about "layout.title": #layout-title
        xaxis: {                  // all "layout.xaxis" attributes: #layout-xaxis
            title: 'time'         // more about "layout.xaxis.title": #layout-xaxis-title
        },
        annotations: [            // all "annotation" attributes: #layout-annotations
            {
                text: 'simple annotation',    // #layout-annotations-text
                x: 0,                         // #layout-annotations-x
                xref: 'paper',                // #layout-annotations-xref
                y: 0,                         // #layout-annotations-y
                yref: 'paper'                 // #layout-annotations-yref
            }
        ]
    }


Search

scatter

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



  • type ("scatter")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • x (data array)
    Sets the x coordinates.
  • x0 (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 (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (data array)
    Sets the y coordinates.
  • y0 (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 (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • stackgroup (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.
  • orientation ( enumerated : "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 ( enumerated : "" | "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.
  • stackgaps ( enumerated : "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.
  • text (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.
  • hovertext (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.
  • mode (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".
  • hoveron (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".
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • shape ( enumerated : "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 (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 (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 (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.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • cliponaxis (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".
  • fill ( enumerated : "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 (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • marker
    • symbol ( enumerated or array of enumerateds : "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 (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • maxdisplayed (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 (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 (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 ( enumerated : "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
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (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 (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 (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 (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 (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 (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 (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 (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 (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
      • type ( enumerated or array of enumerateds : "radial" | "horizontal" | "vertical" | "none" )
        default: "none"
        Sets the type of gradient used to fill the markers
      • color (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 (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 (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 (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 (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 (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 (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 (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 (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 (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
      • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "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 (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 (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 (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 (data array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (data array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "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 (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • tickangle (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 (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
        Each object has one or more of the keys listed below.
        • enabled (boolean)
          default: true
          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
        • dtickrange (array)
          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 (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (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 (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 (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "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 (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • exponentformat ( enumerated : "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 ( enumerated : "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
        • text (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
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "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 (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.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • textposition ( enumerated or array of enumerateds : "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.
  • textfont
    Sets the text font.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (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
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

bar

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



  • type ("bar")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • x (data array)
    Sets the x coordinates.
  • x0 (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 (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (data array)
    Sets the y coordinates.
  • y0 (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 (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (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.
  • hovertext (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.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • textposition ( enumerated or array of enumerateds : "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.
  • insidetextanchor ( enumerated : "end" | "middle" | "start" )
    default: "end"
    Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
  • textangle (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
    Sets the font used for `text`.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • insidetextfont
    Sets the font used for `text` lying inside the bar.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • outsidetextfont
    Sets the font used for `text` lying outside the bar.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • constraintext ( enumerated : "inside" | "outside" | "both" | "none" )
    default: "both"
    Constrain the size of text inside or outside a bar to be no larger than the bar itself.
  • cliponaxis (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".
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
  • base (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.
  • offset (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.
  • width (number or array of numbers greater than or equal to 0)
    Sets the bar width (in position axis units).
  • marker
    • line
      • width (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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
      • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "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 (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 (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 (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 (data array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (data array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "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 (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • tickangle (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 (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
        Each object has one or more of the keys listed below.
        • enabled (boolean)
          default: true
          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
        • dtickrange (array)
          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 (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (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 (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 (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "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 (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • exponentformat ( enumerated : "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 ( enumerated : "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
        • text (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
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "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 (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 (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the bars.
  • offsetgroup (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.
  • alignmentgroup (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.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (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
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

box

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



  • type ("box")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • y (data array)
    Sets the y sample data or coordinates. See overview for more info.
  • x (data array)
    Sets the x sample data or coordinates. See overview for more info.
  • x0 (number or categorical coordinate string)
    Sets the x coordinate of the box. See overview for more info.
  • y0 (number or categorical coordinate string)
    Sets the y coordinate of the box. See overview for more info.
  • name (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
  • text (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 (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • whiskerwidth (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).
  • notched (boolean)
    Determines whether or not notches should be drawn.
  • notchwidth (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).
  • boxpoints ( enumerated : "all" | "outliers" | "suspectedoutliers" | false )
    default: "outliers"
    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
  • boxmean ( enumerated : 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.
  • jitter (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).
  • pointpos (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
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
  • width (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.
  • marker
    • outliercolor (color)
      default: "rgba(0, 0, 0, 0)"
      Sets the color of the outlier sample points.
    • symbol ( enumerated : "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 (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (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
      • color (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 (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • outliercolor (color)
        Sets the border line color of the outlier sample points. Defaults to marker.color
      • outlierwidth (number greater than or equal to 0)
        default: 1
        Sets the border line width (in px) of the outlier sample points.
  • line
    • color (color)
      Sets the color of line bounding the box(es).
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the box(es).
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • offsetgroup (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.
  • alignmentgroup (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.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
  • hoveron (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?
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

heatmap

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



  • type ("heatmap")
  • visible ( enumerated : 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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • z (data array)
    Sets the z data.
  • x (data array)
    Sets the x coordinates.
  • x0 (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 (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (data array)
    Sets the y coordinates.
  • y0 (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 (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (data array)
    Sets the text elements associated with each z value.
  • hovertext (data array)
    Same as `text`.
  • transpose (boolean)
    Transposes the z data.
  • xtype ( enumerated : "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).
  • ytype ( enumerated : "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)
  • zsmooth ( enumerated : "fast" | "best" | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • xgap (number greater than or equal to 0)
    default: 0
    Sets the horizontal gap (in pixels) between bricks.
  • ygap (number greater than or equal to 0)
    default: 0
    Sets the vertical gap (in pixels) between bricks.
  • zhoverformat (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
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • zauto (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.
  • zmin (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.
  • zmax (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 (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`.
  • colorscale (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.
  • autocolorscale (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.
  • reversescale (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.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

histogram

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



  • type ("histogram")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • x (data array)
    Sets the sample data to be binned on the x axis.
  • y (data array)
    Sets the sample data to be binned on the y axis.
  • text (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 (string or array of strings)
    default: ""
    Same as `text`.
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
  • histfunc ( enumerated : "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 ( enumerated : "" | "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).
  • cumulative
    • enabled (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 ( enumerated : "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 ( enumerated : "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.
  • nbinsx (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.
  • xbins
    • start (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 (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 (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.
  • nbinsy (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.
  • ybins
    • start (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 (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 (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.
  • autobinx (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 (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 (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`
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • marker
    • line
      • width (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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
      • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "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 (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 (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 (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 (data array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (data array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "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 (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • tickangle (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 (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
        Each object has one or more of the keys listed below.
        • enabled (boolean)
          default: true
          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
        • dtickrange (array)
          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 (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (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 (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 (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "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 (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • exponentformat ( enumerated : "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 ( enumerated : "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
        • text (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
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "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 (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 (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the bars.
  • offsetgroup (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.
  • alignmentgroup (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.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (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
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

histogram2d

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



  • type ("histogram2d")
  • visible ( enumerated : 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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • x (data array)
    Sets the sample data to be binned on the x axis.
  • y (data array)
    Sets the sample data to be binned on the y axis.
  • z (data array)
    Sets the aggregation data.
  • marker
    • color (data array)
      Sets the aggregation data.
  • histnorm ( enumerated : "" | "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).
  • histfunc ( enumerated : "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.
  • nbinsx (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.
  • xbins
    • start (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 (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 (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).
  • nbinsy (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.
  • ybins
    • start (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 (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 (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).
  • autobinx (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 (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 (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 (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`
  • ybingroup (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`
  • xgap (number greater than or equal to 0)
    default: 0
    Sets the horizontal gap (in pixels) between bricks.
  • ygap (number greater than or equal to 0)
    default: 0
    Sets the vertical gap (in pixels) between bricks.
  • zsmooth ( enumerated : "fast" | "best" | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • zhoverformat (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
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • zauto (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.
  • zmin (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.
  • zmax (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 (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`.
  • colorscale (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.
  • autocolorscale (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.
  • reversescale (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.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

histogram2dcontour

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



  • type ("histogram2dcontour")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • x (data array)
    Sets the sample data to be binned on the x axis.
  • y (data array)
    Sets the sample data to be binned on the y axis.
  • z (data array)
    Sets the aggregation data.
  • marker
    • color (data array)
      Sets the aggregation data.
  • histnorm ( enumerated : "" | "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).
  • histfunc ( enumerated : "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.
  • nbinsx (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.
  • xbins
    • start (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 (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 (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).
  • nbinsy (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.
  • ybins
    • start (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 (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 (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).
  • autobinx (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 (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 (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 (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`
  • ybingroup (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`
  • autocontour (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`.
  • ncontours (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.
  • contours
    • type ( enumerated : "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 (number)
      Sets the starting contour level value. Must be less than `contours.end`
    • end (number)
      Sets the end contour level value. Must be more than `contours.start`
    • size (number greater than or equal to 0)
      Sets the step between each contour level. Must be positive.
    • coloring ( enumerated : "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 (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".
    • showlabels (boolean)
      Determines whether to label the contour lines with their values.
    • labelfont
      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 (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • labelformat (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 ( enumerated : "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
      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 (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.
  • line
    • color (color)
      Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (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 (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.
  • zhoverformat (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
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • zauto (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.
  • zmin (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.
  • zmax (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 (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`.
  • colorscale (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.
  • autocolorscale (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.
  • reversescale (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.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

contour

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



  • type ("contour")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • z (data array)
    Sets the z data.
  • x (data array)
    Sets the x coordinates.
  • x0 (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 (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (data array)
    Sets the y coordinates.
  • y0 (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 (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (data array)
    Sets the text elements associated with each z value.
  • hovertext (data array)
    Same as `text`.
  • transpose (boolean)
    Transposes the z data.
  • xtype ( enumerated : "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).
  • ytype ( enumerated : "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)
  • zhoverformat (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
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • fillcolor (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.
  • autocontour (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`.
  • ncontours (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.
  • contours
    • type ( enumerated : "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 (number)
      Sets the starting contour level value. Must be less than `contours.end`
    • end (number)
      Sets the end contour level value. Must be more than `contours.start`
    • size (number greater than or equal to 0)
      Sets the step between each contour level. Must be positive.
    • coloring ( enumerated : "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 (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".
    • showlabels (boolean)
      Determines whether to label the contour lines with their values.
    • labelfont
      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 (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • labelformat (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 ( enumerated : "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
      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 (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.
  • line
    • color (color)
      Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (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 (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.
  • zauto (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.
  • zmin (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.
  • zmax (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 (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`.
  • colorscale (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.
  • autocolorscale (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.
  • reversescale (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.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • xaxis (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 (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.

scatterternary

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



  • type ("scatterternary")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • a (data array)
    Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.
  • b (data array)
    Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.
  • c (data array)
    Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.
  • sum (number greater than or equal to 0)
    default: 0
    The number each triplet should sum to, if only two of `a`, `b`, and `c` are provided. This overrides `ternary<i>.sum` to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary<i>.sum
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    default: "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".
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a "text" flag.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (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").
    • shape ( enumerated : "linear" | "spline" )
      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 (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).
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • cliponaxis (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".
  • fill ( enumerated : "none" | "toself" | "tonext" )
    default: "none"
    Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "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.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • marker
    • symbol ( enumerated or array of enumerateds : "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 (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • maxdisplayed (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.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (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 (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 ( enumerated : "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
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (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 (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 (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 (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 (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 (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 (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 (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 (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
      • type ( enumerated or array of enumerateds : "radial" | "horizontal" | "vertical" | "none" )
        default: "none"
        Sets the type of gradient used to fill the markers
      • color (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 (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 (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 (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 (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 (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 (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 (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 (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 (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
      • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "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 (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 (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 (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 (data array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (data array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "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 (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • tickangle (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 (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
        Each object has one or more of the keys listed below.
        • enabled (boolean)
          default: true
          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
        • dtickrange (array)
          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 (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (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 (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 (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "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 (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • exponentformat ( enumerated : "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 ( enumerated : "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
        • text (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
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "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 (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.
  • textfont
    Sets the text font.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • textposition ( enumerated or array of enumerateds : "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.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • hoverinfo (flaglist string)
    Any combination of "a", "b", "c", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "a", "b", "a+b", "a+b+c", "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.
  • hoveron (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".
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • subplot (subplotid)
    default: ternary
    Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default value), the data refer to `layout.ternary`. If "ternary2", the data refer to `layout.ternary2`, and so on.

violin

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



  • type ("violin")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverinfo (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • y (data array)
    Sets the y sample data or coordinates. See overview for more info.
  • x (data array)
    Sets the x sample data or coordinates. See overview for more info.
  • x0 (number or categorical coordinate string)
    Sets the x coordinate of the box. See overview for more info.
  • y0 (number or categorical coordinate string)
    Sets the y coordinate of the box. See overview for more info.
  • name (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).
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
  • bandwidth (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.
  • scalegroup (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 ( enumerated : "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.
  • spanmode ( enumerated : "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.
  • span (array)
    Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual".
  • line
    • color (color)
      Sets the color of line bounding the violin(s).
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the violin(s).
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • points ( enumerated : "all" | "outliers" | "suspectedoutliers" | false )
    default: "outliers"
    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
  • jitter (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.
  • pointpos (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.
  • width (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.
  • marker
    • outliercolor (color)
      default: "rgba(0, 0, 0, 0)"
      Sets the color of the outlier sample points.
    • symbol ( enumerated : "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 (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (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
      • color (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 (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • outliercolor (color)
        Sets the border line color of the outlier sample points. Defaults to marker.color
      • outlierwidth (number greater than or equal to 0)
        default: 1
        Sets the border line width (in px) of the outlier sample points.
  • text (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 (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • box
    • visible (boolean)
      Determines if an miniature box plot is drawn inside the violins.
    • width (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 (color)
      Sets the inner box plot fill color.
    • line
      • color (color)
        Sets the inner box plot bounding line color.
      • width (number greater than or equal to 0)
        Sets the inner box plot bounding line width.
  • meanline
    • visible (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 (color)
      Sets the mean line color.
    • width (number greater than or equal to 0)
      Sets the mean line width.
  • side ( enumerated : "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".
  • offsetgroup (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.
  • alignmentgroup (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.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
  • hoveron (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?
  • xaxis (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 (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.

funnel

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



  • type ("funnel")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • x (data array)
    Sets the x coordinates.
  • x0 (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 (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (data array)
    Sets the y coordinates.
  • y0 (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 (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • hovertext (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.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • hoverinfo (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.
  • textinfo (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).
  • text (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 ( enumerated or array of enumerateds : "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.
  • insidetextanchor ( enumerated : "end" | "middle" | "start" )
    default: "middle"
    Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
  • textangle (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
    Sets the font used for `text`.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • insidetextfont
    Sets the font used for `text` lying inside the bar.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • outsidetextfont
    Sets the font used for `text` lying outside the bar.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • constraintext ( enumerated : "inside" | "outside" | "both" | "none" )
    default: "both"
    Constrain the size of text inside or outside a bar to be no larger than the bar itself.
  • cliponaxis (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".
  • orientation ( enumerated : "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".
  • offset (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.
  • width (number greater than or equal to 0)
    Sets the bar width (in position axis units).
  • marker
    • line
      • width (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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
      • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "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 (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 (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 (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 (data array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (data array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "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 (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • tickangle (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 (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
        Each object has one or more of the keys listed below.
        • enabled (boolean)
          default: true
          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
        • dtickrange (array)
          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 (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (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 (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 (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "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 (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • exponentformat ( enumerated : "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 ( enumerated : "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
        • text (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
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "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 (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 (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the bars.
  • connector
    • fillcolor (color)
      Sets the fill color.
    • line
      • color (color)
        default: "#444"
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 0
        Sets the line width (in px).
      • dash (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 (boolean)
      default: true
      Determines if connector regions and lines are drawn.
  • offsetgroup (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.
  • alignmentgroup (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.
  • xaxis (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 (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.

waterfall

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



  • type ("waterfall")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • selectedpoints (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • measure (data array)
    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.
  • base (number)
    Sets where the bar base is drawn (in position axis units).
  • x (data array)
    Sets the x coordinates.
  • x0 (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 (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (data array)
    Sets the y coordinates.
  • y0 (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 (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • hovertext (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.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • hoverinfo (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.
  • textinfo (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).
  • text (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 ( enumerated or array of enumerateds : "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.
  • insidetextanchor ( enumerated : "end" | "middle" | "start" )
    default: "end"
    Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
  • textangle (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
    Sets the font used for `text`.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • insidetextfont
    Sets the font used for `text` lying inside the bar.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • outsidetextfont
    Sets the font used for `text` lying outside the bar.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • constraintext ( enumerated : "inside" | "outside" | "both" | "none" )
    default: "both"
    Constrain the size of text inside or outside a bar to be no larger than the bar itself.
  • cliponaxis (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".
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
  • offset (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.
  • width (number or array of numbers greater than or equal to 0)
    Sets the bar width (in position axis units).
  • increasing
    • marker
      • color (color)
        Sets the marker color of all increasing values.
      • line
        • color (color)
          Sets the line color of all increasing values.
        • width (number greater than or equal to 0)
          default: 0
          Sets the line width of all increasing values.
  • decreasing
    • marker
      • color (color)
        Sets the marker color of all decreasing values.
      • line
        • color (color)
          Sets the line color of all decreasing values.
        • width (number greater than or equal to 0)
          default: 0
          Sets the line width of all decreasing values.
  • totals
    • marker
      • color (color)
        Sets the marker color of all intermediate sums and total values.
      • line
        • color (color)
          Sets the line color of all intermediate sums and total values.
        • width (number greater than or equal to 0)
          default: 0
          Sets the line width of all intermediate sums and total values.
  • connector
    • line
      • color (color)
        default: "#444"
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 2
        Sets the line width (in px).
      • dash (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 ( enumerated : "spanning" | "between" )
      default: "between"
      Sets the shape of connector lines.
    • visible (boolean)
      default: true
      Determines if connector lines are drawn.
  • offsetgroup (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.
  • alignmentgroup (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.
  • xaxis (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 (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.

pie

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



  • type ("pie")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • labels (data array)
    Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.
  • label0 (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.
  • dlabel (number)
    default: 1
    Sets the label step. See `label0` for more info.
  • values (data array)
    Sets the values of the sectors. If omitted, we count occurrences of each label.
  • marker
    • colors (data array)
      Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
    • line
      • color (color or array of colors)
        default: "#444"
        Sets the color of the line enclosing each sector.
      • width (number or array of numbers greater than or equal to 0)
        default: 0
        Sets the width (in px) of the line enclosing each sector.
  • text (data array)
    Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (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.
  • scalegroup (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.
  • textinfo (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.
  • hoverinfo (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 (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • textposition ( enumerated or array of enumerateds : "inside" | "outside" | "auto" | "none" )
    default: "auto"
    Specifies the location of the `textinfo`.
  • textfont
    Sets the font used for `textinfo`.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • insidetextfont
    Sets the font used for `textinfo` lying inside the sector.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • outsidetextfont
    Sets the font used for `textinfo` lying outside the sector.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • title
    • text (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
      Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • position ( enumerated : "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.
  • domain
    • x (array)
      default: [0, 1]
      Sets the horizontal domain of this pie trace (in plot fraction).
    • y (array)
      default: [0, 1]
      Sets the vertical domain of this pie trace (in plot fraction).
    • row (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 (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 .
  • hole (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.
  • sort (boolean)
    default: true
    Determines whether or not the sectors are reordered from largest to smallest.
  • direction ( enumerated : "clockwise" | "counterclockwise" )
    default: "counterclockwise"
    Specifies the direction at which succeeding sectors follow one another.
  • rotation (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.
  • pull (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.

sunburst

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



  • type ("sunburst")
  • visible ( enumerated : 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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • labels (data array)
    Sets the labels of each of the sunburst sectors.
  • parents (data array)
    Sets the parent sectors for each of the sunburst sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.
  • values (data array)
    Sets the values associated with each of the sunburst sectors. Use with `branchvalues` to determine how the values are summed.
  • branchvalues ( enumerated : "remainder" | "total" )
    default: "remainder"
    Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.
  • level (number or categorical coordinate string)
    Sets the level from which this sunburst trace hierarchy is rendered. Set `level` to `''` to start the sunburst from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.
  • maxdepth (integer)
    default: -1
    Sets the number of rendered sunburst rings from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy.
  • marker
    • colors (data array)
      Sets the color of each sector of this sunburst chart. If not specified, the default trace color set is used to pick the sector colors.
    • line
      • color (color or array of colors)
        Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.
      • width (number or array of numbers greater than or equal to 0)
        default: 1
        Sets the width (in px) of the line enclosing each sector.
  • leaf
    • opacity (number between or equal to 0 and 1)
      default: 0.7
      Sets the opacity of the leaves.
  • text (data array)
    Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • textinfo (flaglist string)
    Any combination of "label", "text", "value" joined with a "+" OR "none".
    examples: "label", "text", "label+text", "label+text+value", "none"
    Determines which trace information appear on the graph.
  • textfont
    Sets the font used for `textinfo`.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • hovertext (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 (flaglist string)
    Any combination of "label", "text", "value", "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 (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • insidetextfont
    Sets the font used for `textinfo` lying inside the sector.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • outsidetextfont
    Sets the font used for `textinfo` lying outside the sector.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • domain
    • x (array)
      default: [0, 1]
      Sets the horizontal domain of this sunburst trace (in plot fraction).
    • y (array)
      default: [0, 1]
      Sets the vertical domain of this sunburst trace (in plot fraction).
    • row (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 sunburst trace .
    • column (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 sunburst trace .

funnelarea

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



  • type ("funnelarea")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • labels (data array)
    Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.
  • label0 (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.
  • dlabel (number)
    default: 1
    Sets the label step. See `label0` for more info.
  • values (data array)
    Sets the values of the sectors. If omitted, we count occurrences of each label.
  • marker
    • colors (data array)
      Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
    • line
      • color (color or array of colors)
        Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.
      • width (number or array of numbers greater than or equal to 0)
        default: 1
        Sets the width (in px) of the line enclosing each sector.
  • text (data array)
    Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (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.
  • scalegroup (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.
  • textinfo (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.
  • hoverinfo (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 (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • textposition ( enumerated or array of enumerateds : "inside" | "none" )
    default: "inside"
    Specifies the location of the `textinfo`.
  • textfont
    Sets the font used for `textinfo`.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • insidetextfont
    Sets the font used for `textinfo` lying inside the sector.
    • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
  • title
    • text (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
      Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • position ( enumerated : "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.
  • domain
    • x (array)
      default: [0, 1]
      Sets the horizontal domain of this funnelarea trace (in plot fraction).
    • y (array)
      default: [0, 1]
      Sets the vertical domain of this funnelarea trace (in plot fraction).
    • row (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 (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 .
  • aspectratio (number greater than or equal to 0)
    default: 1
    Sets the ratio between height and width
  • baseratio (number between or equal to 0 and 1)
    default: 0.333
    Sets the ratio between bottom length and maximum top length.

scatter3d

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



  • type ("scatter3d")
  • visible ( enumerated : 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 (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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.
  • transforms
    Each object has one or more of the keys listed below.
  • uirevision (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.
  • x (data array)
    Sets the x coordinates.
  • y (data array)
    Sets the y coordinates.
  • z (data array)
    Sets the z coordinates.
  • text (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.
  • hovertext (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.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • mode (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".
  • surfaceaxis ( enumerated : "-1" | "0" | "1" | "2" )
    default: "-1"
    If "-1", the scatter points are not fill with a surface If "0", "1", "2", the scatter points are filled with a Delaunay surface about the x, y, z respectively.
  • surfacecolor (color)
    Sets the surface fill color.
  • projection
    • x
      • show (boolean)
        Sets whether or not projections are shown along the x axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • y
      • show (boolean)
        Sets whether or not projections are shown along the y axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • z
      • show (boolean)
        Sets whether or not projections are shown along the z axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • line
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash ( enumerated : "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
      default: "solid"
      Sets the dash style of the lines.
    • color (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 (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 (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 (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 (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 (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 (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 (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 (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
      • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "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 (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 (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 (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 (data array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (data array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "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 (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • tickangle (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 (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
        Each object has one or more of the keys listed below.
        • enabled (boolean)
          default: true
          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
        • dtickrange (array)
          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 (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (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 (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 (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "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 (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • exponentformat ( enumerated : "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 ( enumerated : "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
        • text (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
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "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 (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.
  • marker
    • symbol ( enumerated or array of enumerateds : "circle" | "circle-open" | "square" | "square-open" | "diamond" | "diamond-open" | "cross" | "x" )
      default: "circle"
      Sets the marker symbol type.
    • size (number or array of numbers greater than or equal to 0)
      default: 8
      Sets the marker size (in px).
    • sizeref (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 (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 ( enumerated : "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 (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
      • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "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 (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "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 (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 (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 (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 (data array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (data array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "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 (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • tickangle (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 (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
        Each object has one or more of the keys listed below.
        • enabled (boolean)
          default: true
          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
        • dtickrange (array)
          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 (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (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 (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 (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "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 (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • exponentformat ( enumerated : "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 ( enumerated : "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
        • text (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
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "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
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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.
  • textposition ( enumerated or array of enumerateds : "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.
  • textfont
    • color (color or array of colors)
    • size (number or array of numbers greater than or equal to 1)
    • family (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 plotly service (at https://plot.ly 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".
  • hoverinfo (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.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (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
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
  • error_z
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "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 (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 (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (data array)
      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 (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 (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 (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • zcalendar ( enumerated : "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 `z` date data.
  • scene (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.

surface

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



  • type ("surface")
  • visible ( enumerated : 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).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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 (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.
  • z (data array)
    Sets the z coordinates.
  • x (data array)
    Sets the x coordinates.
  • y (data array)
    Sets the y coordinates.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with each z value. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • surfacecolor (data array)
    Sets the surface color values, used for setting a color scale independent of `z`.
  • cauto (boolean)
    default: true
    Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when `cauto` is `false`.
  • colorscale (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`cmin` and `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 (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.
  • reversescale (boolean)
    Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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.
  • contours
    • x
      • show (boolean)
        Determines whether or not contour lines about the x dimension are drawn.
      • start (number)
        Sets the starting contour level value. Must be less than `contours.end`
      • end (number)
        Sets the end contour level value. Must be more than `contours.start`
      • size (number greater than or equal to 0)
        Sets the step between each contour level. Must be positive.
      • project
        • x (boolean)
          Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
        • y (boolean)
          Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
        • z (boolean)
          Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlight (boolean)
        default: true
        Determines whether or not contour lines about the x dimension are highlighted on hover.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
    • y
      • show (boolean)
        Determines whether or not contour lines about the y dimension are drawn.
      • start (number)
        Sets the starting contour level value. Must be less than `contours.end`
      • end (number)
        Sets the end contour level value. Must be more than `contours.start`
      • size (number greater than or equal to 0)
        Sets the step between each contour level. Must be positive.
      • project
        • x (boolean)
          Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
        • y (boolean)
          Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
        • z (boolean)
          Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlight (boolean)
        default: true
        Determines whether or not contour lines about the y dimension are highlighted on hover.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
    • z
      • show (boolean)
        Determines whether or not contour lines about the z dimension are drawn.
      • start (number)
        Sets the starting contour level value. Must be less than `contours.end`
      • end (number)
        Sets the end contour level value. Must be more than `contours.start`
      • size (number greater than or equal to 0)
        Sets the step between each contour level. Must be positive.
      • project
        • x (boolean)
          Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
        • y (boolean)
          Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
        • z (boolean)
          Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlight (boolean)
        default: true
        Determines whether or not contour lines about the z dimension are highlighted on hover.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
  • hidesurface (boolean)
    Determines whether or not a surface is drawn. For example, set `hidesurface` to "false" `contours.x.show` to "true" and `contours.y.show` to "true" to draw a wire frame plot.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 10
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 10000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • hoverinfo (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.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • zcalendar ( enumerated : "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 `z` date data.
  • scene (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.

isosurface

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



  • type ("isosurface")
  • visible ( enumerated : 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).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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 (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.
  • x (data array)
    Sets the X coordinates of the vertices on X axis.
  • y (data array)
    Sets the Y coordinates of the vertices on Y axis.
  • z (data array)
    Sets the Z coordinates of the vertices on Z axis.
  • value (data array)
    Sets the 4th dimension (value) of the vertices.
  • isomin (number)
    Sets the minimum boundary for iso-surface plot.
  • isomax (number)
    Sets the maximum boundary for iso-surface plot.
  • surface
    • show (boolean)
      default: true
      Hides/displays surfaces between minimum and maximum iso-values.
    • count (integer greater than or equal to 1)
      default: 2
      Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
    • fill (number between or equal to 0 and 1)
      default: 1
      Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • pattern (flaglist string)
      Any combination of "A", "B", "C", "D", "E" joined with a "+" OR "all" or "odd" or "even".
      examples: "A", "B", "A+B", "A+B+C", "all"
      default: "all"
      Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.
  • spaceframe
    • show (boolean)
      Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
    • fill (number between or equal to 0 and 1)
      default: 0.15
      Sets the fill ratio of the `spaceframe` elements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greater `fill` ratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1).
  • slices
    • x
      • show (boolean)
        Determines whether or not slice planes about the x dimension are drawn.
      • locations (data array)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • y
      • show (boolean)
        Determines whether or not slice planes about the y dimension are drawn.
      • locations (data array)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • z
      • show (boolean)
        Determines whether or not slice planes about the z dimension are drawn.
      • locations (data array)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • caps
    • x
      • show (boolean)
        default: true
        Sets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • y
      • show (boolean)
        default: true
        Sets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • z
      • show (boolean)
        default: true
        Sets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • cauto (boolean)
    default: true
    Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.
  • colorscale (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`cmin` and `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 (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.
  • reversescale (boolean)
    Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 0
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • flatshading (boolean)
    default: true
    Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
  • contour
    • show (boolean)
      Sets whether or not dynamic contours are shown on hover
    • color (color)
      default: "#444"
      Sets the color of the contour lines.
    • width (number between or equal to 1 and 16)
      default: 2
      Sets the width of the contour lines.
  • hoverinfo (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.
  • scene (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.

volume

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



  • type ("volume")
  • visible ( enumerated : 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).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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 (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.
  • x (data array)
    Sets the X coordinates of the vertices on X axis.
  • y (data array)
    Sets the Y coordinates of the vertices on Y axis.
  • z (data array)
    Sets the Z coordinates of the vertices on Z axis.
  • value (data array)
    Sets the 4th dimension (value) of the vertices.
  • isomin (number)
    Sets the minimum boundary for iso-surface plot.
  • isomax (number)
    Sets the maximum boundary for iso-surface plot.
  • surface
    • show (boolean)
      default: true
      Hides/displays surfaces between minimum and maximum iso-values.
    • count (integer greater than or equal to 1)
      default: 2
      Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
    • fill (number between or equal to 0 and 1)
      default: 1
      Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • pattern (flaglist string)
      Any combination of "A", "B", "C", "D", "E" joined with a "+" OR "all" or "odd" or "even".
      examples: "A", "B", "A+B", "A+B+C", "all"
      default: "all"
      Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.
  • spaceframe
    • show (boolean)
      Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
    • fill (number between or equal to 0 and 1)
      default: 1
      Sets the fill ratio of the `spaceframe` elements. The default fill value is 1 meaning that they are entirely shaded. Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • slices
    • x
      • show (boolean)
        Determines whether or not slice planes about the x dimension are drawn.
      • locations (data array)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • y
      • show (boolean)
        Determines whether or not slice planes about the y dimension are drawn.
      • locations (data array)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • z
      • show (boolean)
        Determines whether or not slice planes about the z dimension are drawn.
      • locations (data array)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • caps
    • x
      • show (boolean)
        default: true
        Sets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • y
      • show (boolean)
        default: true
        Sets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • z
      • show (boolean)
        default: true
        Sets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • cauto (boolean)
    default: true
    Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.
  • colorscale (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`cmin` and `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 (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.
  • reversescale (boolean)
    Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • opacityscale (number or categorical coordinate string)
    Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 0
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • flatshading (boolean)
    default: true
    Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
  • contour
    • show (boolean)
      Sets whether or not dynamic contours are shown on hover
    • color (color)
      default: "#444"
      Sets the color of the contour lines.
    • width (number between or equal to 1 and 16)
      default: 2
      Sets the width of the contour lines.
  • hoverinfo (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.
  • scene (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.

mesh3d

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



  • type ("mesh3d")
  • visible ( enumerated : 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).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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 (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.
  • x (data array)
    Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
  • y (data array)
    Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
  • z (data array)
    Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
  • i (data array)
    A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "first" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle.
  • j (data array)
    A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "second" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle.
  • k (data array)
    A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "third" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/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>`.
  • delaunayaxis ( enumerated : "x" | "y" | "z" )
    default: "z"
    Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation.
  • alphahull (number)
    default: -1
    Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If "-1", Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If "0", the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull.
  • intensity (data array)
    Sets the vertex intensity values, used for plotting fields on meshes
  • color (color)
    Sets the color of the whole mesh
  • vertexcolor (data array)
    Sets the color of each vertex Overrides "color". While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.
  • facecolor (data array)
    Sets the color of each face Overrides "color" and "vertexcolor".
  • cauto (boolean)
    default: true
    Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`.
  • colorscale (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`cmin` and `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 (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.
  • reversescale (boolean)
    Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
      • color (color)
    • tickangle (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 (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
      Each object has one or more of the keys listed below.
      • enabled (boolean)
        default: true
        Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
      • dtickrange (array)
        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 (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (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 (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 (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "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 (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • exponentformat ( enumerated : "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 ( enumerated : "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
      • text (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
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (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 plotly service (at https://plot.ly 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 (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "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 (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 (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • flatshading (boolean)
    Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
  • contour
    • show (boolean)
      Sets whether or not dynamic contours are shown on hover
    • color (color)
      default: "#444"
      Sets the color of the contour lines.
    • width (number between or equal to 1 and 16)
      default: 2
      Sets the width of the contour lines.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 1e-06
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • hoverinfo (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.
  • xcalendar ( enumerated : "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 ( enumerated : "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.
  • zcalendar ( enumerated : "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 `z` date data.
  • scene (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.

cone

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



  • type ("cone")
  • visible ( enumerated : 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).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (data array)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (data array)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (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.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (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 plotly service (at https://plot.ly 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 (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
    • align ( enumerated or array of enumerateds : "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 (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 (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.
  • x (data array)
    Sets the x coordinates of the vector field and of the displayed cones.
  • y (data array)
    Sets the y coordinates of the vector field and of the displayed cones.
  • z (data array)
    Sets the z coordinates of the vector field and of the displayed cones.
  • u (data array)
    Sets the x components of the vector field.
  • v (data array)
    Sets the y components of the vector field.
  • w (data array)
    Sets the z components of the vector field.
  • sizemode ( enumerated : "scaled" | "absolute" )
    default: "scaled"
    Determines whether `sizeref` is set as a "scaled" (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as "absolute" value (in the same units as the vector field).
  • sizeref (number greater than or equal to 0)
    Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to "scaled", `sizeref` is unitless, its default value is "0.5" With `sizemode` set to "absolute", `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm.
  • anchor ( enumerated : "tip" | "tail" | "cm" | "center" )
    default: "cm"
    Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (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. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `norm` 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>`.
  • cauto (boolean)
    default: true
    Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`.
  • colorscale (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`cmin` and `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 (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.
  • reversescale (boolean)
    Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "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 (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 ( enumerated : "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 (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 (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "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 (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "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 (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 (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 (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 (data array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (data array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "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 (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (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 plotly service (at https://plot.ly 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".