altair.BoxPlotDef
- class altair.BoxPlotDef(type=Undefined, box=Undefined, clip=Undefined, color=Undefined, extent=Undefined, median=Undefined, opacity=Undefined, orient=Undefined, outliers=Undefined, rule=Undefined, size=Undefined, ticks=Undefined, **kwds)
-
BoxPlotDef schema wrapper
Mapping(required=[type])
- Attributes
-
- type
BoxPlot -
The mark type. This could a primitive mark type (one of
"bar","circle","square","tick","line","area","point","geoshape","rule", and"text") or a composite mark type ("boxplot","errorband","errorbar"). - boxanyOf(boolean,
MarkConfigExprOrSignalRef) - clipboolean
-
Whether a composite mark be clipped to the enclosing group’s width and height.
- coloranyOf(
Color,Gradient,ExprRef) -
Default color.
Default value: ■
"#4682b4"Note: - This property cannot be used in a style config. - The
fillandstrokeproperties have higher precedence thancolorand will overridecolor. - extentanyOf(string, float)
-
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. - mediananyOf(boolean,
MarkConfigExprOrSignalRef) - opacityfloat
-
The opacity (value between [0,1]) of the mark.
- orient
Orientation -
Orientation of the box plot. This is normally automatically determined based on types of fields on x and y channels. However, an explicit
orientbe specified when the orientation is ambiguous.Default value:
"vertical". - outliersanyOf(boolean,
MarkConfigExprOrSignalRef) - ruleanyOf(boolean,
MarkConfigExprOrSignalRef) - sizefloat
-
Size of the box and median tick of a box plot
- ticksanyOf(boolean,
MarkConfigExprOrSignalRef)
- type
- __init__(type=Undefined, box=Undefined, clip=Undefined, color=Undefined, extent=Undefined, median=Undefined, opacity=Undefined, orient=Undefined, outliers=Undefined, rule=Undefined, size=Undefined, ticks=Undefined, **kwds)
Methods
__init__([type, box, clip, color, extent, ...])copy([deep, ignore])Return a copy of the object
from_dict(dct[, validate, _wrapper_classes])Construct class from a dictionary representation
from_json(json_string[, validate])Instantiate the object from a valid JSON string
resolve_references([schema])Resolve references in the context of this object's schema or root schema.
to_dict([validate, ignore, context])Return a dictionary representation of the object
to_json([validate, ignore, context, indent, ...])Emit the JSON representation for this object as a string.
validate(instance[, schema])Validate the instance against the class schema in the context of the rootschema.
validate_property(name, value[, schema])Validate a property against property schema in the context of the rootschema