Root definitions

BoxPlotDef

Permalink

Properties

box

anyOf [boolean, anyOf [MarkConfig, AreaConfig, BarConfig, RectConfig, LineConfig, TickConfig]]

clip

boolean

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

color

anyOf [anyOf [string, string, string], anyOf [LinearGradient, RadialGradient], ExprRef]

Default color.

Default value: "#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

anyOf [string, number]

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.

invalid

anyOf [string, null]

Invalid data mode, which defines how the marks and corresponding scales should represent invalid values (null and NaN in continuous scales without defined output for invalid values).

  • "filter"Exclude all invalid values from the visualization's marks and scales. For path marks (for line, area, trail), this option will create paths that connect valid points, as if the data rows with invalid values do not exist.

  • "break-paths-filter-domains" — Break path marks (for line, area, trail) at invalid values. For non-path marks, this is equivalent to "filter". All scale domains will exclude these filtered data points.

  • "break-paths-show-domains" — Break paths (for line, area, trail) at invalid values. Hide invalid values for non-path marks. All scale domains will include these filtered data points (for both path and non-path marks).

  • "show" or null — Show all data points in the marks and scale domains. Each scale will use the output for invalid values defined in config.scale.invalid or, if unspecified, by default invalid values will produce the same visual values as zero (if the scale includes zero) or the minimum value (if the scale does not include zero).

  • "break-paths-show-path-domains" (default) — This is equivalent to "break-paths-show-domains" for path-based marks (line/area/trail) and "filter" for non-path marks.

Note: If any channel's scale has an output for invalid values defined in config.scale.invalid, all values for the scales will be considered "valid" since they can produce a reasonable output for the scales. Thus, fields for such channels will not be filtered and will not cause path breaks.

median

anyOf [boolean, anyOf [MarkConfig, AreaConfig, BarConfig, RectConfig, LineConfig, TickConfig]]

opacity

number

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

Minimum: 0, Maximum: 1
orient

string

Valid values: horizontal, vertical

outliers

anyOf [boolean, anyOf [MarkConfig, AreaConfig, BarConfig, RectConfig, LineConfig, TickConfig]]

rule

anyOf [boolean, anyOf [MarkConfig, AreaConfig, BarConfig, RectConfig, LineConfig, TickConfig]]

size

number

Size of the box and median tick of a box plot

ticks

anyOf [boolean, anyOf [MarkConfig, AreaConfig, BarConfig, RectConfig, LineConfig, TickConfig]]

type Required

string

Loading...

Editor and Validator