vl_mark_boxplot

vl_mark_boxplot

Usage

vl_mark_boxplot(
  spec,
  box = NULL,
  clip = NULL,
  color = NULL,
  extent = NULL,
  median = NULL,
  opacity = NULL,
  orient = NULL,
  outliers = NULL,
  rule = NULL,
  size = NULL,
  ticks = NULL,
  .object = NULL
)

Arguments

spec

An input vega-lite spec

box

boolean

Or: MarkConfig

clip

Whether a composite mark be clipped to the enclosing group’s width and height.

color

Default color.

Default value: <span style="color: #4682b4;">■</span> "#4682b4"

Note:

• This property cannot be used in a style config.

• The fill and stroke properties have higher precedence than color and will override color.

extent

The extent of the whiskers. Available options include:

• "min-max": min and max are the lower and upper whiskers respectively.

• A number representing multiple of the interquartile range. This number will be multiplied by the IQR to determine whisker boundary, which spans from the smallest data to the largest data within the range [Q1 - k * IQR, Q3 + k * IQR] where Q1 and Q3 are the first and third quartiles while IQR is the interquartile range (Q3-Q1).

Default value: 1.5.

median

boolean

Or: MarkConfig

opacity

The opacity (value between [0,1]) of the mark.

orient

Orientation of the box plot. This is normally automatically determined based on types of fields on x and y channels. However, an explicit orient be specified when the orientation is ambiguous.

Default value: "vertical".

outliers

boolean

Or: MarkConfig

rule

boolean

Or: MarkConfig

size

Size of the box and median tick of a box plot

ticks

boolean

Or: MarkConfig

.object

Directly input an object, rather than creating one via the other arguments. Should not be used in conjunction with the other arguments other than spec. Objects can be of type: BoxPlotDef

Value

A modified Vega-Lite Spec