Skip to content

Histogram

Overview

The histogram trace type is used to create histograms, which represent the distribution of numerical data by dividing the data into bins and counting the number of occurrences in each bin. Histograms are great for understanding data distribution, variability, and patterns.

You can customize bin size, orientation, and colors to fit your data. Histograms are especially useful in statistical analysis, data science, and exploratory data analysis.

Common Uses

  • Data Distribution: Visualizing how data points are distributed across different ranges.
  • Frequency Analysis: Showing the frequency of values within specific intervals.
  • Statistical Summaries: Understanding the spread, central tendency, and outliers in data.

Check out the Attributes for the full set of configuration options

Examples

Common Configurations

Here's a simple histogram plot showing the distribution of data across different bins:

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

models:
  - name: histogram-data
    args:
      - echo
      - |
        value
        10
        20
        15
        10
        5
        25
        30
        15
        20
        10
traces:
  - name: Simple Histogram Plot
    model: ref(histogram-data)
    props:
      type: histogram
      x: query(value)
      nbinsx: 5
      marker:
        color: "#17becf"
charts:
  - name: Simple Histogram Chart
    traces:
      - ref(Simple Histogram Plot)
    layout:
      title:
        text: Simple Histogram Plot<br><sub>Data Distribution Across Bins</sub>
      xaxis:
        title:
          text: "Value"
      yaxis:
        title:
          text: "Count"
      bargap: 0.05

This example shows a horizontal histogram plot, where the bins are displayed along the y-axis:

Here's the code:

models:
  - name: histogram-data-horizontal
    args:
      - echo
      - |
        value
        1
        3
        2
        5
        4
        3
        3
        3
        3
        4
        1
        3
        4
        3
        3
        4
        1
        2
        3
        5
        2
        3
        4
traces:
  - name: Horizontal Histogram Plot
    model: ref(histogram-data-horizontal)
    props:
      type: histogram
      y: query(value)
      nbinsy: 2
      marker:
        color: "#ff7f0e"
      orientation: h
charts:
  - name: Horizontal Histogram Chart
    traces:
      - ref(Horizontal Histogram Plot)
    layout:
      title:
        text: Horizontal Histogram Plot<br><sub>Data Distribution in a Horizontal Format</sub>
      yaxis:
        title:
          text: "Value"
      xaxis:
        title:
          text: "Count"
      bargap: 0.05

Here's a stacked histogram plot showing the distribution of two different datasets stacked on top of each other:

Here's the code:

models:
  - name: histogram-data-stacked
    args:
      - echo
      - |
        group,value
        A,1
        A,2
        A,2
        A,3
        B,3
        B,4
        B,5
        B,5
        B,6
traces:
  - name: Histogram Groups
    model: ref(histogram-data-stacked)
    cohort_on: '"group"'
    columns: 
      color: |
        case 
          when "group" = 'A' Then '#1f77b4' 
          when "group" = 'B' THEN '#ff7f0e' 
          else null 
        end 
    props:
      type: histogram
      x: query(value)
      marker:
        color: column(color) 
charts:
  - name: Stacked Histogram Chart
    traces:
      - ref(Histogram Groups)
    layout:
      title:
        text: Stacked Histogram Chart<br><sub>Data Distribution for Two Groups</sub>
      xaxis:
        title:
          text: "Value"
      yaxis:
        title:
          text: "Count"
      barmode: "stack"
      bargap: .05

Attributes

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

alignmentgroup: 'string' #(1)!
autobinx: 'boolean' #(2)!
autobiny: 'boolean' #(3)!
bingroup: 'string' #(4)!
cliponaxis: 'boolean' #(5)!
constraintext: 'enumerated , one of ( "inside" | "outside" | "both" | "none" )' #(6)!
cumulative:
  currentbin: 'enumerated , one of ( "include" | "exclude" | "half" )' #(7)!
  direction: 'enumerated , one of ( "increasing" | "decreasing" )' #(8)!
  enabled: 'boolean' #(9)!
