Skip to content

Surface

Overview

The surface trace type is used to create 3D surface plots, which visualize 3D data on a continuous surface. Surface plots are ideal for visualizing the relationship between three variables, often showing the interaction of two independent variables on a dependent variable. These plots are useful for understanding the shape of the data in three dimensions.

You can customize the colorscale, lighting, and contours to represent the surface data effectively.

Common Uses

  • 3D Data Visualization: Visualizing three variables with two independent variables and one dependent variable.
  • Topographical Maps: Representing elevations or contours of landscapes.
  • Heatmaps in 3D: Showing intensity variations in a 3D format.

Check out the Attributes for the full set of configuration options

Examples

Common Configurations

Here's a simple surface plot showing a continuous 3D surface:

You can copy this code below to create this chart in your project:

models:
  - name: surface-data
    args:
      - echo
      - |
        x,y,z
        1,1,1
        1,2,2
        1,3,3
        2,1,4
        2,2,5
        2,3,6
        3,1,7
        3,2,8
        3,3,9
traces:
  - name: Simple Surface Plot
    model: ref(surface-data)
    props:
      type: surface
      x: query(x)
      y: query(y)
      z: query(z)
charts:
  - name: Simple Surface Chart
    traces:
      - ref(Simple Surface Plot)
    layout:
      title:
        text: Simple Surface Plot<br><sub>3D Surface Visualization</sub>

This example demonstrates a surface plot with a custom colorscale applied to the surface:

Here's the code:

models:
  - name: surface-data-colorscale
    args:
      - echo
      - |
        x,y,z
        1,1,1
        1,2,2
        1,3,3
        2,1,4
        2,2,5
        2,3,6
        3,1,7
        3,2,8
        3,3,9
traces:
  - name: Surface Plot with Custom Colorscale
    model: ref(surface-data-colorscale)
    props:
      type: surface
      x: query(x)
      y: query(y)
      z: query(z)
      colorscale: "Viridis"
charts:
  - name: Surface Chart with Custom Colorscale
    traces:
      - ref(Surface Plot with Custom Colorscale)
    layout:
      title:
        text: Surface Plot with Custom Colorscale<br><sub>Custom Colorscale for 3D Surface</sub>

Here's a surface plot where contour lines are added to the surface, highlighting the shape of the surface more clearly:

Here's the code:

models:
  - name: surface-data-contours
    args:
      - echo
      - |
        x,y,z
        1,1,1
        1,2,2
        1,3,3
        2,1,4
        2,2,5
        2,3,6
        3,1,7
        3,2,8
        3,3,9
traces:
  - name: Surface Plot with Contours
    model: ref(surface-data-contours)
    props:
      type: surface
      x: query(x)
      y: query(y)
      z: query(z)
      contours:
        z:
          show: true
          usecolormap: true
          highlightcolor: "#ff0000"
charts:
  - name: Surface Chart with Contours
    traces:
      - ref(Surface Plot with Contours)
    layout:
      title:
        text: Surface Plot with Contours<br><sub>3D Surface with Contour Lines</sub>

Attributes

These attributes apply to traces where trace.props.type is set to surface. You would configure these attributes on the trace with the trace.props object. 

