plotly.js

The open source JavaScript graphing library that powers plotly

  • Open Source.
    These libraries are free forever. Your Pro plan helps keep them top notch.
  • Share Online.
    Share charts, dashboards, Jupyter notebooks, and presentations through our enterprise-grade cloud.
  • Engineering Support.
    Get instant chat support from our awesome engineering team.
Show Sidebar Hide Sidebar

plotly.js figure reference

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
        }
    ]
}


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.



  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • color (color)
    Sets the color of the whole mesh
  • ysrc
  • 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.
  • ksrc
  • 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.
  • xsrc
  • 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).
  • intensity (data array)
    Sets the vertex intensity values, used for plotting fields on meshes
  • 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.
  • contour
    • 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.
    • show (boolean)
      Sets whether or not dynamic contours are shown on hover
  • flatshading (boolean)
    Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
  • colorbar
    • 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.
    • 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.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • 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.
    • showticksuffix (enumerated: "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • titlefont
      Sets this color bar's title font.
      • color (color)
      • 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)
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • tickvalssrc
    • 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".
    • 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.
    • titleside (enumerated: "right" | "top" | "bottom" )
      default: "top"
      Determines the location of the colorbar title with respect to the color bar.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • 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-format/blob/master/README.md#locale_format And for dates see: https://github.com/d3/d3-time-format/blob/master/README.md#locale_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"
    • 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).
    • title (string)
      default: "Click to enter colorscale title"
      Sets the title of the color bar.
    • 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.
    • 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.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • ticktextsrc
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • 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.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • 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.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • 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`.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • 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`.
    • tickfont
      Sets the tick font.
      • color (color)
      • 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)
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • 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.
    • 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.
    • 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"
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • 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.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • 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.
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • facecolor (data array)
    Sets the color of each face Overrides "color" and "vertexcolor".
  • vertexcolorsrc
  • 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.
  • facecolorsrc
  • vertexcolor (data array)
    Sets the color of each vertex Overrides "color".
  • zsrc
  • 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.
  • 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.
  • type
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface.
  • 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.
  • lighting
    • 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.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 1e-06
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • 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.
    • 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.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • 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.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • 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.
  • jsrc
  • isrc
  • lightposition
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • 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 z space, use zmin and zmax
  • 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.
  • 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.
  • 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.
  • reversescale (boolean)
    Reverses the colorscale.
  • intensitysrc
  • 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.
  • 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.
  • 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.

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.



  • textposition (enumerated: "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.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • text (string)
    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).
  • textsrc
  • 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).
  • marker
    • colorsrc
    • cmin (number)
      Has an effect only if `marker.color` is set to a numerical array. Sets the lower bound of the color domain. Value should be associated to the `marker.color` array index, and if set, `marker.cmax` must be set as well.
    • color (color)
      Sets the marker color. 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 `cmin` and `cmax` if set.
    • sizesrc
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • reversescale (boolean)
      Has an effect only if `marker.color` is set to a numerical array. Reverses the color mapping if true (`cmin` will correspond to the last color in the array and `cmax` will correspond to the first color).
    • autocolorscale (boolean)
      default: true
      Has an effect only if `marker.color` is set to a numerical array. Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.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.
    • opacitysrc
    • 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.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • 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`.
    • 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.
    • symbolsrc
    • showscale (boolean)
      Has an effect only if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line
      • colorsrc
      • autocolorscale (boolean)
        default: true
        Has an effect only if `.color` is set to a numerical array. 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.
      • cmin (number)
        Has an effect only if `.color` is set to a numerical array. Sets the lower bound of the color domain. Value should be associated to the `.color` array index, and if set, `.cmax` must be set as well.
      • colorscale (colorscale)
        Sets the colorscale and only has an effect if `.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 `.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
      • color (color)
        Sets the color. 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 `cmin` and `cmax` if set.
      • reversescale (boolean)
        Has an effect only if `.color` is set to a numerical array. Reverses the color mapping if true (`cmin` will correspond to the last color in the array and `cmax` will correspond to the first color).
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • cauto (boolean)
        default: true
        Has an effect only if `.color` is set to a numerical array and `cmin`, `cmax` are set by the user. In this case, it controls whether the range of colors in `colorscale` is mapped to the range of values in the `color` array (`cauto: true`), or the `cmin`/`cmax` values (`cauto: false`). Defaults to `false` when `cmin`, `cmax` are set by the user.
      • widthsrc
      • cmax (number)
        Has an effect only if `.color` is set to a numerical array. Sets the upper bound of the color domain. Value should be associated to the `.color` array index, and if set, `.cmin` must be set as well.
    • colorscale (colorscale)
      Sets the colorscale and only has an effect if `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
    • colorbar
      • 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.
      • 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.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • 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.
      • showticksuffix (enumerated: "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • titlefont
        Sets this color bar's title font.
        • color (color)
        • 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)
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • tickvalssrc
      • 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".
      • 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.
      • titleside (enumerated: "right" | "top" | "bottom" )
        default: "top"
        Determines the location of the colorbar title with respect to the color bar.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • 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-format/blob/master/README.md#locale_format And for dates see: https://github.com/d3/d3-time-format/blob/master/README.md#locale_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"
      • 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).
      • title (string)
        default: "Click to enter colorscale title"
        Sets the title of the color bar.
      • 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.
      • 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.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • ticktextsrc
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • 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.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • 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.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • 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`.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • 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`.
      • tickfont
        Sets the tick font.
        • color (color)
        • 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)
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • 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.
      • 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.
      • 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"
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • 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.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • 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.
    • 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.
    • cauto (boolean)
      default: true
      Has an effect only if `marker.color` is set to a numerical array and `cmin`, `cmax` are set by the user. In this case, it controls whether the range of colors in `colorscale` is mapped to the range of values in the `color` array (`cauto: true`), or the `cmin`/`cmax` values (`cauto: false`). Defaults to `false` when `cmin`, `cmax` are set by the user.
    • cmax (number)
      Has an effect only if `marker.color` is set to a numerical array. Sets the upper bound of the color domain. Value should be associated to the `marker.color` array index, and if set, `marker.cmin` must be set as well.
    • 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.
  • 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".
  • 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.
  • asrc
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • 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
  • 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.
  • type
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • textfont
    Sets the text font.
  • 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.
  • textpositionsrc
  • bsrc
  • csrc
  • 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.
  • 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.
  • line
    • color (color)
      Sets the line color.
    • 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 style of the lines. Set to a dash string type or a dash length in px.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • 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.
  • 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`.
  • 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`.
  • 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`.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • 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, then the default is "lines+markers". Otherwise, "lines".

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.



  • cmin (number)
    Sets the lower bound of color domain.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • zsrc
  • text (data array)
    Sets the text elements associated with each z value.
  • 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.
  • 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.
  • xsrc
  • 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).
  • 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.
  • surfacecolorsrc
  • reversescale (boolean)
    Reverses the colorscale.
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • surfacecolor (data array)
    Sets the surface color values, used for setting a color scale independent of `z`.
  • 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.
  • contours
    • y
      • show (boolean)
        Determines whether or not contour lines about the y dimension are drawn.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
      • project
        • 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.
        • 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.
        • 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.
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlight (boolean)
        default: true
        Determines whether or not contour lines about the y dimension are highlighted on hover.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
    • x
      • show (boolean)
        Determines whether or not contour lines about the x dimension are drawn.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
      • project
        • 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.
        • 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.
        • 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.
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlight (boolean)
        default: true
        Determines whether or not contour lines about the x dimension are highlighted on hover.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
    • z
      • show (boolean)
        Determines whether or not contour lines about the z dimension are drawn.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
      • project
        • 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.
        • 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.
        • 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.
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlight (boolean)
        default: true
        Determines whether or not contour lines about the z dimension are highlighted on hover.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
  • ysrc
  • type
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface.
  • 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.
  • 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.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • lighting
    • 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.
    • 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.
    • 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.
    • 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.
  • textsrc
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • 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.
  • lightposition
    • y (number between or equal to -100000 and 100000)
      default: 10000
      Numeric vector, representing the Y coordinate for each vertex.
    • x (number between or equal to -100000 and 100000)
      default: 10
      Numeric vector, representing the X coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • z (data array)
    Sets the z coordinates.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • 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 z space, use zmin and zmax
  • colorbar
    • 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.
    • 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.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • 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.
    • showticksuffix (enumerated: "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • titlefont
      Sets this color bar's title font.
      • color (color)
      • 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)
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • tickvalssrc
    • 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".
    • 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.
    • titleside (enumerated: "right" | "top" | "bottom" )
      default: "top"
      Determines the location of the colorbar title with respect to the color bar.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • 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-format/blob/master/README.md#locale_format And for dates see: https://github.com/d3/d3-time-format/blob/master/README.md#locale_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"
    • 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).
    • title (string)
      default: "Click to enter colorscale title"
      Sets the title of the color bar.
    • 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.
    • 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.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • ticktextsrc
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • 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.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • 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.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • 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`.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • 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`.
    • tickfont
      Sets the tick font.
      • color (color)
      • 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)
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • 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.
    • 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.
    • 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"
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • 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.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • 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.
  • cauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • y (data array)
    Sets the y coordinates.
  • x (data array)
    Sets the x coordinates.
  • cmax (number)
    Sets the upper bound of color domain.

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.



  • zmax (number)
    Sets the upper bound of color domain.
  • 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).
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • zsrc
  • text (data array)
    Sets the text elements associated with each z value.
  • zmin (number)
    Sets the lower bound of color domain.
  • 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.
  • xsrc
  • 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).
  • 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.
  • 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.
  • line
    • color (color)
      Sets the color of the contour level. Has no 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 style of the lines. Set to a dash string type or a dash length in px.
    • 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.
  • colorbar
    • 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.
    • 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.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • 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.
    • showticksuffix (enumerated: "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • titlefont
      Sets this color bar's title font.
      • color (color)
      • 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)
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • tickvalssrc
    • 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".
    • 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.
    • titleside (enumerated: "right" | "top" | "bottom" )
      default: "top"
      Determines the location of the colorbar title with respect to the color bar.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • 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-format/blob/master/README.md#locale_format And for dates see: https://github.com/d3/d3-time-format/blob/master/README.md#locale_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"
    • 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).
    • title (string)
      default: "Click to enter colorscale title"
      Sets the title of the color bar.
    • 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.
    • 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.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • ticktextsrc
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • 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.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • 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.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • 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`.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • 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`.
    • tickfont
      Sets the tick font.
      • color (color)
      • 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)
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • 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.
    • 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.
    • 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"
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • 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.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • 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.
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • 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.
  • 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)
  • contours
    • 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.
    • end (number)
      Sets the end contour level value. Must be more than `contours.start`
    • showlines (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has only an effect if `contours.coloring` is set to "fill".
    • start (number)
      Sets the starting contour level value. Must be less than `contours.end`
    • size (number greater than or equal to 0)
      Sets the step between each contour level. Must be positive.
  • 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.
  • ysrc
  • type
  • 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.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • 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.
  • 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`.
  • transpose (boolean)
    Transposes the z data.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • textsrc
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • 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.
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • 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 z space, use zmin and zmax
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • 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.xaxis2`, and so on.
  • reversescale (boolean)
    Reverses the colorscale.
  • y (data array)
    Sets the y coordinates.
  • x (data array)
    Sets the x coordinates.
  • z (data array)
    Sets the z data.

area

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



  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • 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.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • rsrc
  • 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).
  • r (data array)
    For polar chart only.Sets the radial coordinates.
  • t (data array)
    For polar chart only.Sets the angular coordinates.
  • 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.
  • marker
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorsrc
    • color (color)
      Sets the marker color. 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 `cmin` and `cmax` if set.
    • opacitysrc
    • 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.
    • symbolsrc
    • sizesrc
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
  • tsrc
  • type

ohlc

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



  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • text (string)
    default: ""
    Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.
  • xsrc
  • high (data array)
    default:
    Sets the high values.
  • 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).
  • 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.
  • close (data array)
    default:
    Sets the close values.
  • open (data array)
    default:
    Sets the open values.
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • opensrc
  • low (data array)
    default:
    Sets the low values.
  • 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.
  • highsrc
  • increasing
    • showlegend (boolean)
      default: true
      Determines whether or not an item corresponding to this segment is shown in the legend.
    • line
      • color (color)
        default: "#3D9970"
        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 style of the lines. Set to a dash string type or a dash length in px.
    • name (string)
      Sets the segment name. The segment name appear as the legend item and on hover.
  • type
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • 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.
  • textsrc
  • 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.
  • line
    • dash (string)
      default: "solid"
      [object Object] Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`.
    • width (number greater than or equal to 0)
      default: 2
      [object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.
  • tickwidth (number between or equal to 0 and 0.5)
    default: 0.3
    Sets the width of the open/close tick marks relative to the "x" minimal interval.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • lowsrc
  • 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.xaxis2`, and so on.
  • decreasing
    • showlegend (boolean)
      default: true
      Determines whether or not an item corresponding to this segment is shown in the legend.
    • line
      • color (color)
        default: "#FF4136"
        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 style of the lines. Set to a dash string type or a dash length in px.
    • name (string)
      Sets the segment name. The segment name appear as the legend item and on hover.
  • x (data array)
    Sets the x coordinates. If absent, linear coordinate will be generated.
  • closesrc

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.



  • zmax (number)
    Sets the upper bound of color domain.
  • 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).
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • zsrc
  • text (data array)
    Sets the text elements associated with each z value.
  • zmin (number)
    Sets the lower bound of color domain.
  • 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.
  • xsrc
  • 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).
  • 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.
  • 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.
  • colorbar
    • 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.
    • 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.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • 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.
    • showticksuffix (enumerated: "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • titlefont
      Sets this color bar's title font.
      • color (color)
      • 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)
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • tickvalssrc
    • 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".
    • 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.
    • titleside (enumerated: "right" | "top" | "bottom" )
      default: "top"
      Determines the location of the colorbar title with respect to the color bar.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • 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-format/blob/master/README.md#locale_format And for dates see: https://github.com/d3/d3-time-format/blob/master/README.md#locale_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"
    • 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).
    • title (string)
      default: "Click to enter colorscale title"
      Sets the title of the color bar.
    • 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.
    • 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.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • ticktextsrc
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • 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.
    • separatethousands (boolean)
      If "true", even 4-digit integers are separated
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • 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.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • 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`.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • 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`.
    • tickfont
      Sets the tick font.
      • color (color)
      • 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)
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • 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.
    • 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.
    • 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"
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • 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.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • 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.
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • 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)
  • 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.
  • ysrc
  • ygap (number greater than or equal to 0)
    default: 0
    Sets the vertical gap (in pixels) between bricks.
  • type
  • 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.
  • zsmooth (enumerated: "fast" | "best" | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • 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.
  • transpose (boolean)
    Transposes the z data.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • xgap (number greater than or equal to 0)
    default: 0
    Sets the horizontal gap (in pixels) between bricks.
  • textsrc
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • 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.
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • 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 z space, use zmin and zmax
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • 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.xaxis2`, and so on.
  • reversescale (boolean)
    Reverses the colorscale.
  • y (data array)
    Sets the y coordinates.
  • x (data array)
    Sets the x coordinates.
  • z (data array)
    Sets the z data.

scattermapbox

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



  • textposition (enumerated: "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.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • text (string)
    default: ""
    Sets text elements associated with each (lon,lat) 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 (lon,lat) coordinates.
  • textsrc
  • 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).
  • marker
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorbar
      • 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.
      • 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.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • 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.
      • showticksuffix (enumerated: "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • titlefont
        Sets this color bar's title font.
        • color (color)
        • 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)
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • tickvalssrc
      • 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".
      • 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.
      • titleside (enumerated: "right" | "top" | "bottom" )
        default: "top"
        Determines the location of the colorbar title with respect to the color bar.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • 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-format/blob/master/README.md#locale_format And for dates see: https://github.com/d3/d3-time-format/blob/master/README.md#locale_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"
      • 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).
      • title (string)
        default: "Click to enter colorscale title"
        Sets the title of the color bar.
      • 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.
      • 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.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • ticktextsrc
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • 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.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • 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.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • 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`.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • 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`.
      • tickfont
        Sets the tick font.
        • color (color)
        • 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)
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • 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.
      • 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.
      • 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"
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • 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.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • 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.
    • autocolorscale (boolean)
      default: true
      Has an effect only if `marker.color` is set to a numerical array. Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.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.
    • 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`.
    • colorscale (colorscale)
      Sets the colorscale and only has an effect if `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
    • color (color)
      Sets the marker color. 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 `cmin` and `cmax` if set.
    • symbol (string)
      default: "circle"
      Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for "circle" symbols.
    • colorsrc
    • symbolsrc
    • reversescale (boolean)
      Has an effect only if `marker.color` is set to a numerical array. Reverses the color mapping if true (`cmin` will correspond to the last color in the array and `cmax` will correspond to the first color).
    • 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.
    • cauto (boolean)
      default: true
      Has an effect only if `marker.color` is set to a numerical array and `cmin`, `cmax` are set by the user. In this case, it controls whether the range of colors in `colorscale` is mapped to the range of values in the `color` array (`cauto: true`), or the `cmin`/`cmax` values (`cauto: false`). Defaults to `false` when `cmin`, `cmax` are set by the user.
    • showscale (boolean)
      Has an effect only if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • sizesrc
    • cmax (number)
      Has an effect only if `marker.color` is set to a numerical array. Sets the upper bound of the color domain. Value should be associated to the `marker.color` array index, and if set, `marker.cmin` must be set as well.
    • cmin (number)
      Has an effect only if `marker.color` is set to a numerical array. Sets the lower bound of the color domain. Value should be associated to the `marker.color` array index, and if set, `marker.cmax` must be set as well.
    • 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.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
  • fill (enumerated: "none" | "toself" )
    default: "none"
    Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • lon (data array)
    Sets the longitude coordinates (in degrees East).
  • type
  • lonsrc
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • textfont
    Sets the icon text font. Has an effect only when `type` is set to "symbol".
    • color (color)
    • family (string)
      default: "Open Sans Regular, Arial Unicode MS Regular"
      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)
  • 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.
  • 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.
  • hoverinfo (flaglist string)
    Any combination of "lon", "lat", "text", "name", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "lon", "lat", "lon+lat", "lon+lat+text", "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.
  • lat (data array)
    Sets the latitude coordinates (in degrees North).
  • latsrc
  • 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 style of the lines. Set to a dash string type or a dash length in px.
  • subplot (subplotid)
    default: mapbox
    Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • 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.

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.



  • textposition (enumerated: "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.
  • projection
    • y
      • 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.
      • show (boolean)
        Sets whether or not projections are shown along the y axis.
    • x
      • 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.
      • show (boolean)
        Sets whether or not projections are shown along the x axis.
    • z
      • 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.
      • show (boolean)
        Sets whether or not projections are shown along the z axis.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • zsrc
  • text (string)
    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.
  • 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.
  • 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.
  • xsrc
  • 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).
  • 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.
  • marker
    • 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.
    • reversescale (boolean)
      Has an effect only if `marker.color` is set to a numerical array. Reverses the color mapping if true (`cmin` will correspond to the last color in the array and `cmax` will correspond to the first color).
    • autocolorscale (boolean)
      default: true
      Has an effect only if `marker.color` is set to a numerical array. Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.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.
    • 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`.
    • colorscale (colorscale)
      Sets the colorscale and only has an effect if `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
    • color (color)
      Sets the marker color. 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 `cmin` and `cmax` if set.
    • symbol (enumerated: "circle" | "circle-open" | "square" | "square-open" | "diamond" | "diamond-open" | "cross" | "x" )
      default: "circle"
      Sets the marker symbol type.
    • colorsrc
    • symbolsrc
    • colorbar
      • 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.
      • 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.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • 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.
      • showticksuffix (enumerated: "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • titlefont
        Sets this color bar's title font.
        • color (color)
        • 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)
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • tickvalssrc
      • 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".
      • 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.
      • titleside (enumerated: "right" | "top" | "bottom" )
        default: "top"
        Determines the location of the colorbar title with respect to the color bar.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • 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-format/blob/master/README.md#locale_format And for dates see: https://github.com/d3/d3-time-format/blob/master/README.md#locale_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"
      • 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).
      • title (string)
        default: "Click to enter colorscale title"
        Sets the title of the color bar.
      • 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.
      • 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.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • ticktextsrc
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • 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.
      • separatethousands (boolean)
        If "true", even 4-digit integers are separated
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • 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.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • 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`.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • 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`.
      • tickfont
        Sets the tick font.
        • color (color)
        • 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)
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • 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.
      • 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.
      • 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"
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • 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.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • 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.
    • 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.
    • cauto (boolean)
      default: true
      Has an effect only if `marker.color` is set to a numerical array and `cmin`, `cmax` are set by the user. In this case, it controls whether the range of colors in `colorscale` is mapped to the range of values in the `color` array (`cauto: true`), or the `cmin`/`cmax` values (`cauto: false`). Defaults to `false` when `cmin`, `cmax` are set by the user.
    • showscale (boolean)
      Has an effect only if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • sizesrc
    • line
      • colorsrc
      • autocolorscale (boolean)
        default: true
        Has an effect only if `marker.line.color` is set to a numerical array. Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.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.
      • cmin (number)
        Has an effect only if `marker.line.color` is set to a numerical array. Sets the lower bound of the color domain. Value should be associated to the `marker.line.color` array index, and if set, `marker.line.cmax` must be set as well.
      • colorscale (colorscale)
        Sets the colorscale and only has an effect if `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
      • color (color)
        Sets the marker.line color. 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 `cmin` and `cmax` if set.
      • reversescale (boolean)
        Has an effect only if `marker.line.color` is set to a numerical array. Reverses the color mapping if true (`cmin` will correspond to the last color in the array and `cmax` will correspond to the first color).
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • cauto (boolean)
        default: true
        Has an effect only if `marker.line.color` is set to a numerical array and `cmin`, `cmax` are set by the user. In this case, it controls whether the range of colors in `colorscale` is mapped to the range of values in the `color` array (`cauto: true`), or the `cmin`/`cmax` values (`cauto: false`). Defaults to `false` when `cmin`, `cmax` are set by the user.
      • cmax (number)
        Has an effect only if `marker.line.color` is set to a numerical array. Sets the upper bound of the color domain. Value should be associated to the `marker.line.color` array index, and if set, `marker.line.cmin` must be set as well.
    • cmax (number)
      Has an effect only if `marker.color` is set to a numerical array. Sets the upper bound of the color domain. Value should be associated to the `marker.color` array index, and if set, `marker.cmin` must be set as well.
    • cmin (number)
      Has an effect only if `marker.color` is set to a numerical array. Sets the lower bound of the color domain. Value should be associated to the `marker.color` array index, and if set, `marker.cmax` must be set as well.
    • 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.
    • size (number greater than or equal to 0)
      default: 8
      Sets the marker size (in px).
  • x (data array)
    Sets the x coordinates.
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • error_x
    • copy_ystyle (boolean)
    • arraysrc
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • copy_zstyle (boolean)
    • 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.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • 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.
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • traceref (integer greater than or equal to 0)
      default: 0
    • 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
    • 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.
    • arrayminussrc
    • array (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • 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 "array", the bar lengths are set with data set `array`.
    • color (color)
      Sets the stoke color of the error bars.
  • error_y
    • copy_ystyle (boolean)
    • arraysrc
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • copy_zstyle (boolean)
    • 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.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • 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.
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • traceref (integer greater than or equal to 0)
      default: 0
    • 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
    • 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.
    • arrayminussrc
    • array (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • 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 "array", the bar lengths are set with data set `array`.
    • color (color)
      Sets the stoke color of the error bars.
  • error_z
    • copy_ystyle (boolean)
    • arraysrc
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • copy_zstyle (boolean)
    • 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.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • 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.
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • traceref (integer greater than or equal to 0)
      default: 0
    • 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
    • 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.
    • arrayminussrc
    • array (data array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • 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 "array", the bar lengths are set with data set `array`.
    • color (color)
      Sets the stoke color of the error bars.
  • surfacecolor (color)
    Sets the surface fill color.
  • 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.
  • ysrc
  • type
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • textfont
    Sets the text font.
  • 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.
  • textpositionsrc
  • textsrc
  • 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.
  • line
    • reversescale (boolean)
      Has an effect only if `line.color` is set to a numerical array. Reverses the color mapping if true (`cmin` will correspond to the last color in the array and `cmax` will correspond to the first color).
    • autocolorscale (boolean)
      default: true
      Has an effect only if `line.color` is set to a numerical array. Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.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.
    • cmin (number)
      Has an effect only if `line.color` is set to a numerical array. Sets the lower bound of the color domain. Value should be associated to the `line.color` array index, and if set, `line.cmax` must be set as well.
    • colorscale (colorscale)
      Sets the colorscale and only has an effect if `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
    • color (color)
      Sets the line color. 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 `cmin` and `cmax` if set.
    • dash (string)
      default: "solid"
      Sets the style of the lines. Set to a dash string type or a dash length in px.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • cauto (boolean)
      default: true
      Has an effect only if `line.color` is set to a numerical array and `cmin`, `cmax` are set by the user. In this case, it controls whether the range of colors in `colorscale` is mapped to the range of values in the `color` array (`cauto: true`), or the `cmin`/`cmax` values (`cauto: false`). Defaults to `false` when `cmin`, `cmax` are set by the user.
    • showscale (boolean)
      Has an effect only if `line.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • cmax (number)
      Has an effect only if `line.color` is set to a numerical array. Sets the upper bound of the color domain. Value should be associated to the `line.color` array index, and if set, `line.cmin` must be set as well.
    • colorsrc
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • 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, then the default is "lines+markers". Otherwise, "lines".
  • y (data array)
    Sets the y coordinates.
  • 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.
  • z (data array)
    Sets the z coordinates.