customdata: 'data array' #(10)!
error_x:
  array: 'data array' #(11)!
  arrayminus: 'data array' #(12)!
  color: 'color' #(13)!
  copy_ystyle: boolean
  symmetric: 'boolean' #(14)!
  thickness: 'number greater than or equal to 0' #(15)!
  traceref: integer greater than or equal to 0
  tracerefminus: integer greater than or equal to 0
  type: 'enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )' #(16)!
  value: 'number greater than or equal to 0' #(17)!
  valueminus: 'number greater than or equal to 0' #(18)!
  visible: 'boolean' #(19)!
  width: 'number greater than or equal to 0' #(20)!
error_y:
  array: 'data array' #(21)!
  arrayminus: 'data array' #(22)!
  color: 'color' #(23)!
  symmetric: 'boolean' #(24)!
  thickness: 'number greater than or equal to 0' #(25)!
  traceref: integer greater than or equal to 0
  tracerefminus: integer greater than or equal to 0
  type: 'enumerated , one of ( "percent" | "constant" | "sqrt" | "data" )' #(26)!
  value: 'number greater than or equal to 0' #(27)!
  valueminus: 'number greater than or equal to 0' #(28)!
  visible: 'boolean' #(29)!
  width: 'number greater than or equal to 0' #(30)!
histfunc: 'enumerated , one of ( "count" | "sum" | "avg" | "min" | "max" )' #(31)!
histnorm: 'enumerated , one of ( "" | "percent" | "probability" | "density" | "probability
  density" )' #(32)!
hoverinfo: 'flaglist string. any combination of "x", "y", "z", "text", "name" joined
  with a "+" or "all" or "none" or "skip".' #(33)!
hoverlabel:
  align: 'enumerated or array of enumerateds , one of ( "left" | "right" | "auto"
    )' #(34)!
  bgcolor: 'color or array of colors' #(35)!
  bordercolor: 'color or array of colors' #(36)!
  font:
    color: color or array of colors
    family: 'string or array of strings' #(37)!
    size: number or array of numbers greater than or equal to 1
  namelength: 'integer or array of integers greater than or equal to -1' #(38)!
hovertemplate: 'string or array of strings' #(39)!
hovertext: 'string or array of strings' #(40)!
ids: 'data array' #(41)!
insidetextanchor: 'enumerated , one of ( "end" | "middle" | "start" )' #(42)!
insidetextfont:
  color: color
  family: 'string' #(43)!
  size: number greater than or equal to 1
legendgroup: 'string' #(44)!
legendgrouptitle:
  font:
    color: color
    family: 'string' #(45)!
    size: number greater than or equal to 1
  text: 'string' #(46)!