autocolorscale: 'boolean' #(1)!
cauto: 'boolean' #(2)!
cmax: 'number' #(3)!
cmid: 'number' #(4)!
cmin: 'number' #(5)!
coloraxis: 'subplotid' #(6)!
colorbar:
  bgcolor: 'color' #(7)!
  bordercolor: 'color' #(8)!
  borderwidth: 'number greater than or equal to 0' #(9)!
  dtick: 'number or categorical coordinate string' #(10)!
  exponentformat: 'enumerated , one of ( "none" | "e" | "e" | "power" | "si" | "b"
    )' #(11)!
  len: 'number greater than or equal to 0' #(12)!
  lenmode: 'enumerated , one of ( "fraction" | "pixels" )' #(13)!
  minexponent: 'number greater than or equal to 0' #(14)!
  nticks: 'integer greater than or equal to 0' #(15)!
  orientation: 'enumerated , one of ( "h" | "v" )' #(16)!
  outlinecolor: 'color' #(17)!
  outlinewidth: 'number greater than or equal to 0' #(18)!
  separatethousands: 'boolean' #(19)!
  showexponent: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(20)!
  showticklabels: 'boolean' #(21)!
  showtickprefix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(22)!
  showticksuffix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(23)!
  thickness: 'number greater than or equal to 0' #(24)!
  thicknessmode: 'enumerated , one of ( "fraction" | "pixels" )' #(25)!
  tick0: 'number or categorical coordinate string' #(26)!
  tickangle: 'angle' #(27)!
  tickcolor: 'color' #(28)!
  tickfont:
    color: color
    family: 'string' #(29)!
    size: number greater than or equal to 1
  tickformat: 'string' #(30)!
  tickformatstops:
    dtickrange: 'array' #(31)!
    enabled: 'boolean' #(32)!
    name: 'string' #(33)!
    templateitemname: 'string' #(34)!
    value: 'string' #(35)!
  ticklabeloverflow: 'enumerated , one of ( "allow" | "hide past div" | "hide past
    domain" )' #(36)!
  ticklabelposition: 'enumerated , one of ( "outside" | "inside" | "outside top" |
    "inside top" | "outside left" | "inside left" | "outside right" | "inside right"
    | "outside bottom" | "inside bottom" )' #(37)!
  ticklabelstep: 'integer greater than or equal to 1' #(38)!
  ticklen: 'number greater than or equal to 0' #(39)!
  tickmode: 'enumerated , one of ( "auto" | "linear" | "array" )' #(40)!
  tickprefix: 'string' #(41)!
  ticks: 'enumerated , one of ( "outside" | "inside" | "" )' #(42)!
  ticksuffix: 'string' #(43)!
  ticktext: 'data array' #(44)!
  tickvals: 'data array' #(45)!
  tickwidth: 'number greater than or equal to 0' #(46)!
  title:
    font:
      color: color
      family: 'string' #(47)!
      size: number greater than or equal to 1
    side: 'enumerated , one of ( "right" | "top" | "bottom" )' #(48)!
    text: 'string' #(49)!
  x: 'number between or equal to -2 and 3' #(50)!
  xanchor: 'enumerated , one of ( "left" | "center" | "right" )' #(51)!
  xpad: 'number greater than or equal to 0' #(52)!
  y: 'number between or equal to -2 and 3' #(53)!
  yanchor: 'enumerated , one of ( "top" | "middle" | "bottom" )' #(54)!
  ypad: 'number greater than or equal to 0' #(55)!
colorscale: 'colorscale' #(56)!
connectgaps: 'boolean' #(57)!
contours:
  x:
    color: 'color' #(58)!
    end: 'number' #(59)!
    highlight: 'boolean' #(60)!
    highlightcolor: 'color' #(61)!
    highlightwidth: 'number between or equal to 1 and 16' #(62)!
    project:
      x: 'boolean' #(63)!
      y: 'boolean' #(64)!
      z: 'boolean' #(65)!
    show: 'boolean' #(66)!
    size: 'number greater than or equal to 0' #(67)!
    start: 'number' #(68)!
    usecolormap: 'boolean' #(69)!
    width: 'number between or equal to 1 and 16' #(70)!
  y:
    color: 'color' #(71)!
    end: 'number' #(72)!
    highlight: 'boolean' #(73)!
    highlightcolor: 'color' #(74)!
    highlightwidth: 'number between or equal to 1 and 16' #(75)!
    project:
      x: 'boolean' #(76)!
      y: 'boolean' #(77)!
      z: 'boolean' #(78)!
    show: 'boolean' #(79)!
    size: 'number greater than or equal to 0' #(80)!
    start: 'number' #(81)!
    usecolormap: 'boolean' #(82)!
    width: 'number between or equal to 1 and 16' #(83)!
  z:
    color: 'color' #(84)!
    end: 'number' #(85)!
    highlight: 'boolean' #(86)!
    highlightcolor: 'color' #(87)!
    highlightwidth: 'number between or equal to 1 and 16' #(88)!
    project:
      x: 'boolean' #(89)!
      y: 'boolean' #(90)!
      z: 'boolean' #(91)!
    show: 'boolean' #(92)!
    size: 'number greater than or equal to 0' #(93)!
    start: 'number' #(94)!
    usecolormap: 'boolean' #(95)!
    width: 'number between or equal to 1 and 16' #(96)!
