Box
Each box spans from quartile 1 (Q1) to quartile 3 (Q3).
The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow
outward from the boxes’ edges, by default they span +/- 1.5 times the interquartile range (IQR:
Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and
suspected outliers points can be optionally added to the box plot. The values and positions
corresponding to each boxes can be input using two signatures. The first signature expects users
to supply the sample values in the y
data array for vertical boxes (x
for horizontal boxes).
By supplying an x
(y
) array, one box per distinct x
(y
) value is drawn If no x
(y
)
{array} is provided, a single box is drawn. In this case, the box is positioned with the trace
name
or with x0
(y0
) if provided. The second signature expects users to supply the boxes
corresponding Q1, median and Q3 statistics in the q1
, median
and q3
data arrays
respectively. Other box features relying on statistics namely lowerfence
, upperfence
,
notchspan
can be set directly by the users. To have plotly compute them or to show sample
points besides the boxes, users can set the y
data array for vertical boxes (x
for
horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in
the traces and the inner length corresponding the sample size.
-
Corresponding Plotly trace type.
Declaration
Swift
public let type: String
-
Switch indicating whether the trace supports animation of its data.
Declaration
Swift
public static var animatable: Bool { get }
-
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).
Declaration
Swift
public var visible: Visible?
-
Determines whether or not an item corresponding to this trace is shown in the legend.
Declaration
Swift
public var showLegend: Bool?
-
Sets the legend group for this trace.
Traces part of the same legend group hide/show at the same time when toggling legend items.
Declaration
Swift
public var legendGroup: String?
-
Sets the opacity of the trace.
Declaration
Swift
public var opacity: Double?
-
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
Declaration
Swift
public var uid: String?
-
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.
Declaration
Swift
public var ids: [String]?
-
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
Declaration
Swift
public var customData: [String]?
-
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. -
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.Declaration
Swift
public var selectedPoints: Anything?
-
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.Declaration
Swift
public var hoverInfo: HoverInfo?
-
Undocumented
Declaration
Swift
public var hoverLabel: HoverLabel?
-
Undocumented
Declaration
Swift
public var stream: Stream?
-
Undocumented
Declaration
Swift
public var transforms: [Transform]
-
Controls persistence of some user-driven changes to the trace:
constraintrange
inparcoords
traces, as well as someeditable: true
modifications such asname
andcolorbar.title
.Defaults to
layout.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.Declaration
Swift
public var uiRevision: Anything?
-
Sets the y sample data or coordinates.
See overview for more info.
Declaration
Swift
public var y: YData?
-
Sets the x sample data or coordinates.
See overview for more info.
Declaration
Swift
public var x: XData?
-
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.
Declaration
Swift
public var x0: Anything?
-
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.
Declaration
Swift
public var y0: Anything?
-
Sets the x coordinate step for multi-box traces set using q1/median/q3.
Declaration
Swift
public var dx: Double?
-
Sets the y coordinate step for multi-box traces set using q1/median/q3.
Declaration
Swift
public var dy: Double?
-
Only relevant when the axis
type
is date.Sets the base for period positioning in milliseconds or date string on the x0 axis. When
x0period
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.Declaration
Swift
public var xPeriod0: Anything?
-
Only relevant when the axis
type
is date.Sets the base for period positioning in milliseconds or date string on the y0 axis. When
y0period
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.Declaration
Swift
public var yPeriod0: Anything?
-
Only relevant when the axis
type
is date.Sets the alignment of data points on the x axis.
Declaration
Swift
public var xPeriodAlignment: XPeriodAlignment?
-
Only relevant when the axis
type
is date.Sets the alignment of data points on the y axis.
Declaration
Swift
public var yPeriodAlignment: YPeriodAlignment?
-
Sets the Quartile 1 values.
There should be as many items as the number of boxes desired.
Declaration
Swift
public var q1: QData?
-
Sets the median values.
There should be as many items as the number of boxes desired.
Declaration
Swift
public var median: QData?
-
Sets the Quartile 3 values.
There should be as many items as the number of boxes desired.
Declaration
Swift
public var q3: QData?
-
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.Declaration
Swift
public var lowerFence: QData?
-
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.Declaration
Swift
public var upperFence: QData?
-
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.Declaration
Swift
public var notched: Bool?
-
Sets the width of the notches relative to the box’ width.
For example, with 0, the notches are as wide as the box(es).
Declaration
Swift
public var notchWidth: Double?
-
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. If
notchspan
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.Declaration
Swift
public var notchSpan: QData?
-
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.
See moreDeclaration
Swift
public enum BoxPoints : Encodable
-
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.
Declaration
Swift
public var boxPoints: BoxPoints?
-
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).
Declaration
Swift
public var jitter: Double?
-
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
Declaration
Swift
public var pointPosition: Double?
-
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
See moremean
is set. Defaults to sd whensd
is set Otherwise defaults to false.Declaration
Swift
public enum BoxMean : Encodable
-
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.Declaration
Swift
public var mean: QData?
-
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.Declaration
Swift
public var standardDeviation: QData?
-
Sets the orientation of the box(es).
If v (h), the distribution is visualized along the vertical (horizontal).
Declaration
Swift
public var orientation: Orientation?
-
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://www.amstat.org/publications/jse/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.
Declaration
Swift
public enum QuartileMethod : String, Encodable
-
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://www.amstat.org/publications/jse/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.
Declaration
Swift
public var quartileMethod: QuartileMethod?
-
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.
Declaration
Swift
public var width: Double?
-
Undocumented
See moreDeclaration
Swift
public struct SymbolicMarker : Encodable
-
Undocumented
Declaration
Swift
public var marker: SymbolicMarker?
-
Undocumented
Declaration
Swift
public var line: Line?
-
Sets the fill color.
Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
Declaration
Swift
public var fillColor: Color?
-
Sets the width of the whiskers relative to the box’ width.
For example, with 1, the whiskers are as wide as the box(es).
Declaration
Swift
public var whiskerWidth: Double?
-
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.
Declaration
Swift
public var offsetGroup: String?
-
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.
Declaration
Swift
public var alignmentGroup: String?
-
Undocumented
See moreDeclaration
Swift
public struct Selected : Encodable
-
Undocumented
Declaration
Swift
public var selected: Selected?
-
Undocumented
See moreDeclaration
Swift
public struct Unselected : Encodable
-
Undocumented
Declaration
Swift
public var unselected: Unselected?
-
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.Declaration
Swift
public var text: Data<String>?
-
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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#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>
.Declaration
Swift
public var hoverTemplate: Data<String>?
-
Do the hover effects highlight individual boxes or sample points or both?
See moreDeclaration
Swift
public struct HoverOn : OptionSet, Encodable
-
Do the hover effects highlight individual boxes or sample points or both?
Declaration
Swift
public var hoverOn: HoverOn?
-
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.Declaration
Swift
public var xAxis: XAxis
-
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.Declaration
Swift
public var yAxis: YAxis
-
init(name:
y: x: q1: median: q3: lowerFence: upperFence: notchSpan: mean: standardDeviation: marker: line: text: hoverText: ) Creates
Box
object from the most frequently used properties.Declaration
Swift
public init(name: String? = nil, y: YData? = nil, x: XData? = nil, q1: QData? = nil, median: QData? = nil, q3: QData? = nil, lowerFence: QData? = nil, upperFence: QData? = nil, notchSpan: QData? = nil, mean: QData? = nil, standardDeviation: QData? = nil, marker: SymbolicMarker? = nil, line: Line? = nil, text: Data<String>? = nil, hoverText: Data<String>? = nil)
Parameters
name
Sets the trace name.
y
Sets the y sample data or coordinates.
x
Sets the x sample data or coordinates.
q1
Sets the Quartile 1 values.
median
Sets the median values.
q3
Sets the Quartile 3 values.
lowerFence
Sets the lower fence values.
upperFence
Sets the upper fence values.
notchSpan
Sets the notch span from the boxes’
median
values.mean
Sets the mean values.
standardDeviation
Sets the standard deviation values.
marker
line
text
Sets the text elements associated with each sample value.
hoverText
Same as
text
. -
init(visible:
showLegend: legendGroup: opacity: name: uid: ids: customData: meta: selectedPoints: hoverInfo: hoverLabel: stream: transforms: uiRevision: y: x: x0: y0: dx: dy: xPeriod: yPeriod: xPeriod0: yPeriod0: xPeriodAlignment: yPeriodAlignment: q1: median: q3: lowerFence: upperFence: notched: notchWidth: notchSpan: boxPoints: jitter: pointPosition: boxMean: mean: standardDeviation: orientation: quartileMethod: width: marker: line: fillColor: whiskerWidth: offsetGroup: alignmentGroup: selected: unselected: text: hoverText: hoverTemplate: hoverOn: xCalendar: yCalendar: xAxis: yAxis: ) Creates
Box
object with specified properties.Declaration
Swift
public init(visible: Visible? = nil, showLegend: Bool? = nil, legendGroup: String? = nil, opacity: Double? = nil, name: String? = nil, uid: String? = nil, ids: [String]? = nil, customData: [String]? = nil, meta: Data<Anything>? = nil, selectedPoints: Anything? = nil, hoverInfo: HoverInfo? = nil, hoverLabel: HoverLabel? = nil, stream: Stream? = nil, transforms: [Transform] = [], uiRevision: Anything? = nil, y: YData? = nil, x: XData? = nil, x0: Anything? = nil, y0: Anything? = nil, dx: Double? = nil, dy: Double? = nil, xPeriod: Anything? = nil, yPeriod: Anything? = nil, xPeriod0: Anything? = nil, yPeriod0: Anything? = nil, xPeriodAlignment: XPeriodAlignment? = nil, yPeriodAlignment: YPeriodAlignment? = nil, q1: QData? = nil, median: QData? = nil, q3: QData? = nil, lowerFence: QData? = nil, upperFence: QData? = nil, notched: Bool? = nil, notchWidth: Double? = nil, notchSpan: QData? = nil, boxPoints: BoxPoints? = nil, jitter: Double? = nil, pointPosition: Double? = nil, boxMean: BoxMean? = nil, mean: QData? = nil, standardDeviation: QData? = nil, orientation: Orientation? = nil, quartileMethod: QuartileMethod? = nil, width: Double? = nil, marker: SymbolicMarker? = nil, line: Line? = nil, fillColor: Color? = nil, whiskerWidth: Double? = nil, offsetGroup: String? = nil, alignmentGroup: String? = nil, selected: Selected? = nil, unselected: Unselected? = nil, text: Data<String>? = nil, hoverText: Data<String>? = nil, hoverTemplate: Data<String>? = nil, hoverOn: HoverOn? = nil, xCalendar: Calendar? = nil, yCalendar: Calendar? = nil, xAxis: XAxis = .preset, yAxis: YAxis = .preset)
Parameters
visible
Determines whether or not this trace is visible.
showLegend
Determines whether or not an item corresponding to this trace is shown in the legend.
legendGroup
Sets the legend group for this trace.
opacity
Sets the opacity of the trace.
name
Sets the trace name.
uid
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
ids
Assigns id labels to each datum.
customData
Assigns extra data each datum.
meta
Assigns extra meta information associated with this trace that can be used in various text attributes.
selectedPoints
Array containing integer indices of selected points.
hoverInfo
Determines which trace information appear on hover.
hoverLabel
stream
transforms
uiRevision
Controls persistence of some user-driven changes to the trace:
constraintrange
inparcoords
traces, as well as someeditable: true
modifications such asname
andcolorbar.title
.y
Sets the y sample data or coordinates.
x
Sets the x sample data or coordinates.
x0
Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3.
y0
Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3.
dx
Sets the x coordinate step for multi-box traces set using q1/median/q3.
dy
Sets the y coordinate step for multi-box traces set using q1/median/q3.
xPeriod
Only relevant when the axis
type
is date.yPeriod
Only relevant when the axis
type
is date.xPeriod0
Only relevant when the axis
type
is date.yPeriod0
Only relevant when the axis
type
is date.xPeriodAlignment
Only relevant when the axis
type
is date.yPeriodAlignment
Only relevant when the axis
type
is date.q1
Sets the Quartile 1 values.
median
Sets the median values.
q3
Sets the Quartile 3 values.
lowerFence
Sets the lower fence values.
upperFence
Sets the upper fence values.
notched
Determines whether or not notches are drawn.
notchWidth
Sets the width of the notches relative to the box’ width.
notchSpan
Sets the notch span from the boxes’
median
values.boxPoints
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.jitter
Sets the amount of jitter in the sample points drawn.
pointPosition
Sets the position of the sample points in relation to the box(es).
boxMean
If true, the mean of the box(es)‘ underlying distribution is drawn as a dashed line inside the box(es).
mean
Sets the mean values.
standardDeviation
Sets the standard deviation values.
orientation
Sets the orientation of the box(es).
quartileMethod
Sets the method used to compute the sample’s Q1 and Q3 quartiles.
width
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.
marker
line
fillColor
Sets the fill color.
whiskerWidth
Sets the width of the whiskers relative to the box’ width.
offsetGroup
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.
alignmentGroup
Set several traces linked to the same position axis or matching axes to the same alignmentgroup.
selected
unselected
text
Sets the text elements associated with each sample value.
hoverText
Same as
text
.hoverTemplate
Template string used for rendering the information that appear on hover box.
hoverOn
Do the hover effects highlight individual boxes or sample points or both?
xCalendar
Sets the calendar system to use with
x
date data.yCalendar
Sets the calendar system to use with
y
date data.xAxis
Sets a reference between this trace’s x coordinates and a 2D cartesian x axis.
yAxis
Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.
-
Encodes the object in a format compatible with Plotly.
Declaration
Swift
public func encode(to encoder: Encoder) throws