Skip to content

Violin

alignmentgroup: 'string' #(1)!
bandwidth: 'number greater than or equal to 0' #(2)!
box:
  fillcolor: 'color' #(3)!
  line:
    color: 'color' #(4)!
    width: 'number greater than or equal to 0' #(5)!
  visible: 'boolean' #(6)!
  width: 'number between or equal to 0 and 1' #(7)!
customdata: 'data array' #(8)!
fillcolor: 'color' #(9)!
hoverinfo: 'flaglist string. any combination of "x", "y", "z", "text", "name" joined
  with a "+" or "all" or "none" or "skip".' #(10)!
hoverlabel:
  align: 'enumerated or array of enumerateds , one of ( "left" | "right" | "auto"
    )' #(11)!
  bgcolor: 'color or array of colors' #(12)!
  bordercolor: 'color or array of colors' #(13)!
  font:
    color: color or array of colors
    family: 'string or array of strings' #(14)!
    size: number or array of numbers greater than or equal to 1
  namelength: 'integer or array of integers greater than or equal to -1' #(15)!
hoveron: 'flaglist string. any combination of "violins", "points", "kde" joined with
  a "+" or "all".' #(16)!
hovertemplate: 'string or array of strings' #(17)!
hovertext: 'string or array of strings' #(18)!
ids: 'data array' #(19)!
jitter: 'number between or equal to 0 and 1' #(20)!
legendgroup: 'string' #(21)!
legendgrouptitle:
  font:
    color: color
    family: 'string' #(22)!
    size: number greater than or equal to 1
  text: 'string' #(23)!
legendrank: 'number' #(24)!
legendwidth: 'number greater than or equal to 0' #(25)!
line:
  color: 'color' #(26)!
  width: 'number greater than or equal to 0' #(27)!