customdata: 'data array' #(97)!
hidesurface: 'boolean' #(98)!
hoverinfo: 'flaglist string. any combination of "x", "y", "z", "text", "name" joined
  with a "+" or "all" or "none" or "skip".' #(99)!
hoverlabel:
  align: 'enumerated or array of enumerateds , one of ( "left" | "right" | "auto"
    )' #(100)!
  bgcolor: 'color or array of colors' #(101)!
  bordercolor: 'color or array of colors' #(102)!
  font:
    color: color or array of colors
    family: 'string or array of strings' #(103)!
    size: number or array of numbers greater than or equal to 1
  namelength: 'integer or array of integers greater than or equal to -1' #(104)!
hovertemplate: 'string or array of strings' #(105)!
hovertext: 'string or array of strings' #(106)!
ids: 'data array' #(107)!
legendgroup: 'string' #(108)!
legendgrouptitle:
  font:
    color: color
    family: 'string' #(109)!
    size: number greater than or equal to 1
  text: 'string' #(110)!
legendrank: 'number' #(111)!
legendwidth: 'number greater than or equal to 0' #(112)!
lighting:
  ambient: 'number between or equal to 0 and 1' #(113)!
  diffuse: 'number between or equal to 0 and 1' #(114)!
  fresnel: 'number between or equal to 0 and 5' #(115)!
  roughness: 'number between or equal to 0 and 1' #(116)!
  specular: 'number between or equal to 0 and 2' #(117)!
lightposition:
  x: 'number between or equal to -100000 and 100000' #(118)!
  y: 'number between or equal to -100000 and 100000' #(119)!
  z: 'number between or equal to -100000 and 100000' #(120)!
meta: 'number or categorical coordinate string' #(121)!
opacity: 'number between or equal to 0 and 1' #(122)!
opacityscale: 'number or categorical coordinate string' #(123)!
reversescale: 'boolean' #(124)!
scene: 'subplotid' #(125)!
showlegend: 'boolean' #(126)!
showscale: 'boolean' #(127)!
surfacecolor: 'data array' #(128)!
text: 'string or array of strings' #(129)!
type: surface
uirevision: 'number or categorical coordinate string' #(130)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(131)!
x: 'data array' #(132)!
xcalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
  | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
  | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(133)!
xhoverformat: 'string' #(134)!
y: 'data array' #(135)!
ycalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
  | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
  | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(136)!
yhoverformat: 'string' #(137)!
z: 'data array' #(138)!
zcalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
  | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
  | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(139)!