legendrank: 'number' #(47)!
legendwidth: 'number greater than or equal to 0' #(48)!
marker:
  autocolorscale: 'boolean' #(49)!
  cauto: 'boolean' #(50)!
  cmax: 'number' #(51)!
  cmid: 'number' #(52)!
  cmin: 'number' #(53)!
  color: 'color or array of colors' #(54)!
  coloraxis: 'subplotid' #(55)!
  colorbar:
    bgcolor: 'color' #(56)!
    bordercolor: 'color' #(57)!
    borderwidth: 'number greater than or equal to 0' #(58)!
    dtick: 'number or categorical coordinate string' #(59)!
    exponentformat: 'enumerated , one of ( "none" | "e" | "e" | "power" | "si" | "b"
      )' #(60)!
    len: 'number greater than or equal to 0' #(61)!
    lenmode: 'enumerated , one of ( "fraction" | "pixels" )' #(62)!
    minexponent: 'number greater than or equal to 0' #(63)!
    nticks: 'integer greater than or equal to 0' #(64)!
    orientation: 'enumerated , one of ( "h" | "v" )' #(65)!
    outlinecolor: 'color' #(66)!
    outlinewidth: 'number greater than or equal to 0' #(67)!
    separatethousands: 'boolean' #(68)!
    showexponent: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(69)!
    showticklabels: 'boolean' #(70)!
    showtickprefix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(71)!
    showticksuffix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(72)!
    thickness: 'number greater than or equal to 0' #(73)!
    thicknessmode: 'enumerated , one of ( "fraction" | "pixels" )' #(74)!
    tick0: 'number or categorical coordinate string' #(75)!
    tickangle: 'angle' #(76)!
    tickcolor: 'color' #(77)!
    tickfont:
      color: color
      family: 'string' #(78)!
      size: number greater than or equal to 1
    tickformat: 'string' #(79)!
    tickformatstops:
      dtickrange: 'array' #(80)!
      enabled: 'boolean' #(81)!
      name: 'string' #(82)!
      templateitemname: 'string' #(83)!
      value: 'string' #(84)!
    ticklabeloverflow: 'enumerated , one of ( "allow" | "hide past div" | "hide past
      domain" )' #(85)!
    ticklabelposition: 'enumerated , one of ( "outside" | "inside" | "outside top"
      | "inside top" | "outside left" | "inside left" | "outside right" | "inside
      right" | "outside bottom" | "inside bottom" )' #(86)!
    ticklabelstep: 'integer greater than or equal to 1' #(87)!
    ticklen: 'number greater than or equal to 0' #(88)!
    tickmode: 'enumerated , one of ( "auto" | "linear" | "array" )' #(89)!
    tickprefix: 'string' #(90)!
    ticks: 'enumerated , one of ( "outside" | "inside" | "" )' #(91)!
    ticksuffix: 'string' #(92)!
    ticktext: 'data array' #(93)!
    tickvals: 'data array' #(94)!
    tickwidth: 'number greater than or equal to 0' #(95)!
    title:
      font:
        color: color
        family: 'string' #(96)!
        size: number greater than or equal to 1
      side: 'enumerated , one of ( "right" | "top" | "bottom" )' #(97)!
      text: 'string' #(98)!
    x: 'number between or equal to -2 and 3' #(99)!
    xanchor: 'enumerated , one of ( "left" | "center" | "right" )' #(100)!
    xpad: 'number greater than or equal to 0' #(101)!
    y: 'number between or equal to -2 and 3' #(102)!
    yanchor: 'enumerated , one of ( "top" | "middle" | "bottom" )' #(103)!
    ypad: 'number greater than or equal to 0' #(104)!
  colorscale: 'colorscale' #(105)!
  cornerradius: 'number or categorical coordinate string' #(106)!
  line:
    autocolorscale: 'boolean' #(107)!
    cauto: 'boolean' #(108)!
    cmax: 'number' #(109)!
    cmid: 'number' #(110)!
    cmin: 'number' #(111)!
    color: 'color or array of colors' #(112)!
    coloraxis: 'subplotid' #(113)!
    colorscale: 'colorscale' #(114)!
    reversescale: 'boolean' #(115)!
    width: 'number or array of numbers greater than or equal to 0' #(116)!
  opacity: 'number or array of numbers between or equal to 0 and 1' #(117)!
  pattern:
    bgcolor: 'color or array of colors' #(118)!
    fgcolor: 'color or array of colors' #(119)!
    fgopacity: 'number between or equal to 0 and 1' #(120)!
    fillmode: 'enumerated , one of ( "replace" | "overlay" )' #(121)!
    shape: 'enumerated or array of enumerateds , one of ( "" | "/" | "" | "x" | "-"
      | "|" | "+" | "." )' #(122)!
    size: 'number or array of numbers greater than or equal to 0' #(123)!
    solidity: 'number or array of numbers between or equal to 0 and 1' #(124)!
  reversescale: 'boolean' #(125)!
  showscale: 'boolean' #(126)!