marker:
  angle: 'angle' #(28)!
  color: 'color' #(29)!
  line:
    color: 'color' #(30)!
    outliercolor: 'color' #(31)!
    outlierwidth: 'number greater than or equal to 0' #(32)!
    width: 'number greater than or equal to 0' #(33)!
  opacity: 'number between or equal to 0 and 1' #(34)!
  outliercolor: 'color' #(35)!
  size: 'number greater than or equal to 0' #(36)!
  symbol: 'enumerated , one of ( "0" | "0" | "circle" | "100" | "100" | "circle-open"
    | "200" | "200" | "circle-dot" | "300" | "300" | "circle-open-dot" | "1" | "1"
    | "square" | "101" | "101" | "square-open" | "201" | "201" | "square-dot" | "301"
    | "301" | "square-open-dot" | "2" | "2" | "diamond" | "102" | "102" | "diamond-open"
    | "202" | "202" | "diamond-dot" | "302" | "302" | "diamond-open-dot" | "3" | "3"
    | "cross" | "103" | "103" | "cross-open" | "203" | "203" | "cross-dot" | "303"
    | "303" | "cross-open-dot" | "4" | "4" | "x" | "104" | "104" | "x-open" | "204"
    | "204" | "x-dot" | "304" | "304" | "x-open-dot" | "5" | "5" | "triangle-up" |
    "105" | "105" | "triangle-up-open" | "205" | "205" | "triangle-up-dot" | "305"
    | "305" | "triangle-up-open-dot" | "6" | "6" | "triangle-down" | "106" | "106"
    | "triangle-down-open" | "206" | "206" | "triangle-down-dot" | "306" | "306" |
    "triangle-down-open-dot" | "7" | "7" | "triangle-left" | "107" | "107" | "triangle-left-open"
    | "207" | "207" | "triangle-left-dot" | "307" | "307" | "triangle-left-open-dot"
    | "8" | "8" | "triangle-right" | "108" | "108" | "triangle-right-open" | "208"
    | "208" | "triangle-right-dot" | "308" | "308" | "triangle-right-open-dot" | "9"
    | "9" | "triangle-ne" | "109" | "109" | "triangle-ne-open" | "209" | "209" | "triangle-ne-dot"
    | "309" | "309" | "triangle-ne-open-dot" | "10" | "10" | "triangle-se" | "110"
    | "110" | "triangle-se-open" | "210" | "210" | "triangle-se-dot" | "310" | "310"
    | "triangle-se-open-dot" | "11" | "11" | "triangle-sw" | "111" | "111" | "triangle-sw-open"
    | "211" | "211" | "triangle-sw-dot" | "311" | "311" | "triangle-sw-open-dot" |
    "12" | "12" | "triangle-nw" | "112" | "112" | "triangle-nw-open" | "212" | "212"
    | "triangle-nw-dot" | "312" | "312" | "triangle-nw-open-dot" | "13" | "13" | "pentagon"
    | "113" | "113" | "pentagon-open" | "213" | "213" | "pentagon-dot" | "313" | "313"
    | "pentagon-open-dot" | "14" | "14" | "hexagon" | "114" | "114" | "hexagon-open"
    | "214" | "214" | "hexagon-dot" | "314" | "314" | "hexagon-open-dot" | "15" |
    "15" | "hexagon2" | "115" | "115" | "hexagon2-open" | "215" | "215" | "hexagon2-dot"
    | "315" | "315" | "hexagon2-open-dot" | "16" | "16" | "octagon" | "116" | "116"
    | "octagon-open" | "216" | "216" | "octagon-dot" | "316" | "316" | "octagon-open-dot"
    | "17" | "17" | "star" | "117" | "117" | "star-open" | "217" | "217" | "star-dot"
    | "317" | "317" | "star-open-dot" | "18" | "18" | "hexagram" | "118" | "118" |
    "hexagram-open" | "218" | "218" | "hexagram-dot" | "318" | "318" | "hexagram-open-dot"
    | "19" | "19" | "star-triangle-up" | "119" | "119" | "star-triangle-up-open" |
    "219" | "219" | "star-triangle-up-dot" | "319" | "319" | "star-triangle-up-open-dot"
    | "20" | "20" | "star-triangle-down" | "120" | "120" | "star-triangle-down-open"
    | "220" | "220" | "star-triangle-down-dot" | "320" | "320" | "star-triangle-down-open-dot"
    | "21" | "21" | "star-square" | "121" | "121" | "star-square-open" | "221" | "221"
    | "star-square-dot" | "321" | "321" | "star-square-open-dot" | "22" | "22" | "star-diamond"
    | "122" | "122" | "star-diamond-open" | "222" | "222" | "star-diamond-dot" | "322"
    | "322" | "star-diamond-open-dot" | "23" | "23" | "diamond-tall" | "123" | "123"
    | "diamond-tall-open" | "223" | "223" | "diamond-tall-dot" | "323" | "323" | "diamond-tall-open-dot"
    | "24" | "24" | "diamond-wide" | "124" | "124" | "diamond-wide-open" | "224" |
    "224" | "diamond-wide-dot" | "324" | "324" | "diamond-wide-open-dot" | "25" |
    "25" | "hourglass" | "125" | "125" | "hourglass-open" | "26" | "26" | "bowtie"
    | "126" | "126" | "bowtie-open" | "27" | "27" | "circle-cross" | "127" | "127"
    | "circle-cross-open" | "28" | "28" | "circle-x" | "128" | "128" | "circle-x-open"
    | "29" | "29" | "square-cross" | "129" | "129" | "square-cross-open" | "30" |
    "30" | "square-x" | "130" | "130" | "square-x-open" | "31" | "31" | "diamond-cross"
    | "131" | "131" | "diamond-cross-open" | "32" | "32" | "diamond-x" | "132" | "132"
    | "diamond-x-open" | "33" | "33" | "cross-thin" | "133" | "133" | "cross-thin-open"
    | "34" | "34" | "x-thin" | "134" | "134" | "x-thin-open" | "35" | "35" | "asterisk"
    | "135" | "135" | "asterisk-open" | "36" | "36" | "hash" | "136" | "136" | "hash-open"
    | "236" | "236" | "hash-dot" | "336" | "336" | "hash-open-dot" | "37" | "37" |
    "y-up" | "137" | "137" | "y-up-open" | "38" | "38" | "y-down" | "138" | "138"
    | "y-down-open" | "39" | "39" | "y-left" | "139" | "139" | "y-left-open" | "40"
    | "40" | "y-right" | "140" | "140" | "y-right-open" | "41" | "41" | "line-ew"
    | "141" | "141" | "line-ew-open" | "42" | "42" | "line-ns" | "142" | "142" | "line-ns-open"
    | "43" | "43" | "line-ne" | "143" | "143" | "line-ne-open" | "44" | "44" | "line-nw"
    | "144" | "144" | "line-nw-open" | "45" | "45" | "arrow-up" | "145" | "145" |
    "arrow-up-open" | "46" | "46" | "arrow-down" | "146" | "146" | "arrow-down-open"
    | "47" | "47" | "arrow-left" | "147" | "147" | "arrow-left-open" | "48" | "48"
    | "arrow-right" | "148" | "148" | "arrow-right-open" | "49" | "49" | "arrow-bar-up"
    | "149" | "149" | "arrow-bar-up-open" | "50" | "50" | "arrow-bar-down" | "150"
    | "150" | "arrow-bar-down-open" | "51" | "51" | "arrow-bar-left" | "151" | "151"
    | "arrow-bar-left-open" | "52" | "52" | "arrow-bar-right" | "152" | "152" | "arrow-bar-right-open"
    | "53" | "53" | "arrow" | "153" | "153" | "arrow-open" | "54" | "54" | "arrow-wide"
    | "154" | "154" | "arrow-wide-open" )' #(37)!
meanline:
  color: 'color' #(38)!
  visible: 'boolean' #(39)!
  width: 'number greater than or equal to 0' #(40)!
