Skip to content

Histogram2dcontour

Overview

The histogram2dcontour trace type is used to create 2D contour plots that represent the density of data points across two dimensions. Similar to a 2D histogram, this plot type bins data along the x and y axes but visualizes the density using contour lines instead of filled colors.

You can customize the binning along both axes, contour lines, and the color mapping to suit your data. This trace type is useful for visualizing patterns and clusters in bivariate data.

Common Uses

  • Density Contours: Showing how data points are distributed and clustered.
  • Joint Distribution Analysis: Visualizing the relationship between two variables with density contours.
  • Bivariate Statistical Analysis: Analyzing two variables and their joint behavior.

Check out the Attributes for the full set of configuration options

Examples

Common Configurations

Here's a simple histogram2dcontour plot showing the density of data points using contour lines:

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

models:
  - name: histogram2dcontour-data
    args:
      - echo
      - |
        x,y
        1,1
        2,3
        3,4
        4,5
        2,1
        3,2
        5,6
        4,2
        5,3
traces:
  - name: Simple 2D Contour Histogram
    model: ${ref(histogram2dcontour-data)}
    props:
      type: histogram2dcontour
      x: ?{x}
      y: ?{y}
      colorscale: "Viridis"
      contours:
        coloring: "none"
charts:
  - name: Simple 2D Contour Histogram
    traces:
      - ${ref(Simple 2D Contour Histogram)}
    layout:
      title:
        text: Simple 2D Contour Histogram<br><sub>Density Contours of Bivariate Data</sub>
      xaxis:
        title:
          text: "X Axis"
      yaxis:
        title:
          text: "Y Axis"

This example demonstrates a histogram2dcontour plot with filled contour regions to better visualize data density:

Here's the code:

models:
  - name: histogram2dcontour-data-filled
    args:
      - echo
      - |
        x,y
        2,1
        3,2
        4,3
        5,4
        6,5
        3,1
        4,2
        5,3
        6,4
traces:
  - name: 2D Contour Histogram with Filled Contours
    model: ${ref(histogram2dcontour-data-filled)}
    props:
      type: histogram2dcontour
      x: ?{x}
      y: ?{y}
      colorscale: "Blues"
      contours:
        coloring: "heatmap"
charts:
  - name: 2D Contour Histogram with Filled Contours
    traces:
      - ${ref(2D Contour Histogram with Filled Contours)}
    layout:
      title:
        text: 2D Contour Histogram with Filled Contours<br><sub>Filled Density Contours</sub>
      xaxis:
        title:
          text: "X Axis"
      yaxis:
        title:
          text: "Y Axis"

Here's a histogram2dcontour plot with custom bin sizes for both the x and y axes, allowing more control over the granularity of the plot:

Here's the code:

models:
  - name: histogram2dcontour-data-bins
    args:
      - echo
      - |
        x,y
        1,5
        2,6
        3,7
        2,4
        3,5
        4,6
        5,8
        4,3
        5,4
traces:
  - name: 2D Contour Histogram with Custom Bins
    model: ${ref(histogram2dcontour-data-bins)}
    props:
      type: histogram2dcontour
      x: ?{x}
      y: ?{y}
      xbins:
        size: 1
      ybins:
        size: 1
      colorscale: "Jet"
charts:
  - name: 2D Contour Histogram with Custom Bins
    traces:
      - ${ref(2D Contour Histogram with Custom Bins)}
    layout:
      title:
        text: 2D Contour Histogram with Custom Bins<br><sub>Custom Bin Sizes for X and Y</sub>
      xaxis:
        title:
          text: "X Axis"
      yaxis:
        title:
          text: "Y Axis"

A schema to validate plotly trace properties

Attributes

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