meta: 'number or categorical coordinate string' #(127)!
nbinsx: 'integer greater than or equal to 0' #(128)!
nbinsy: 'integer greater than or equal to 0' #(129)!
offsetgroup: 'string' #(130)!
opacity: 'number between or equal to 0 and 1' #(131)!
orientation: 'enumerated , one of ( "v" | "h" )' #(132)!
outsidetextfont:
  color: color
  family: 'string' #(133)!
  size: number greater than or equal to 1
selected:
  marker:
    color: 'color' #(134)!
    opacity: 'number between or equal to 0 and 1' #(135)!
  textfont:
    color: 'color' #(136)!
selectedpoints: 'number or categorical coordinate string' #(137)!
showlegend: 'boolean' #(138)!
text: 'string or array of strings' #(139)!
textangle: 'angle' #(140)!
textfont:
  color: color
  family: 'string' #(141)!
  size: number greater than or equal to 1
textposition: 'enumerated , one of ( "inside" | "outside" | "auto" | "none" )' #(142)!
texttemplate: 'string' #(143)!
type: histogram
uirevision: 'number or categorical coordinate string' #(144)!
unselected:
  marker:
    color: 'color' #(145)!
    opacity: 'number between or equal to 0 and 1' #(146)!
  textfont:
    color: 'color' #(147)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(148)!
x: 'data array' #(149)!
xaxis: 'subplotid' #(150)!
xbins:
  end: 'number or categorical coordinate string' #(151)!
  size: 'number or categorical coordinate string' #(152)!
  start: 'number or categorical coordinate string' #(153)!
xcalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
  | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
  | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(154)!
xhoverformat: 'string' #(155)!
y: 'data array' #(156)!
yaxis: 'subplotid' #(157)!
ybins:
  end: 'number or categorical coordinate string' #(158)!
  size: 'number or categorical coordinate string' #(159)!
  start: 'number or categorical coordinate string' #(160)!
ycalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
  | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
  | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(161)!