meta: 'number or categorical coordinate string' #(41)!
offsetgroup: 'string' #(42)!
opacity: 'number between or equal to 0 and 1' #(43)!
orientation: 'enumerated , one of ( "v" | "h" )' #(44)!
pointpos: 'number between or equal to -2 and 2' #(45)!
points: 'enumerated , one of ( "all" | "outliers" | "suspectedoutliers" | false )
 ' #(46)!
quartilemethod: 'enumerated , one of ( "linear" | "exclusive" | "inclusive" )' #(47)!
scalegroup: 'string' #(48)!
scalemode: 'enumerated , one of ( "width" | "count" )' #(49)!
selected:
  marker:
    color: 'color' #(50)!
    opacity: 'number between or equal to 0 and 1' #(51)!
    size: 'number greater than or equal to 0' #(52)!
selectedpoints: 'number or categorical coordinate string' #(53)!
showlegend: 'boolean' #(54)!
side: 'enumerated , one of ( "both" | "positive" | "negative" )' #(55)!
span: 'array' #(56)!
spanmode: 'enumerated , one of ( "soft" | "hard" | "manual" )' #(57)!
text: 'string or array of strings' #(58)!
type: violin
uirevision: 'number or categorical coordinate string' #(59)!
unselected:
  marker:
    color: 'color' #(60)!
    opacity: 'number between or equal to 0 and 1' #(61)!
    size: 'number greater than or equal to 0' #(62)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(63)!
width: 'number greater than or equal to 0' #(64)!
x: 'data array' #(66)!
x0: 'number or categorical coordinate string' #(65)!
xaxis: 'subplotid' #(67)!
xhoverformat: 'string' #(68)!
y: 'data array' #(70)!
y0: 'number or categorical coordinate string' #(69)!
yaxis: 'subplotid' #(71)!
yhoverformat: 'string' #(72)!
  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. Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.
  3. Sets the inner box plot fill color.
  4. Sets the inner box plot bounding line color.
  5. Sets the inner box plot bounding line width.
  6. Determines if an miniature box plot is drawn inside the violins.
  7. Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins.
  8. 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
  9. Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  10. 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.
  11. 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
  12. Sets the background color of the hover labels for this trace
  13. Sets the border color of the hover labels for this trace.
  14. 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".
  15. Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.
  16. Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?
  17. 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>.
  18. Same as text.
  19. 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.
  20. Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the violins.
  21. Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  22. 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".
  23. Sets the title of the legend group.
  24. 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.
  25. Sets the width (in px or fraction) of the legend for this trace.
  26. Sets the color of line bounding the violin(s).
  27. Sets the width (in px) of line bounding the violin(s).
  28. Sets the marker angle in respect to angleref.
  29. 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.
  30. 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.
  31. Sets the border line color of the outlier sample points. Defaults to marker.color
  32. Sets the border line width (in px) of the outlier sample points.
  33. Sets the width (in px) of the lines bounding the marker points.
  34. Sets the marker opacity.
  35. Sets the color of the outlier sample points.
  36. Sets the marker size (in px).
  37. Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
  38. Sets the mean line color.
  39. Determines if a line corresponding to the sample's mean is shown inside the violins. If box.visible is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.
  40. Sets the mean line width.
  41. 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.
  42. 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.
  43. Sets the opacity of the trace.
  44. Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
  45. Sets the position of the sample points in relation to the violins. If "0", the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.
  46. If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see outliercolor) If "all", all sample points are shown If "false", only the violins are shown with no sample points. Defaults to "suspectedoutliers" when marker.outliercolor or marker.line.outliercolor is set, otherwise defaults to "outliers".
  47. Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
  48. If there are multiple violins that should be sized according to to some metric (see scalemode), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's width is undefined, scalegroup will default to the trace's name. In this case, violins with the same names will be linked together
  49. Sets the metric by which the width of each violin is determined. "width" means each violin has the same (max) width "count" means the violins are scaled by the number of sample points making up each violin.
  50. Sets the marker color of selected points.
  51. Sets the marker opacity of selected points.
  52. Sets the marker size of selected points.
  53. 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.
  54. Determines whether or not an item corresponding to this trace is shown in the legend.
  55. Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under "overlay" mode, where one trace has side set to "positive" and the other to "negative".
  56. Sets the span in data space for which the density function will be computed. Has an effect only when spanmode is set to "manual".
  57. Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the span attribute.
  58. Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a "text" flag.
  59. 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.
  60. Sets the marker color of unselected points, applied only when a selection exists.
  61. Sets the marker opacity of unselected points, applied only when a selection exists.
  62. Sets the marker size of unselected points, applied only when a selection exists.
  63. 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).
  64. Sets the width of the violin in data coordinates. If "0" (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.
  65. Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
  66. Sets the x sample data or coordinates. See overview for more info.
  67. 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.
  68. 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.
  69. Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
  70. Sets the y sample data or coordinates. See overview for more info.
  71. 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.
  72. 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.