autobinx: 'boolean' #(1)!
autobiny: 'boolean' #(2)!
autocolorscale: 'boolean' #(3)!
autocontour: 'boolean' #(4)!
bingroup: 'string' #(5)!
coloraxis: 'string' #(6)!
colorbar:
  bgcolor: 'any' #(7)!
  bordercolor: 'any' #(8)!
  borderwidth: 'number' #(9)!
  exponentformat: 'any' #(10)!
  len: 'number' #(11)!
  lenmode: 'any' #(12)!
  minexponent: 'number' #(13)!
  nticks: 'integer' #(14)!
  orientation: 'any' #(15)!
  outlinecolor: 'any' #(16)!
  outlinewidth: 'number' #(17)!
  separatethousands: 'boolean' #(18)!
  showexponent: 'any' #(19)!
  showticklabels: 'boolean' #(20)!
  showtickprefix: 'any' #(21)!
  showticksuffix: 'any' #(22)!
  thickness: 'number' #(23)!
  thicknessmode: 'any' #(24)!
  tickangle: 'number' #(25)!
  tickcolor: 'any' #(26)!
  tickfont:
    color: any
    family: 'string' #(27)!
    lineposition: 'string' #(28)!
    shadow: 'string' #(29)!
    size: number
    style: 'any' #(30)!
    textcase: 'any' #(31)!
    variant: 'any' #(32)!
    weight: 'integer' #(33)!
  tickformat: 'string' #(34)!
  tickformatstops: array
  ticklabeloverflow: 'any' #(35)!
  ticklabelposition: 'any' #(36)!
  ticklabelstep: 'integer' #(37)!
  ticklen: 'number' #(38)!
  tickmode: 'any' #(39)!
  tickprefix: 'string' #(40)!
  ticks: 'any' #(41)!
  ticksuffix: 'string' #(42)!
  ticktext: 'array' #(43)!
  ticktextsrc: 'string' #(44)!
  tickvals: 'array' #(45)!
  tickvalssrc: 'string' #(46)!
  tickwidth: 'number' #(47)!
  title:
    font:
      color: any
      family: 'string' #(48)!
      lineposition: 'string' #(49)!
      shadow: 'string' #(50)!
      size: number
      style: 'any' #(51)!
      textcase: 'any' #(52)!
      variant: 'any' #(53)!
      weight: 'integer' #(54)!
    side: 'any' #(55)!
    text: 'string' #(56)!
  x: 'number' #(57)!
  xanchor: 'any' #(58)!
  xpad: 'number' #(59)!
  xref: 'any' #(60)!
  y: 'number' #(61)!
  yanchor: 'any' #(62)!
  ypad: 'number' #(63)!
  yref: 'any' #(64)!
colorscale: 'any' #(65)!
contours:
  coloring: 'any' #(66)!
  end: 'number' #(67)!
  impliedEdits: any
  labelfont:
    color: any
    family: 'string' #(68)!
    lineposition: 'string' #(69)!
    shadow: 'string' #(70)!
    size: number
    style: 'any' #(71)!
    textcase: 'any' #(72)!
    variant: 'any' #(73)!
    weight: 'integer' #(74)!
  labelformat: 'string' #(75)!
  operation: 'any' #(76)!
  showlabels: 'boolean' #(77)!
  showlines: 'boolean' #(78)!
  size: 'number' #(79)!
  start: 'number' #(80)!
  type: 'any' #(81)!
customdata: 'array' #(82)!
customdatasrc: 'string' #(83)!
histfunc: 'any' #(84)!
histnorm: 'any' #(85)!
hoverinfo: 'array' #(86)!
hoverinfosrc: 'string' #(87)!
hoverlabel:
  align: 'array' #(88)!
  alignsrc: 'string' #(89)!
  bgcolor: 'color | array' #(90)!
  bgcolorsrc: 'string' #(91)!
  bordercolor: 'color | array' #(92)!
  bordercolorsrc: 'string' #(93)!
  font:
    color: color | array
    colorsrc: 'string' #(94)!
    family: 'string | array' #(95)!
    familysrc: 'string' #(96)!
    lineposition: 'array' #(97)!
    linepositionsrc: 'string' #(98)!
    shadow: 'string | array' #(99)!
    shadowsrc: 'string' #(100)!
    size: number | array
    sizesrc: 'string' #(101)!
    style: 'array' #(102)!
    stylesrc: 'string' #(103)!
    textcase: 'array' #(104)!
    textcasesrc: 'string' #(105)!
    variant: 'array' #(106)!
    variantsrc: 'string' #(107)!
    weight: 'integer | array' #(108)!
    weightsrc: 'string' #(109)!
  namelength: 'integer | array' #(110)!
  namelengthsrc: 'string' #(111)!
hovertemplate: 'string | array' #(112)!
hovertemplatesrc: 'string' #(113)!
ids: 'array' #(114)!
idssrc: 'string' #(115)!
legend: 'string' #(116)!
legendgroup: 'string' #(117)!
legendgrouptitle:
  font:
    color: any
    family: 'string' #(118)!
    lineposition: 'string' #(119)!
    shadow: 'string' #(120)!
    size: number
    style: 'any' #(121)!
    textcase: 'any' #(122)!
    variant: 'any' #(123)!
    weight: 'integer' #(124)!
  text: 'string' #(125)!
legendrank: 'number' #(126)!
legendwidth: 'number' #(127)!
line:
  color: 'any' #(128)!
  dash: 'string' #(129)!
  smoothing: 'number' #(130)!
  width: 'number' #(131)!
marker:
  color: 'array' #(132)!
  colorsrc: 'string' #(133)!