zhoverformat: 'string' #(140)!
  1. 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.
  2. Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.
  3. Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmin must be set as well.
  4. Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when cauto is false.
  5. Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmax must be set as well.
  6. Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.
  7. Sets the color of padded area.
  8. Sets the axis line color.
  9. Sets the width (in px) or the border enclosing this color bar.
  10. 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", 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" 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"
  11. 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.
  12. 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.
  13. 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.
  14. Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is "SI" or "B".
  15. 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".
  16. Sets the orientation of the colorbar.
  17. Sets the axis line color.
  18. Sets the width (in px) of the axis line.
  19. If "true", even 4-digit integers are separated
  20. 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.
  21. Determines whether or not the tick labels are drawn.
  22. 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.
  23. Same as showtickprefix but for tick suffixes.
  24. Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
  25. 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.
  26. 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" (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.
  27. Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.
  28. Sets the tick color.
  29. HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
  30. 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/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{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"
  31. range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
  32. Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.
  33. When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.
  34. Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.
  35. string - dtickformat for described zoom level, the same as "tickformat"
  36. Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
  37. Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is "h", top and bottom when orientation is "v".
  38. Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type "log" or "multicategory", or when tickmode is "array".
  39. Sets the tick length (in px).
  40. 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).
  41. Sets a tick label prefix.
  42. 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.
  43. Sets a tick label suffix.
  44. Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to "array". Used with tickvals.
  45. Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to "array". Used with ticktext.
  46. Sets the tick width (in px).
  47. HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
  48. Determines the location of color bar's title with respect to the color bar. Defaults to "top" when orientation if "v" and defaults to "right" when orientation if "h". Note that the title's location used to be set by the now deprecated titleside attribute.
  49. Sets the title of the color bar. Note that before the existence of title.text, the title's contents used to be defined as the title attribute itself. This behavior has been deprecated.
  50. Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when orientation is "v" and 0.5 when orientation is "h".
  51. Sets this color bar's horizontal position anchor. This anchor binds the x position to the "left", "center" or "right" of the color bar. Defaults to "left" when orientation is "v" and "center" when orientation is "h".
  52. Sets the amount of padding (in px) along the x direction.
  53. Sets the y position of the color bar (in plot fraction). Defaults to 0.5 when orientation is "v" and 1.02 when orientation is "h".
  54. Sets this color bar's vertical position anchor This anchor binds the y position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when orientation is "v" and "bottom" when orientation is "h".
  55. Sets the amount of padding (in px) along the y direction.
  56. Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
  57. Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in.
  58. Sets the color of the contour lines.
  59. Sets the end contour level value. Must be more than contours.start
  60. Determines whether or not contour lines about the x dimension are highlighted on hover.
  61. Sets the color of the highlighted contour lines.
  62. Sets the width of the highlighted contour lines.
  63. 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.
  64. 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.
  65. 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.
  66. Determines whether or not contour lines about the x dimension are drawn.
  67. Sets the step between each contour level. Must be positive.
  68. Sets the starting contour level value. Must be less than contours.end
  69. An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
  70. Sets the width of the contour lines.
  71. Sets the color of the contour lines.
  72. Sets the end contour level value. Must be more than contours.start
  73. Determines whether or not contour lines about the y dimension are highlighted on hover.
  74. Sets the color of the highlighted contour lines.
  75. Sets the width of the highlighted contour lines.
  76. 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.
  77. 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.
  78. 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.
  79. Determines whether or not contour lines about the y dimension are drawn.
  80. Sets the step between each contour level. Must be positive.
  81. Sets the starting contour level value. Must be less than contours.end
  82. An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
  83. Sets the width of the contour lines.
  84. Sets the color of the contour lines.
  85. Sets the end contour level value. Must be more than contours.start
  86. Determines whether or not contour lines about the z dimension are highlighted on hover.
  87. Sets the color of the highlighted contour lines.
  88. Sets the width of the highlighted contour lines.
  89. 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.
  90. 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.
  91. 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.
  92. Determines whether or not contour lines about the z dimension are drawn.
  93. Sets the step between each contour level. Must be positive.
  94. Sets the starting contour level value. Must be less than contours.end
  95. An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
  96. Sets the width of the contour lines.
  97. Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  98. 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.
  99. 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.
  100. Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
  101. Sets the background color of the hover labels for this trace
  102. Sets the border color of the hover labels for this trace.
  103. HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
  104. Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.
  105. Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%_xother}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.
  106. Same as text.
  107. Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  108. Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  109. HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
  110. Sets the title of the legend group.
  111. Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with "reversed"legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.
  112. Sets the width (in px or fraction) of the legend for this trace.
  113. Ambient light increases overall color visibility but can wash out the image.
  114. Represents the extent that incident rays are reflected in a range of angles.
  115. 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.
  116. Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
  117. Represents the level that incident rays are reflected in a single direction, causing shine.
  118. Numeric vector, representing the X coordinate for each vertex.
  119. Numeric vector, representing the Y coordinate for each vertex.
  120. Numeric vector, representing the Z coordinate for each vertex.
  121. Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.
  122. Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  123. Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
  124. Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.
  125. 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.
  126. Determines whether or not an item corresponding to this trace is shown in the legend.
  127. Determines whether or not a colorbar is displayed for this trace.
  128. Sets the surface color values, used for setting a color scale independent of z.
  129. Sets the text elements associated with each z value. If trace hoverinfo contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  130. Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.
  131. 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).
  132. Sets the x coordinates.
  133. Sets the calendar system to use with x date data.
  134. Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{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"By default the values are formatted using xaxis.hoverformat.
  135. Sets the y coordinates.
  136. Sets the calendar system to use with y date data.
  137. Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{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"By default the values are formatted using yaxis.hoverformat.
  138. Sets the z coordinates.
  139. Sets the calendar system to use with z date data.
  140. Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{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"By default the values are formatted using zaxis.hoverformat.