yhoverformat: 'string' #(162)!
  1. Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
  2. 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.
  3. 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.
  4. Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same "orientation" under barmode "stack", "relative" and "group" are forced into the same bingroup, Using bingroup, traces under barmode "overlay" and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d" trace can share the same bingroup
  5. Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to "below traces".
  6. Constrain the size of text inside or outside a bar to be no larger than the bar itself.
  7. Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. "include" is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. "exclude" makes the opposite half-bin bias, and "half" removes it.
  8. Only applies if cumulative is enabled. If "increasing" (default) we sum all prior bins, so the result increases from left to right. If "decreasing" we sum later bins so the result decreases from left to right.
  9. If true, display the cumulative distribution by summing the binned values. Use the direction and centralbin attributes to tune the accumulation method. Note: in this mode, the "density" histnorm settings behave the same as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and "probability density" both rise to the number of sample points.
  10. 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
  11. Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
  12. 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.
  13. Sets the stoke color of the error bars.
  14. Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
  15. Sets the thickness (in px) of the error bars.
  16. Determines the rule used to generate the error bars. If "constant, the bar lengths are of a constant value. Set this constant invalue. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data setarray`.
  17. 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.
  18. 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
  19. Determines whether or not this set of error bars is visible.
  20. Sets the width (in px) of the cross-bar at both ends of the error bars.
  21. Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
  22. 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.
  23. Sets the stoke color of the error bars.
  24. Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
  25. Sets the thickness (in px) of the error bars.
  26. Determines the rule used to generate the error bars. If "constant, the bar lengths are of a constant value. Set this constant invalue. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data setarray`.
  27. 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.
  28. 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
  29. Determines whether or not this set of error bars is visible.
  30. Sets the width (in px) of the cross-bar at both ends of the error bars.
  31. 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.
  32. 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).
  33. 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.
  34. 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
  35. Sets the background color of the hover labels for this trace
  36. Sets the border color of the hover labels for this trace.
  37. 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".
  38. 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.
  39. 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. variable binNumber 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>.
  40. Same as text.
  41. 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.
  42. Determines if texts are kept at center or start/end points in textposition "inside" mode.
  43. 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".
  44. Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  45. 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".
  46. Sets the title of the legend group.
  47. 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.
  48. Sets the width (in px or fraction) of the legend for this trace.
  49. Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.
  50. Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.
  51. Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.
  52. Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.
  53. Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.
  54. 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 marker.cmin and marker.cmax if set.
  55. 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.
  56. Sets the color of padded area.
  57. Sets the axis line color.
  58. Sets the width (in px) or the border enclosing this color bar.
  59. 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"
  60. 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.
  61. 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.
  62. 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.
  63. Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is "SI" or "B".
  64. 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".
  65. Sets the orientation of the colorbar.
  66. Sets the axis line color.
  67. Sets the width (in px) of the axis line.
  68. If "true", even 4-digit integers are separated
  69. 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.
  70. Determines whether or not the tick labels are drawn.
  71. 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.
  72. Same as showtickprefix but for tick suffixes.
  73. Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
  74. 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.
  75. 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.
  76. Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.
  77. Sets the tick color.
  78. 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".
  79. 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"
  80. 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"
  81. Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.
  82. 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.
  83. 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.
  84. string - dtickformat for described zoom level, the same as "tickformat"
  85. 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".
  86. 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".
  87. 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".
  88. Sets the tick length (in px).
  89. 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).
  90. Sets a tick label prefix.
  91. 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.
  92. Sets a tick label suffix.
  93. Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to "array". Used with tickvals.
  94. Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to "array". Used with ticktext.
  95. Sets the tick width (in px).
  96. 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".
  97. 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.
  98. 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.
  99. 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".
  100. 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".
  101. Sets the amount of padding (in px) along the x direction.
  102. 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".
  103. 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".
  104. Sets the amount of padding (in px) along the y direction.
  105. Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
  106. Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %)
  107. Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.
  108. Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.
  109. Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.
  110. Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.
  111. Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.
  112. 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 marker.line.cmin and marker.line.cmax if set.
  113. 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.
  114. Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
  115. Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.
  116. Sets the width (in px) of the lines bounding the marker points.
  117. Sets the opacity of the bars.
  118. When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is "overlay". Otherwise, defaults to a transparent background.
  119. When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is "replace". Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.
  120. Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is "overlay". Otherwise, defaults to 1.
  121. Determines whether marker.color should be used as a default to bgcolor or a fgcolor.
  122. Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
  123. Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
  124. Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
  125. Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.
  126. Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.
  127. 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.
  128. 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.
  129. 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.
  130. Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
  131. Sets the opacity of the trace.
  132. Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
  133. 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".
  134. Sets the marker color of selected points.
  135. Sets the marker opacity of selected points.
  136. Sets the text font color of selected points.
  137. Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.
  138. Determines whether or not an item corresponding to this trace is shown in the legend.
  139. Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.
  140. Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
  141. 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".
  142. Specifies the location of the text. "inside" positions text inside, next to the bar end (rotated and scaled if needed). "outside" positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If "none", no text appears.
  143. 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. variables label and value.
  144. 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.
  145. Sets the marker color of unselected points, applied only when a selection exists.
  146. Sets the marker opacity of unselected points, applied only when a selection exists.
  147. Sets the text font color of unselected points, applied only when a selection exists.
  148. 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).
  149. Sets the sample data to be binned on the x axis.
  150. 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.
  151. Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.
  152. Sets the size of each x axis bin. Default behavior: If nbinsx is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsx is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit size is used and all others discarded. If no size is provided,the sample data from all traces is combined to determine size as described above.
  153. Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit start is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
  154. Sets the calendar system to use with x date data.
  155. 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.
  156. Sets the sample data to be binned on the y axis.
  157. 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.
  158. Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.
  159. Sets the size of each y axis bin. Default behavior: If nbinsy is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsy is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit size is used and all others discarded. If no size is provided,the sample data from all traces is combined to determine size as described above.
  160. Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit start is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
  161. Sets the calendar system to use with y date data.
  162. 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.