metasrc: 'string' #(134)!
name: 'string' #(135)!
nbinsx: 'integer' #(136)!
nbinsy: 'integer' #(137)!
ncontours: 'integer' #(138)!
opacity: 'number' #(139)!
reversescale: 'boolean' #(140)!
showlegend: 'boolean' #(141)!
showscale: 'boolean' #(142)!
stream:
  maxpoints: 'number' #(143)!
  token: 'string' #(144)!
textfont:
  color: any
  family: 'string' #(145)!
  lineposition: 'string' #(146)!
  shadow: 'string' #(147)!
  size: number
  style: 'any' #(148)!
  textcase: 'any' #(149)!
  variant: 'any' #(150)!
  weight: 'integer' #(151)!
texttemplate: 'string' #(152)!
type: histogram2dcontour
uid: 'string' #(153)!
visible: 'any' #(154)!
x: 'array' #(155)!
xaxis: 'string' #(156)!
xbingroup: 'string' #(157)!
xbins: {}
xcalendar: 'any' #(158)!
xhoverformat: 'string' #(159)!
xsrc: 'string' #(160)!
y: 'array' #(161)!
yaxis: 'string' #(162)!
ybingroup: 'string' #(163)!
ybins: {}
ycalendar: 'any' #(164)!
yhoverformat: 'string' #(165)!
ysrc: 'string' #(166)!
z: 'array' #(167)!
zauto: 'boolean' #(168)!
zhoverformat: 'string' #(169)!
zmax: 'number' #(170)!
zmid: 'number' #(171)!
zmin: 'number' #(172)!
zsrc: 'string' #(173)!
  1. Obsolete: since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.
  2. Obsolete: since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.
  3. 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.
  4. 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.
  5. Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.
  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. 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.
  11. 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.
  12. 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.
  13. Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.
  14. 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.
  15. Sets the orientation of the colorbar.
  16. Sets the axis line color.
  17. Sets the width (in px) of the axis line.
  18. If "true", even 4-digit integers are separated
  19. 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.
  20. Determines whether or not the tick labels are drawn.
  21. 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.
  22. Same as showtickprefix but for tick suffixes.
  23. Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
  24. 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.
  25. Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.
  26. Sets the tick color.
  27. HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
  28. Sets the kind of decoration line(s) with text, such as an under, over or through as well as combinations e.g. under+over, etc.
  29. Sets the shape and color of the shadow behind text. auto places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
  30. Sets whether a font should be styled with a normal or italic face from its family.
  31. Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
  32. Sets the variant of the font.
  33. Sets the weight (or boldness) of the font.
  34. 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
  35. 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.
  36. 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.
  37. 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.
  38. Sets the tick length (in px).
  39. 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).
  40. Sets a tick label prefix.
  41. 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.
  42. Sets a tick label suffix.
  43. Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.
  44. Sets the source reference on Chart Studio Cloud for ticktext.
  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 source reference on Chart Studio Cloud for tickvals.
  47. Sets the tick width (in px).
  48. HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
  49. Sets the kind of decoration line(s) with text, such as an under, over or through as well as combinations e.g. under+over, etc.
  50. Sets the shape and color of the shadow behind text. auto places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
  51. Sets whether a font should be styled with a normal or italic face from its family.
  52. Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
  53. Sets the variant of the font.
  54. Sets the weight (or boldness) of the font.
  55. 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.
  56. Sets the title of the color bar.
  57. Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.
  58. 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.
  59. Sets the amount of padding (in px) along the x direction.
  60. Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.
  61. Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.
  62. 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.
  63. Sets the amount of padding (in px) along the y direction.
  64. Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.
  65. Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
  66. 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.
  67. Sets the end contour level value. Must be more than contours.start
  68. HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
  69. Sets the kind of decoration line(s) with text, such as an under, over or through as well as combinations e.g. under+over, etc.
  70. Sets the shape and color of the shadow behind text. auto places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
  71. Sets whether a font should be styled with a normal or italic face from its family.
  72. Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
  73. Sets the variant of the font.
  74. Sets the weight (or boldness) of the font.
  75. Sets the contour 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.
  76. Sets the constraint operation. = keeps regions equal to value. < and <= keep regions less than value. > and >= keep regions greater than value. [], (), [), and (] keep regions inside value[0] and value[1]. ][, )(, ](, and )[ keep regions outside value[0] and value[1]. Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.
  77. Determines whether to label the contour lines with their values.
  78. Determines whether or not the contour lines are drawn. Has an effect only if contours.coloring is set to fill.
  79. Sets the step between each contour level. Must be positive.
  80. Sets the starting contour level value. Must be less than contours.end
  81. If levels, the data is represented as a contour plot with multiple levels displayed. If constraint, the data is represented as constraints with the invalid region shaded as specified by the operation and value parameters.
  82. 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
  83. Sets the source reference on Chart Studio Cloud for customdata.
  84. Specifies the binning function used for this histogram trace. If count, the histogram values are computed by counting the number of values lying inside each bin. If sum, avg, min, max, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  85. Specifies the type of normalization used for this histogram trace. If , the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If percent / probability, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If density, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
  86. 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.
  87. Sets the source reference on Chart Studio Cloud for hoverinfo.
  88. 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
  89. Sets the source reference on Chart Studio Cloud for align.
  90. Sets the background color of the hover labels for this trace
  91. Sets the source reference on Chart Studio Cloud for bgcolor.
  92. Sets the border color of the hover labels for this trace.
  93. Sets the source reference on Chart Studio Cloud for bordercolor.
  94. Sets the source reference on Chart Studio Cloud for color.
  95. HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
  96. Sets the source reference on Chart Studio Cloud for family.
  97. Sets the kind of decoration line(s) with text, such as an under, over or through as well as combinations e.g. under+over, etc.
  98. Sets the source reference on Chart Studio Cloud for lineposition.
  99. Sets the shape and color of the shadow behind text. auto places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
  100. Sets the source reference on Chart Studio Cloud for shadow.
  101. Sets the source reference on Chart Studio Cloud for size.
  102. Sets whether a font should be styled with a normal or italic face from its family.
  103. Sets the source reference on Chart Studio Cloud for style.
  104. Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
  105. Sets the source reference on Chart Studio Cloud for textcase.
  106. Sets the variant of the font.
  107. Sets the source reference on Chart Studio Cloud for variant.
  108. Sets the weight (or boldness) of the font.
  109. Sets the source reference on Chart Studio Cloud for weight.
  110. 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.
  111. Sets the source reference on Chart Studio Cloud for namelength.
  112. 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. Finally, the template string has access to variable z 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>.
  113. Sets the source reference on Chart Studio Cloud for hovertemplate.
  114. 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.
  115. Sets the source reference on Chart Studio Cloud for ids.
  116. Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.
  117. Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
  118. HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
  119. Sets the kind of decoration line(s) with text, such as an under, over or through as well as combinations e.g. under+over, etc.
  120. Sets the shape and color of the shadow behind text. auto places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
  121. Sets whether a font should be styled with a normal or italic face from its family.
  122. Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
  123. Sets the variant of the font.
  124. Sets the weight (or boldness) of the font.
  125. Sets the title of the legend group.
  126. 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. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.
  127. Sets the width (in px or fraction) of the legend for this trace.
  128. Sets the color of the contour level. Has no effect if contours.coloring is set to lines.
  129. Sets the dash style of lines. Set to a dash type string (solid, dot, dash, longdash, dashdot, or longdashdot) or a dash length list in px (eg 5px,10px,2px,2px).
  130. Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.
  131. Sets the contour line width in (in px)
  132. Sets the aggregation data.
  133. Sets the source reference on Chart Studio Cloud for color.
  134. Sets the source reference on Chart Studio Cloud for meta.
  135. Sets the trace name. The trace name appears as the legend item and on hover.
  136. Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.
  137. Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.
  138. 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.
  139. Sets the opacity of the trace.
  140. Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.
  141. Determines whether or not an item corresponding to this trace is shown in the legend.
  142. Determines whether or not a colorbar is displayed for this trace.
  143. 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.
  144. The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.
  145. HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
  146. Sets the kind of decoration line(s) with text, such as an under, over or through as well as combinations e.g. under+over, etc.
  147. Sets the shape and color of the shadow behind text. auto places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
  148. Sets whether a font should be styled with a normal or italic face from its family.
  149. Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
  150. Sets the variant of the font.
  151. Sets the weight (or boldness) of the font.
  152. For this trace it only has an effect if coloring is set to heatmap. Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-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. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.
  153. Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
  154. 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).
  155. Sets the sample data to be binned on the x axis.
  156. 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.
  157. Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup
  158. Sets the calendar system to use with x date data.
  159. 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.46By default the values are formatted using xaxis.hoverformat.
  160. Sets the source reference on Chart Studio Cloud for x.
  161. Sets the sample data to be binned on the y axis.
  162. Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.
  163. Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup
  164. Sets the calendar system to use with y date data.
  165. 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.46By default the values are formatted using yaxis.hoverformat.
  166. Sets the source reference on Chart Studio Cloud for y.
  167. Sets the aggregation data.
  168. Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.
  169. 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.By default the values are formatted using generic number format.
  170. Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.
  171. Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.
  172. Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.
  173. Sets the source reference on Chart Studio Cloud for z.