JavaScript Figure Reference: violin Traces
violin trace is an object with the key "type" equal to "violin" (i.e. {"type": "violin"}) and any of the keys listed below. In vertical (horizontal) violin plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one violin per distinct x (y) value is drawn If no `x` (`y`) array is provided, a single violin is drawn. That violin position is then positioned with `name` or with `x0` (`y0`) if provided.
- type
Parent:data[type=violin]
Type: "violin" - name
Parent:data[type=violin]
Type: stringSets the trace name. The trace name appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details).
- visible
Parent:data[type=violin]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=violin]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=violin]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=violin]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=violin]
Type: string
Default:""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.
- legendgrouptitle
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=violin].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=violin].legendgrouptitle.font
Type: color - family
Parent:data[type=violin].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=violin].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"none"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.
- shadow
Parent:data[type=violin].legendgrouptitle.font
Type: string
Default:"none"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.
- size
Parent:data[type=violin].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=violin].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=violin].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=violin].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=violin].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=violin].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=violin]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=violin]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=violin]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=violin]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=violin]
Type: data arraySets the x sample data or coordinates. See overview for more info.
- x0
Parent:data[type=violin]
Type: number or categorical coordinate stringSets 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.
- y
Parent:data[type=violin]
Type: data arraySets the y sample data or coordinates. See overview for more info.
- y0
Parent:data[type=violin]
Type: number or categorical coordinate stringSets 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.
- width
Parent:data[type=violin]
Type: number greater than or equal to 0
Default:0Sets 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.
- text
Parent:data[type=violin]
Type: string or array of strings
Default:""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.
- hovertext
Parent:data[type=violin]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=violin]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines what trace information appears 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.
- hovertemplate
Parent:data[type=violin]
Type: string or array of strings
Default:""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. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=violin]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=violin]
Type: string
Default:""Sets the hover text formatting rule for `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`.
- yhoverformat
Parent:data[type=violin]
Type: string
Default:""Sets the hover text formatting rule for `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`.
- meta
Parent:data[type=violin]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=violin]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=violin]
Type: subplotid
Default:xSets 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.
- yaxis
Parent:data[type=violin]
Type: subplotid
Default:ySets 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.
- orientation
Parent:data[type=violin]
Type: enumerated , one of ("v"|"h")Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
- alignmentgroup
Parent:data[type=violin]
Type: string
Default:""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.
- offsetgroup
Parent:data[type=violin]
Type: string
Default:""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.
- marker
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- angle
Parent:data[type=violin].marker
Type: angle
Default:0Sets the marker angle in respect to `angleref`.
- color
Parent:data[type=violin].marker
Type: colorSets 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.
- line
Parent:data[type=violin].marker
Type: object containing one or more of the keys listed below.- color
Parent:data[type=violin].marker.line
Type: color
Default:"#444"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.
- outliercolor
Parent:data[type=violin].marker.line
Type: colorSets the border line color of the outlier sample points. Defaults to marker.color
- outlierwidth
Parent:data[type=violin].marker.line
Type: number greater than or equal to 0
Default:1Sets the border line width (in px) of the outlier sample points.
- width
Parent:data[type=violin].marker.line
Type: number greater than or equal to 0
Default:0Sets the width (in px) of the lines bounding the marker points.
- color
- opacity
Parent:data[type=violin].marker
Type: number between or equal to 0 and 1
Default:1Sets the marker opacity.
- outliercolor
Parent:data[type=violin].marker
Type: color
Default:"rgba(0, 0, 0, 0)"Sets the color of the outlier sample points.
- size
Parent:data[type=violin].marker
Type: number greater than or equal to 0
Default:6Sets the marker size (in px).
- symbol
Parent:data[type=violin].marker
Type: 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")
Default:"circle"Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
- angle
- line
Parent:data[type=violin]
Type: object containing one or more of the keys listed below. - box
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.