Box

Constructors

Constructor	Description
`new()` Signature: unit -> Box

Instance members

Instance member	Description
`boxmean()` Signature: unit -> string	Choose between add-on features for this box trace. If TRUE then the mean of the data linked to 'y' is shown as a dashed line in the box. If 'sd', then the standard deviation is also shown. If FALSE (the default), then no line are shown.
`boxmean()` Signature: unit -> unit	Choose between add-on features for this box trace. If TRUE then the mean of the data linked to 'y' is shown as a dashed line in the box. If 'sd', then the standard deviation is also shown. If FALSE (the default), then no line are shown.
`boxpoints()` Signature: unit -> string	Choose between boxpoints options for this box trace. If 'outliers' (the default), then only the points lying outside the box' whiskers (more info in 'y') are shown. If 'all', then all data points linked 'y' are shown. If 'suspectedoutliers', then outliers points are shown and points either less than 4Q1-3Q3 or greater than 4Q3-3Q1 are highlighted (with 'outliercolor' in Marker). If FALSE, then only the boxes are shown and the whiskers correspond to the minimum and maximum value linked to 'y'.
`boxpoints()` Signature: unit -> unit	Choose between boxpoints options for this box trace. If 'outliers' (the default), then only the points lying outside the box' whiskers (more info in 'y') are shown. If 'all', then all data points linked 'y' are shown. If 'suspectedoutliers', then outliers points are shown and points either less than 4Q1-3Q3 or greater than 4Q3-3Q1 are highlighted (with 'outliercolor' in Marker). If FALSE, then only the boxes are shown and the whiskers correspond to the minimum and maximum value linked to 'y'.
`fillcolor()` Signature: unit -> string	Sets the color of the box interior.
`fillcolor()` Signature: unit -> unit	Sets the color of the box interior.
`jitter()` Signature: unit -> float	Sets the width of the jitter in the boxpoints scatter in this trace. Has an no effect if 'boxpoints' is set to FALSE. If 0, then the boxpoints are aligned vertically. If 1 then the boxpoints are placed in a random horizontal jitter of width equal to the width of the boxes.
`jitter()` Signature: unit -> unit	Sets the width of the jitter in the boxpoints scatter in this trace. Has an no effect if 'boxpoints' is set to FALSE. If 0, then the boxpoints are aligned vertically. If 1 then the boxpoints are placed in a random horizontal jitter of width equal to the width of the boxes.
`line()` Signature: unit -> Line	Links a dictionary containing line parameters for the border of this box trace (including the whiskers).
`line()` Signature: unit -> unit	Links a dictionary containing line parameters for the border of this box trace (including the whiskers).
`marker()` Signature: unit -> Marker	Links a dictionary containing marker style parameters for this the boxpoints of box trace. Has an effect only 'boxpoints' is set to 'outliers', 'suspectedoutliers' or 'all'.
`marker()` Signature: unit -> unit	Links a dictionary containing marker style parameters for this the boxpoints of box trace. Has an effect only 'boxpoints' is set to 'outliers', 'suspectedoutliers' or 'all'.
`name()` Signature: unit -> string	The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet.
`name()` Signature: unit -> unit	The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet.
`opacity()` Signature: unit -> float	Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant.
`opacity()` Signature: unit -> unit	Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant.
`pointpos()` Signature: unit -> float	Sets the horizontal position of the boxpoints in relation to the boxes in this trace. Has an no effect if 'boxpoints' is set to FALSE. If 0, then the boxpoints are placed over the center of each box. If 1 (-1), then the boxpoints are placed on the right (left) each box border. If 2 (-2), then the boxpoints are placed 1 one box width to right (left) of each box.
`pointpos()` Signature: unit -> unit	Sets the horizontal position of the boxpoints in relation to the boxes in this trace. Has an no effect if 'boxpoints' is set to FALSE. If 0, then the boxpoints are placed over the center of each box. If 1 (-1), then the boxpoints are placed on the right (left) each box border. If 2 (-2), then the boxpoints are placed 1 one box width to right (left) of each box.
`ShouldSerializeboxmean()` Signature: unit -> bool
`ShouldSerializeboxpoints()` Signature: unit -> bool
`ShouldSerializefillcolor()` Signature: unit -> bool
`ShouldSerializejitter()` Signature: unit -> bool
`ShouldSerializeline()` Signature: unit -> bool
`ShouldSerializemarker()` Signature: unit -> bool
`ShouldSerializename()` Signature: unit -> bool
`ShouldSerializeopacity()` Signature: unit -> bool
`ShouldSerializepointpos()` Signature: unit -> bool
`ShouldSerializeshowlegend()` Signature: unit -> bool
`ShouldSerializestream()` Signature: unit -> bool
`ShouldSerializetype()` Signature: unit -> bool
`ShouldSerializevisible()` Signature: unit -> bool
`ShouldSerializewhiskerwidth()` Signature: unit -> bool
`ShouldSerializex()` Signature: unit -> bool
`ShouldSerializex0()` Signature: unit -> bool
`ShouldSerializexaxis()` Signature: unit -> bool
`ShouldSerializexsrc()` Signature: unit -> bool
`ShouldSerializey()` Signature: unit -> bool
`ShouldSerializeyaxis()` Signature: unit -> bool
`ShouldSerializeysrc()` Signature: unit -> bool
`showlegend()` Signature: unit -> string	Toggle whether or not this trace will be labeled in the legend.
`showlegend()` Signature: unit -> unit	Toggle whether or not this trace will be labeled in the legend.
`stream()` Signature: unit -> Stream	Links a dictionary that initializes this trace as a writable-stream, for use with the streaming API.
`stream()` Signature: unit -> unit	Links a dictionary that initializes this trace as a writable-stream, for use with the streaming API.
`type()` Signature: unit -> string	Plotly identifier for this data's trace type.
`type()` Signature: unit -> unit	Plotly identifier for this data's trace type.
`visible()` Signature: unit -> string	Toggles whether or not this object will be visible on the rendered figure.
`visible()` Signature: unit -> unit	Toggles whether or not this object will be visible on the rendered figure.
`whiskerwidth()` Signature: unit -> float	Sets the width of the whisker of the box relative to the box' width (in normalized coordinates, e.g. if 'whiskerwidth' set 1, then the whiskers are as wide as the box.
`whiskerwidth()` Signature: unit -> unit	Sets the width of the whisker of the box relative to the box' width (in normalized coordinates, e.g. if 'whiskerwidth' set 1, then the whiskers are as wide as the box.
`x()` Signature: unit -> obj	Usually, you do not need to set this value as plotly will handle box locations for you. However this allows you to have fine control over the location data for the box. Unlike making a bar, a box plot is made of many y values. Therefore, to give location data to the values you place in 'y', the length of 'x' must equal the length of 'y'. when making multiple box plots, you can concatenate the data sets for each box into a single 'y' array. then, the entries in 'x' define which box plot each entry in 'y' belongs to. When making a single box plot, you must set each entry in 'x' to the same value, see 'x0' for a more practical way to handle this case. If you don't include 'x', the box will simply be assigned a location.
`x()` Signature: unit -> unit	Usually, you do not need to set this value as plotly will handle box locations for you. However this allows you to have fine control over the location data for the box. Unlike making a bar, a box plot is made of many y values. Therefore, to give location data to the values you place in 'y', the length of 'x' must equal the length of 'y'. when making multiple box plots, you can concatenate the data sets for each box into a single 'y' array. then, the entries in 'x' define which box plot each entry in 'y' belongs to. When making a single box plot, you must set each entry in 'x' to the same value, see 'x0' for a more practical way to handle this case. If you don't include 'x', the box will simply be assigned a location.
`x0()` Signature: unit -> float	The location of this box. When 'y' defines a single box, 'x0' can be used to set where this box is centered on the x-axis. If many boxes are set to appear at the same 'x0' location, they will form a box group.
`x0()` Signature: unit -> unit	The location of this box. When 'y' defines a single box, 'x0' can be used to set where this box is centered on the x-axis. If many boxes are set to appear at the same 'x0' location, they will form a box group.
`xaxis()` Signature: unit -> string	This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to 'xaxis' in 'layout', 'x2' references to 'xaxis2' in 'layout', and so on. Note that 'x1' will always refer to 'xaxis' or 'xaxis1' in 'layout', they are the same.
`xaxis()` Signature: unit -> unit	This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to 'xaxis' in 'layout', 'x2' references to 'xaxis2' in 'layout', and so on. Note that 'x1' will always refer to 'xaxis' or 'xaxis1' in 'layout', they are the same.
`xsrc()` Signature: unit -> string	Usually, you do not need to set this value as plotly will handle box locations for you. However this allows you to have fine control over the location data for the box. Unlike making a bar, a box plot is made of many y values. Therefore, to give location data to the values you place in 'y', the length of 'x' must equal the length of 'y'. when making multiple box plots, you can concatenate the data sets for each box into a single 'y' array. then, the entries in 'x' define which box plot each entry in 'y' belongs to. When making a single box plot, you must set each entry in 'x' to the same value, see 'x0' for a more practical way to handle this case. If you don't include 'x', the box will simply be assigned a location.
`xsrc()` Signature: unit -> unit	Usually, you do not need to set this value as plotly will handle box locations for you. However this allows you to have fine control over the location data for the box. Unlike making a bar, a box plot is made of many y values. Therefore, to give location data to the values you place in 'y', the length of 'x' must equal the length of 'y'. when making multiple box plots, you can concatenate the data sets for each box into a single 'y' array. then, the entries in 'x' define which box plot each entry in 'y' belongs to. When making a single box plot, you must set each entry in 'x' to the same value, see 'x0' for a more practical way to handle this case. If you don't include 'x', the box will simply be assigned a location.
`y()` Signature: unit -> obj	This array is used to define an individual box plot, or, a concatenation of multiple box plots. Statistics from these numbers define the bounds of the box, the length of the whiskers, etc. For details on defining multiple boxes with locations see 'x'. Each box spans from the first quartile to the third. The second quartile is marked by a line inside the box. By default, the whiskers are correspond to box' edges +/- 1.5 times the interquartile range. See also 'boxpoints' for more info
`y()` Signature: unit -> unit	This array is used to define an individual box plot, or, a concatenation of multiple box plots. Statistics from these numbers define the bounds of the box, the length of the whiskers, etc. For details on defining multiple boxes with locations see 'x'. Each box spans from the first quartile to the third. The second quartile is marked by a line inside the box. By default, the whiskers are correspond to box' edges +/- 1.5 times the interquartile range. See also 'boxpoints' for more info
`yaxis()` Signature: unit -> string	This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to 'yaxis' in 'layout', 'y2' references to 'yaxis2' in 'layout', and so on. Note that 'y1' will always refer to 'yaxis' or 'yaxis1' in 'layout', they are the same.
`yaxis()` Signature: unit -> unit	This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to 'yaxis' in 'layout', 'y2' references to 'yaxis2' in 'layout', and so on. Note that 'y1' will always refer to 'yaxis' or 'yaxis1' in 'layout', they are the same.
`ysrc()` Signature: unit -> string	This array is used to define an individual box plot, or, a concatenation of multiple box plots. Statistics from these numbers define the bounds of the box, the length of the whiskers, etc. For details on defining multiple boxes with locations see 'x'. Each box spans from the first quartile to the third. The second quartile is marked by a line inside the box. By default, the whiskers are correspond to box' edges +/- 1.5 times the interquartile range. See also 'boxpoints' for more info
`ysrc()` Signature: unit -> unit	This array is used to define an individual box plot, or, a concatenation of multiple box plots. Statistics from these numbers define the bounds of the box, the length of the whiskers, etc. For details on defining multiple boxes with locations see 'x'. Each box spans from the first quartile to the third. The second quartile is marked by a line inside the box. By default, the whiskers are correspond to box' edges +/- 1.5 times the interquartile range. See also 'boxpoints' for more info

XPlot

Box

Constructors

Instance members