altair.ViewBackground#
- class altair.ViewBackground(cornerRadius=Undefined, cursor=Undefined, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, style=Undefined, **kwds)#
ViewBackground schema wrapper
Mapping(required=[])
- Parameters:
- cornerRadiusanyOf(float,
ExprRef
) The radius in pixels of rounded rectangles or arcs’ corners.
Default value:
0
- cursor
Cursor
The mouse cursor used over the view. Any valid CSS cursor type can be used.
- fillanyOf(
Color
, None,ExprRef
) The fill color.
Default value:
undefined
- fillOpacityanyOf(float,
ExprRef
) The fill opacity (value between [0,1]).
Default value:
1
- opacityanyOf(float,
ExprRef
) The overall opacity (value between [0,1]).
Default value:
0.7
for non-aggregate plots withpoint
,tick
,circle
, orsquare
marks or layeredbar
charts and1
otherwise.- strokeanyOf(
Color
, None,ExprRef
) The stroke color.
Default value:
"#ddd"
- strokeCapanyOf(
StrokeCap
,ExprRef
) The stroke cap for line ending style. One of
"butt"
,"round"
, or"square"
.Default value:
"butt"
- strokeDashanyOf(List(float),
ExprRef
) An array of alternating stroke, space lengths for creating dashed or dotted lines.
- strokeDashOffsetanyOf(float,
ExprRef
) The offset (in pixels) into which to begin drawing with the stroke dash array.
- strokeJoinanyOf(
StrokeJoin
,ExprRef
) The stroke line join method. One of
"miter"
,"round"
or"bevel"
.Default value:
"miter"
- strokeMiterLimitanyOf(float,
ExprRef
) The miter limit at which to bevel a line join.
- strokeOpacityanyOf(float,
ExprRef
) The stroke opacity (value between [0,1]).
Default value:
1
- strokeWidthanyOf(float,
ExprRef
) The stroke width, in pixels.
- styleanyOf(string, List(string))
A string or array of strings indicating the name of custom styles to apply to the view background. A style is a named collection of mark property defaults defined within the style configuration. If style is an array, later styles will override earlier styles.
Default value:
"cell"
Note: Any specified view background properties will augment the default style.
- cornerRadiusanyOf(float,
- __init__(cornerRadius=Undefined, cursor=Undefined, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, style=Undefined, **kwds)#
Methods
__init__
([cornerRadius, cursor, fill, ...])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