Box
Overview
The box
trace type is used to display data as a box plot, which shows the distribution of data based on their quartiles, medians, and potential outliers. It's useful for statistical visualizations, as it highlights data spread and central tendency while accounting for variability.
You can control various aspects of the plot, such as the orientation, box and whisker styles, marker symbols, and points display. Additionally, you can show or hide outliers and configure hover labels for enhanced interaction.
Common Uses
- Distribution Analysis: Understanding the distribution of quest-related data.
- Outlier Detection: Identifying outliers in quest performance metrics.
- Comparative Analysis: Comparing the performance of knights on different quests.
Check out the Attributes for the full set of configuration options
Examples
Common Configurations
Here's a simple box
plot showing the distribution of sample data:
You can copy this code below to create this chart in your project:
models:
- name: sample-data
args:
- echo
- |
category,value
A,23
A,15
A,18
A,30
A,28
B,40
B,35
B,31
B,25
B,29
traces:
- name: Sample Box Plot
model: ref(sample-data)
props:
type: box
x: query(category)
y: query(value)
boxpoints: "all"
jitter: 1
pointpos: -1.1
charts:
- name: Sample Box Plot Chart
traces:
- ref(Sample Box Plot)
layout:
title:
text: Simple Box Plot<br><sub>Distribution of Values by Category</sub>
xaxis:
title:
text: "Category"
yaxis:
title:
text: "Value"
Here's a box
plot showing the distribution of rewards earned by knights across different quests:
You can copy this code below to create this chart in your project:
models:
- name: monty-python-quest-data-unique
args:
- curl
- "https://raw.githubusercontent.com/visivo-io/data/refs/heads/main/monty_python_quests.csv"
traces:
- name: Rewards Distribution by Quest
model: ref(monty-python-quest-data-unique)
cohort_on: "person"
props:
type: box
y: query(person)
x: query(reward_gbp)
boxpoints: "all"
jitter: 1
pointpos: -1.1
orientation: h
charts:
- name: Rewards Distribution Box Plot
traces:
- ref(Rewards Distribution by Quest)
layout:
title:
text: Horizontal Box Plot<br><sub>GBP Rewards Earned Across Quests</sub>
xaxis:
title:
text: "Reward (GBP)"
In this example, we show how to display a box plot for the number of proclamations mades:
Here's the code:
models:
- name: monty-python-quest-proclamations
args:
- curl
- "https://raw.githubusercontent.com/visivo-io/data/refs/heads/main/monty_python_quests.csv"
traces:
- name: Proclamations Box Plot
model: ref(monty-python-quest-proclamations)
cohort_on: "person"
props:
type: box
y: query(proclamations_made)
x: query(enemy_encountered)
charts:
- name: Proclamations Box Plot with Outliers
traces:
- ref(Proclamations Box Plot)
layout:
title:
text: Cohorted Box Plot<br><sub>Proclamations Made Across Quests by Enemy</sub>
xaxis:
title:
text: "Enemy"
boxmode: group
yaxis:
title:
text: "Proclamations Made"
Attributes
These attributes apply to traces where trace.props.type
is set to box
. You would configure these attributes on the trace with the trace.props
object.
alignmentgroup: 'string' #(1)!
boxmean: 'enumerated , one of ( true | "sd" | false )' #(2)!
boxpoints: 'enumerated , one of ( "all" | "outliers" | "suspectedoutliers" | false
)' #(3)!
customdata: 'data array' #(4)!
dx: 'number' #(5)!
dy: 'number' #(6)!
fillcolor: 'color' #(7)!
hoverinfo: 'flaglist string. any combination of "x", "y", "z", "text", "name" joined
with a "+" or "all" or "none" or "skip".' #(8)!
hoverlabel:
align: 'enumerated or array of enumerateds , one of ( "left" | "right" | "auto"
)' #(9)!
bgcolor: 'color or array of colors' #(10)!
bordercolor: 'color or array of colors' #(11)!
font:
color: color or array of colors
family: 'string or array of strings' #(12)!
size: number or array of numbers greater than or equal to 1
namelength: 'integer or array of integers greater than or equal to -1' #(13)!
hoveron: 'flaglist string. any combination of "boxes", "points" joined with a "+"
' #(14)!
hovertemplate: 'string or array of strings' #(15)!
hovertext: 'string or array of strings' #(16)!
ids: 'data array' #(17)!
jitter: 'number between or equal to 0 and 1' #(18)!
legendgroup: 'string' #(19)!
legendgrouptitle:
font:
color: color
family: 'string' #(20)!
size: number greater than or equal to 1
text: 'string' #(21)!
legendrank: 'number' #(22)!
legendwidth: 'number greater than or equal to 0' #(23)!
line:
color: 'color' #(24)!
width: 'number greater than or equal to 0' #(25)!
lowerfence: 'data array' #(26)!
marker:
angle: 'angle' #(27)!
color: 'color' #(28)!
line:
color: 'color' #(29)!
outliercolor: 'color' #(30)!
outlierwidth: 'number greater than or equal to 0' #(31)!
width: 'number greater than or equal to 0' #(32)!
opacity: 'number between or equal to 0 and 1' #(33)!
outliercolor: 'color' #(34)!
size: 'number greater than or equal to 0' #(35)!
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" )' #(36)!
mean: 'data array' #(37)!
median: 'data array' #(38)!
meta: 'number or categorical coordinate string' #(39)!
notched: 'boolean' #(40)!
notchspan: 'data array' #(41)!
notchwidth: 'number between or equal to 0 and 0.5' #(42)!
offsetgroup: 'string' #(43)!
opacity: 'number between or equal to 0 and 1' #(44)!
orientation: 'enumerated , one of ( "v" | "h" )' #(45)!
pointpos: 'number between or equal to -2 and 2' #(46)!
q1: 'data array' #(47)!
q3: 'data array' #(48)!
quartilemethod: 'enumerated , one of ( "linear" | "exclusive" | "inclusive" )' #(49)!
sd: 'data array' #(50)!
selected:
marker:
color: 'color' #(51)!
opacity: 'number between or equal to 0 and 1' #(52)!
size: 'number greater than or equal to 0' #(53)!
selectedpoints: 'number or categorical coordinate string' #(54)!
showlegend: 'boolean' #(55)!
text: 'string or array of strings' #(56)!
type: box
uirevision: 'number or categorical coordinate string' #(57)!
unselected:
marker:
color: 'color' #(58)!
opacity: 'number between or equal to 0 and 1' #(59)!
size: 'number greater than or equal to 0' #(60)!
upperfence: 'data array' #(61)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(62)!
whiskerwidth: 'number between or equal to 0 and 1' #(63)!
width: 'number greater than or equal to 0' #(64)!
x: 'data array' #(66)!
x0: 'number or categorical coordinate string' #(65)!
xaxis: 'subplotid' #(67)!
xcalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
| "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
| "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(68)!
xhoverformat: 'string' #(69)!
xperiod: 'number or categorical coordinate string' #(71)!
xperiod0: 'number or categorical coordinate string' #(70)!
xperiodalignment: 'enumerated , one of ( "start" | "middle" | "end" )' #(72)!
y: 'data array' #(74)!
y0: 'number or categorical coordinate string' #(73)!
yaxis: 'subplotid' #(75)!
ycalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
| "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
| "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(76)!
yhoverformat: 'string' #(77)!
yperiod: 'number or categorical coordinate string' #(79)!
yperiod0: 'number or categorical coordinate string' #(78)!
yperiodalignment: 'enumerated , one of ( "start" | "middle" | "end" )' #(80)!
- 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.
- If "true", the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn. Defaults to "true" when
mean
is set. Defaults to "sd" whensd
is set Otherwise defaults to "false". - 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 box(es) are shown with no sample points Defaults to "suspectedoutliers" whenmarker.outliercolor
ormarker.line.outliercolor
is set. Defaults to "all" under the q1/median/q3 signature. Otherwise defaults to "outliers". - 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
- Sets the x coordinate step for multi-box traces set using q1/median/q3.
- Sets the y coordinate step for multi-box traces set using q1/median/q3.
- Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
- Determines which trace information appear on hover. If
none
orskip
are set, no information is displayed upon hovering. But, ifnone
is set, click and hover events are still fired. - 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
- Sets the background color of the hover labels for this trace
- Sets the border color of the hover labels for this trace.
- 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".
- 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. - Do the hover effects highlight individual boxes or sample points or both?
- 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 inhovertemplate
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 arearrayOk: 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>
. - Same as
text
. - 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.
- 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 box(es).
- Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
- 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".
- Sets the title of the legend group.
- 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. - Sets the width (in px or fraction) of the legend for this trace.
- Sets the color of line bounding the box(es).
- Sets the width (in px) of line bounding the box(es).
- Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If
lowerfence
is not provided but a sample (iny
orx
) is set, we compute the lower as the last sample point below 1.5 times the IQR. - Sets the marker angle in respect to
angleref
. - 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
andmarker.cmax
if set. - 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
andmarker.line.cmax
if set. - Sets the border line color of the outlier sample points. Defaults to marker.color
- Sets the border line width (in px) of the outlier sample points.
- Sets the width (in px) of the lines bounding the marker points.
- Sets the marker opacity.
- Sets the color of the outlier sample points.
- Sets the marker size (in px).
- 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.
- Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If
mean
is not provided but a sample (iny
orx
) is set, we compute the mean for each box using the sample values. - Sets the median values. There should be as many items as the number of boxes desired.
- Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace
name
, graph, axis and colorbartitle.text
, annotationtext
rangeselector
,updatemenues
andsliders
label
text all supportmeta
. To access the tracemeta
values in an attribute in the same trace, simply use%{meta[i]}
wherei
is the index or key of themeta
item in question. To access tracemeta
in layout attributes, use%{data[n[.meta[i]}
wherei
is the index or key of themeta
andn
is the trace index. - Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 " IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to "false" unless
notchwidth
ornotchspan
is set. - Sets the notch span from the boxes'
median
values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. Ifnotchspan
is not provided but a sample (iny
orx
) is set, we compute it as 1.57 " IQR / sqrt(N), where N is the sample size. - Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).
- 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.
- Sets the opacity of the trace.
- Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
- Sets the position of the sample points in relation to the box(es). If "0", the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
- Sets the Quartile 1 values. There should be as many items as the number of boxes desired.
- Sets the Quartile 3 values. There should be as many items as the number of boxes desired.
- 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.
- Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If
sd
is not provided but a sample (iny
orx
) is set, we compute the standard deviation for each box using the sample values. - Sets the marker color of selected points.
- Sets the marker opacity of selected points.
- Sets the marker size of selected points.
- 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 theselected
andunselected
styles have no effect. - Determines whether or not an item corresponding to this trace is shown in the legend.
- 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. - Controls persistence of some user-driven changes to the trace:
constraintrange
inparcoords
traces, as well as someeditable: true
modifications such asname
andcolorbar.title
. Defaults tolayout.uirevision
. Note that other user-driven trace attribute changes are controlled bylayout
attributes:trace.visible
is controlled bylayout.legend.uirevision
,selectedpoints
is controlled bylayout.selectionrevision
, andcolorbar.(x|y)
(accessible withconfig: {editable: true}
) is controlled bylayout.editrevision
. Trace changes are tracked byuid
, which only falls back on trace index if nouid
is provided. So if your app can add/remove traces before the end of thedata
array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace auid
that stays with it as it moves. - Sets the marker color of unselected points, applied only when a selection exists.
- Sets the marker opacity of unselected points, applied only when a selection exists.
- Sets the marker size of unselected points, applied only when a selection exists.
- Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If
upperfence
is not provided but a sample (iny
orx
) is set, we compute the lower as the last sample point above 1.5 times the IQR. - 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).
- Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
- Sets the width of the box in data coordinate If "0" (default value) the width is automatically selected based on the positions of other box traces in the same subplot.
- 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.
- Sets the x sample data or coordinates. See overview for more info.
- 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 tolayout.xaxis2
, and so on. - Sets the calendar system to use with
x
date data. - 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 usingxaxis.hoverformat
. - Only relevant when the axis
type
is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. Whenx0period
is round number of weeks, thex0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. - Only relevant when the axis
type
is "date". Sets the period positioning in milliseconds or "M" on the x axis. Special values in the form of "M " could be used to declare the number of months. In this case n
must be a positive integer. - Only relevant when the axis
type
is "date". Sets the alignment of data points on the x axis. - 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.
- Sets the y sample data or coordinates. See overview for more info.
- 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 tolayout.yaxis2
, and so on. - Sets the calendar system to use with
y
date data. - 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 usingyaxis.hoverformat
. - Only relevant when the axis
type
is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. Wheny0period
is round number of weeks, they0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01. - Only relevant when the axis
type
is "date". Sets the period positioning in milliseconds or "M" on the y axis. Special values in the form of "M " could be used to declare the number of months. In this case n
must be a positive integer. - Only relevant when the axis
type
is "date". Sets the alignment of data points on the y axis.