altair.MarkConfig#
- class altair.MarkConfig(align=Undefined, angle=Undefined, aria=Undefined, ariaRole=Undefined, ariaRoleDescription=Undefined, aspect=Undefined, baseline=Undefined, blend=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, description=Undefined, dir=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, endAngle=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, innerRadius=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, outerRadius=Undefined, padAngle=Undefined, radius=Undefined, radius2=Undefined, shape=Undefined, size=Undefined, smooth=Undefined, startAngle=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, timeUnitBandPosition=Undefined, timeUnitBandSize=Undefined, tooltip=Undefined, url=Undefined, width=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)#
MarkConfig schema wrapper
MarkConfig
, Dict- Parameters:
- align
Align
, Literal[‘left’, ‘center’, ‘right’],ExprRef
, Dict[required=[expr]] The horizontal alignment of the text or ranged marks (area, bar, image, rect, rule). One of
"left"
,"right"
,"center"
.Note: Expression reference is not supported for range marks.
- angle
ExprRef
, Dict[required=[expr]], float The rotation angle of the text, in degrees.
- aria
ExprRef
, Dict[required=[expr]], bool A boolean flag indicating if ARIA attributes should be included (SVG output only). If
false
, the “aria-hidden” attribute will be set on the output SVG element, removing the mark item from the ARIA accessibility tree.- ariaRole
ExprRef
, Dict[required=[expr]], str Sets the type of user interface element of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the “role” attribute. Warning: this property is experimental and may be changed in the future.
- ariaRoleDescription
ExprRef
, Dict[required=[expr]], str A human-readable, author-localized description for the role of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the “aria-roledescription” attribute. Warning: this property is experimental and may be changed in the future.
- aspect
ExprRef
, Dict[required=[expr]], bool Whether to keep aspect ratio of image marks.
- baseline
Baseline
, Literal[‘top’, ‘middle’, ‘bottom’],TextBaseline
, str,ExprRef
, Dict[required=[expr]] For text marks, the vertical text baseline. One of
"alphabetic"
(default),"top"
,"middle"
,"bottom"
,"line-top"
,"line-bottom"
, or an expression reference that provides one of the valid values. The"line-top"
and"line-bottom"
values operate similarly to"top"
and"bottom"
, but are calculated relative to thelineHeight
rather thanfontSize
alone.For range marks, the vertical alignment of the marks. One of
"top"
,"middle"
,"bottom"
.Note: Expression reference is not supported for range marks.
- blend
Blend
, Literal[None, ‘multiply’, ‘screen’, ‘overlay’, ‘darken’, ‘lighten’, ‘color-dodge’, ‘color-burn’, ‘hard-light’, ‘soft-light’, ‘difference’, ‘exclusion’, ‘hue’, ‘saturation’, ‘color’, ‘luminosity’],ExprRef
, Dict[required=[expr]] The color blend mode for drawing an item on its current background. Any valid CSS mix-blend-mode value can be used.
__Default value:__
"source-over"
- color
ColorName
, Literal[‘black’, ‘silver’, ‘gray’, ‘white’, ‘maroon’, ‘red’, ‘purple’, ‘fuchsia’, ‘green’, ‘lime’, ‘olive’, ‘yellow’, ‘navy’, ‘blue’, ‘teal’, ‘aqua’, ‘orange’, ‘aliceblue’, ‘antiquewhite’, ‘aquamarine’, ‘azure’, ‘beige’, ‘bisque’, ‘blanchedalmond’, ‘blueviolet’, ‘brown’, ‘burlywood’, ‘cadetblue’, ‘chartreuse’, ‘chocolate’, ‘coral’, ‘cornflowerblue’, ‘cornsilk’, ‘crimson’, ‘cyan’, ‘darkblue’, ‘darkcyan’, ‘darkgoldenrod’, ‘darkgray’, ‘darkgreen’, ‘darkgrey’, ‘darkkhaki’, ‘darkmagenta’, ‘darkolivegreen’, ‘darkorange’, ‘darkorchid’, ‘darkred’, ‘darksalmon’, ‘darkseagreen’, ‘darkslateblue’, ‘darkslategray’, ‘darkslategrey’, ‘darkturquoise’, ‘darkviolet’, ‘deeppink’, ‘deepskyblue’, ‘dimgray’, ‘dimgrey’, ‘dodgerblue’, ‘firebrick’, ‘floralwhite’, ‘forestgreen’, ‘gainsboro’, ‘ghostwhite’, ‘gold’, ‘goldenrod’, ‘greenyellow’, ‘grey’, ‘honeydew’, ‘hotpink’, ‘indianred’, ‘indigo’, ‘ivory’, ‘khaki’, ‘lavender’, ‘lavenderblush’, ‘lawngreen’, ‘lemonchiffon’, ‘lightblue’, ‘lightcoral’, ‘lightcyan’, ‘lightgoldenrodyellow’, ‘lightgray’, ‘lightgreen’, ‘lightgrey’, ‘lightpink’, ‘lightsalmon’, ‘lightseagreen’, ‘lightskyblue’, ‘lightslategray’, ‘lightslategrey’, ‘lightsteelblue’, ‘lightyellow’, ‘limegreen’, ‘linen’, ‘magenta’, ‘mediumaquamarine’, ‘mediumblue’, ‘mediumorchid’, ‘mediumpurple’, ‘mediumseagreen’, ‘mediumslateblue’, ‘mediumspringgreen’, ‘mediumturquoise’, ‘mediumvioletred’, ‘midnightblue’, ‘mintcream’, ‘mistyrose’, ‘moccasin’, ‘navajowhite’, ‘oldlace’, ‘olivedrab’, ‘orangered’, ‘orchid’, ‘palegoldenrod’, ‘palegreen’, ‘paleturquoise’, ‘palevioletred’, ‘papayawhip’, ‘peachpuff’, ‘peru’, ‘pink’, ‘plum’, ‘powderblue’, ‘rosybrown’, ‘royalblue’, ‘saddlebrown’, ‘salmon’, ‘sandybrown’, ‘seagreen’, ‘seashell’, ‘sienna’, ‘skyblue’, ‘slateblue’, ‘slategray’, ‘slategrey’, ‘snow’, ‘springgreen’, ‘steelblue’, ‘tan’, ‘thistle’, ‘tomato’, ‘turquoise’, ‘violet’, ‘wheat’, ‘whitesmoke’, ‘yellowgreen’, ‘rebeccapurple’],Color
,HexColor
, str, str,ExprRef
, Dict[required=[expr]],Gradient
,LinearGradient
, Dict[required=[gradient, stops]],RadialGradient
, Dict[required=[gradient, stops]] Default color.
Default value: ■
"#4682b4"
Note:
This property cannot be used in a style config.
The
fill
andstroke
properties have higher precedence thancolor
and will overridecolor
.
- cornerRadius
ExprRef
, Dict[required=[expr]], float The radius in pixels of rounded rectangles or arcs’ corners.
Default value:
0
- cornerRadiusBottomLeft
ExprRef
, Dict[required=[expr]], float The radius in pixels of rounded rectangles’ bottom left corner.
Default value:
0
- cornerRadiusBottomRight
ExprRef
, Dict[required=[expr]], float The radius in pixels of rounded rectangles’ bottom right corner.
Default value:
0
- cornerRadiusTopLeft
ExprRef
, Dict[required=[expr]], float The radius in pixels of rounded rectangles’ top right corner.
Default value:
0
- cornerRadiusTopRight
ExprRef
, Dict[required=[expr]], float The radius in pixels of rounded rectangles’ top left corner.
Default value:
0
- cursor
Cursor
, Literal[‘auto’, ‘default’, ‘none’, ‘context-menu’, ‘help’, ‘pointer’, ‘progress’, ‘wait’, ‘cell’, ‘crosshair’, ‘text’, ‘vertical-text’, ‘alias’, ‘copy’, ‘move’, ‘no-drop’, ‘not-allowed’, ‘e-resize’, ‘n-resize’, ‘ne-resize’, ‘nw-resize’, ‘s-resize’, ‘se-resize’, ‘sw-resize’, ‘w-resize’, ‘ew-resize’, ‘ns-resize’, ‘nesw-resize’, ‘nwse-resize’, ‘col-resize’, ‘row-resize’, ‘all-scroll’, ‘zoom-in’, ‘zoom-out’, ‘grab’, ‘grabbing’],ExprRef
, Dict[required=[expr]] The mouse cursor used over the mark. Any valid CSS cursor type can be used.
- description
ExprRef
, Dict[required=[expr]], str A text description of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the “aria-label” attribute.
- dir
ExprRef
, Dict[required=[expr]],TextDirection
, Literal[‘ltr’, ‘rtl’] The direction of the text. One of
"ltr"
(left-to-right) or"rtl"
(right-to-left). This property determines on which side is truncated in response to the limit parameter.Default value:
"ltr"
- dx
ExprRef
, Dict[required=[expr]], float The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.
- dy
ExprRef
, Dict[required=[expr]], float The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.
- ellipsis
ExprRef
, Dict[required=[expr]], str The ellipsis string for text truncated in response to the limit parameter.
Default value:
"…"
- endAngle
ExprRef
, Dict[required=[expr]], float The end angle in radians for arc marks. A value of
0
indicates up (north), increasing values proceed clockwise.- fill
ColorName
, Literal[‘black’, ‘silver’, ‘gray’, ‘white’, ‘maroon’, ‘red’, ‘purple’, ‘fuchsia’, ‘green’, ‘lime’, ‘olive’, ‘yellow’, ‘navy’, ‘blue’, ‘teal’, ‘aqua’, ‘orange’, ‘aliceblue’, ‘antiquewhite’, ‘aquamarine’, ‘azure’, ‘beige’, ‘bisque’, ‘blanchedalmond’, ‘blueviolet’, ‘brown’, ‘burlywood’, ‘cadetblue’, ‘chartreuse’, ‘chocolate’, ‘coral’, ‘cornflowerblue’, ‘cornsilk’, ‘crimson’, ‘cyan’, ‘darkblue’, ‘darkcyan’, ‘darkgoldenrod’, ‘darkgray’, ‘darkgreen’, ‘darkgrey’, ‘darkkhaki’, ‘darkmagenta’, ‘darkolivegreen’, ‘darkorange’, ‘darkorchid’, ‘darkred’, ‘darksalmon’, ‘darkseagreen’, ‘darkslateblue’, ‘darkslategray’, ‘darkslategrey’, ‘darkturquoise’, ‘darkviolet’, ‘deeppink’, ‘deepskyblue’, ‘dimgray’, ‘dimgrey’, ‘dodgerblue’, ‘firebrick’, ‘floralwhite’, ‘forestgreen’, ‘gainsboro’, ‘ghostwhite’, ‘gold’, ‘goldenrod’, ‘greenyellow’, ‘grey’, ‘honeydew’, ‘hotpink’, ‘indianred’, ‘indigo’, ‘ivory’, ‘khaki’, ‘lavender’, ‘lavenderblush’, ‘lawngreen’, ‘lemonchiffon’, ‘lightblue’, ‘lightcoral’, ‘lightcyan’, ‘lightgoldenrodyellow’, ‘lightgray’, ‘lightgreen’, ‘lightgrey’, ‘lightpink’, ‘lightsalmon’, ‘lightseagreen’, ‘lightskyblue’, ‘lightslategray’, ‘lightslategrey’, ‘lightsteelblue’, ‘lightyellow’, ‘limegreen’, ‘linen’, ‘magenta’, ‘mediumaquamarine’, ‘mediumblue’, ‘mediumorchid’, ‘mediumpurple’, ‘mediumseagreen’, ‘mediumslateblue’, ‘mediumspringgreen’, ‘mediumturquoise’, ‘mediumvioletred’, ‘midnightblue’, ‘mintcream’, ‘mistyrose’, ‘moccasin’, ‘navajowhite’, ‘oldlace’, ‘olivedrab’, ‘orangered’, ‘orchid’, ‘palegoldenrod’, ‘palegreen’, ‘paleturquoise’, ‘palevioletred’, ‘papayawhip’, ‘peachpuff’, ‘peru’, ‘pink’, ‘plum’, ‘powderblue’, ‘rosybrown’, ‘royalblue’, ‘saddlebrown’, ‘salmon’, ‘sandybrown’, ‘seagreen’, ‘seashell’, ‘sienna’, ‘skyblue’, ‘slateblue’, ‘slategray’, ‘slategrey’, ‘snow’, ‘springgreen’, ‘steelblue’, ‘tan’, ‘thistle’, ‘tomato’, ‘turquoise’, ‘violet’, ‘wheat’, ‘whitesmoke’, ‘yellowgreen’, ‘rebeccapurple’],Color
,HexColor
, str, str,ExprRef
, Dict[required=[expr]],Gradient
,LinearGradient
, Dict[required=[gradient, stops]],RadialGradient
, Dict[required=[gradient, stops]], None Default fill color. This property has higher precedence than
config.color
. Set tonull
to remove fill.Default value: (None)
- fillOpacity
ExprRef
, Dict[required=[expr]], float The fill opacity (value between [0,1]).
Default value:
1
- filledbool
Whether the mark’s color should be used as fill color instead of stroke color.
Default value:
false
for allpoint
,line
, andrule
marks as well asgeoshape
marks for graticule data sources; otherwise,true
.Note: This property cannot be used in a style config.
- font
ExprRef
, Dict[required=[expr]], str The typeface to set the text in (e.g.,
"Helvetica Neue"
).- fontSize
ExprRef
, Dict[required=[expr]], float The font size, in pixels.
Default value:
11
- fontStyle
ExprRef
, Dict[required=[expr]],FontStyle
, str The font style (e.g.,
"italic"
).- fontWeight
ExprRef
, Dict[required=[expr]],FontWeight
, Literal[‘normal’, ‘bold’, ‘lighter’, ‘bolder’, 100, 200, 300, 400, 500, 600, 700, 800, 900] The font weight. This can be either a string (e.g
"bold"
,"normal"
) or a number (100
,200
,300
, …,900
where"normal"
=400
and"bold"
=700
).- height
ExprRef
, Dict[required=[expr]], float Height of the marks.
- href
ExprRef
, Dict[required=[expr]],URI
, str A URL to load upon mouse click. If defined, the mark acts as a hyperlink.
- innerRadius
ExprRef
, Dict[required=[expr]], float The inner radius in pixels of arc marks.
innerRadius
is an alias forradius2
.Default value:
0
- interpolate
ExprRef
, Dict[required=[expr]],Interpolate
, Literal[‘basis’, ‘basis-open’, ‘basis-closed’, ‘bundle’, ‘cardinal’, ‘cardinal-open’, ‘cardinal-closed’, ‘catmull-rom’, ‘linear’, ‘linear-closed’, ‘monotone’, ‘natural’, ‘step’, ‘step-before’, ‘step-after’] The line interpolation method to use for line and area marks. One of the following:
"linear"
: piecewise linear segments, as in a polyline."linear-closed"
: close the linear segments to form a polygon."step"
: alternate between horizontal and vertical segments, as in a step function."step-before"
: alternate between vertical and horizontal segments, as in a step function."step-after"
: alternate between horizontal and vertical segments, as in a step function."basis"
: a B-spline, with control point duplication on the ends."basis-open"
: an open B-spline; may not intersect the start or end."basis-closed"
: a closed B-spline, as in a loop."cardinal"
: a Cardinal spline, with control point duplication on the ends."cardinal-open"
: an open Cardinal spline; may not intersect the start or end, but will intersect other control points."cardinal-closed"
: a closed Cardinal spline, as in a loop."bundle"
: equivalent to basis, except the tension parameter is used to straighten the spline."monotone"
: cubic interpolation that preserves monotonicity in y.
- invalidLiteral[‘filter’, None]
Defines how Vega-Lite should handle marks for invalid values (
null
andNaN
).If set to
"filter"
(default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).If
null
, all data items are included. In this case, invalid values will be interpreted as zeroes.
- limit
ExprRef
, Dict[required=[expr]], float The maximum length of the text mark in pixels. The text value will be automatically truncated if the rendered size exceeds the limit.
Default value:
0
– indicating no limit- lineBreak
ExprRef
, Dict[required=[expr]], str A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property is ignored if the text is array-valued.
- lineHeight
ExprRef
, Dict[required=[expr]], float The line height in pixels (the spacing between subsequent lines of text) for multi-line text marks.
- opacity
ExprRef
, Dict[required=[expr]], float 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.- orderNone, bool
For line and trail marks, this
order
property can be set tonull
orfalse
to make the lines use the original order in the data sources.- orient
Orientation
, Literal[‘horizontal’, ‘vertical’] The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical.
For bar, rule and tick, this determines whether the size of the bar and tick should be applied to x or y dimension.
For area, this property determines the orient property of the Vega output.
For line and trail marks, this property determines the sort order of the points in the line if
config.sortLineBy
is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.
- outerRadius
ExprRef
, Dict[required=[expr]], float The outer radius in pixels of arc marks.
outerRadius
is an alias forradius
.Default value:
0
- padAngle
ExprRef
, Dict[required=[expr]], float The angular padding applied to sides of the arc, in radians.
- radius
ExprRef
, Dict[required=[expr]], float For arc mark, the primary (outer) radius in pixels.
For text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the
x
andy
properties.Default value:
min(plot_width, plot_height)/2
- radius2
ExprRef
, Dict[required=[expr]], float The secondary (inner) radius in pixels of arc marks.
Default value:
0
- shape
ExprRef
, Dict[required=[expr]],SymbolShape
, str, str Shape of the point marks. Supported values include:
plotting shapes:
"circle"
,"square"
,"cross"
,"diamond"
,"triangle-up"
,"triangle-down"
,"triangle-right"
, or"triangle-left"
.the line symbol
"stroke"
centered directional shapes
"arrow"
,"wedge"
, or"triangle"
a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)
Default value:
"circle"
- size
ExprRef
, Dict[required=[expr]], float Default size for marks.
For
point
/circle
/square
, this represents the pixel area of the marks. Note that this value sets the area of the symbol; the side lengths will increase with the square root of this value.For
bar
, this represents the band size of the bar, in pixels.For
text
, this represents the font size, in pixels.
Default value:
30
for point, circle, square marks; width/height’sstep
2
for bar marks with discrete dimensions;5
for bar marks with continuous dimensions;11
for text marks.
- smooth
ExprRef
, Dict[required=[expr]], bool A boolean flag (default true) indicating if the image should be smoothed when resized. If false, individual pixels should be scaled directly rather than interpolated with smoothing. For SVG rendering, this option may not work in some browsers due to lack of standardization.
- startAngle
ExprRef
, Dict[required=[expr]], float The start angle in radians for arc marks. A value of
0
indicates up (north), increasing values proceed clockwise.- stroke
ColorName
, Literal[‘black’, ‘silver’, ‘gray’, ‘white’, ‘maroon’, ‘red’, ‘purple’, ‘fuchsia’, ‘green’, ‘lime’, ‘olive’, ‘yellow’, ‘navy’, ‘blue’, ‘teal’, ‘aqua’, ‘orange’, ‘aliceblue’, ‘antiquewhite’, ‘aquamarine’, ‘azure’, ‘beige’, ‘bisque’, ‘blanchedalmond’, ‘blueviolet’, ‘brown’, ‘burlywood’, ‘cadetblue’, ‘chartreuse’, ‘chocolate’, ‘coral’, ‘cornflowerblue’, ‘cornsilk’, ‘crimson’, ‘cyan’, ‘darkblue’, ‘darkcyan’, ‘darkgoldenrod’, ‘darkgray’, ‘darkgreen’, ‘darkgrey’, ‘darkkhaki’, ‘darkmagenta’, ‘darkolivegreen’, ‘darkorange’, ‘darkorchid’, ‘darkred’, ‘darksalmon’, ‘darkseagreen’, ‘darkslateblue’, ‘darkslategray’, ‘darkslategrey’, ‘darkturquoise’, ‘darkviolet’, ‘deeppink’, ‘deepskyblue’, ‘dimgray’, ‘dimgrey’, ‘dodgerblue’, ‘firebrick’, ‘floralwhite’, ‘forestgreen’, ‘gainsboro’, ‘ghostwhite’, ‘gold’, ‘goldenrod’, ‘greenyellow’, ‘grey’, ‘honeydew’, ‘hotpink’, ‘indianred’, ‘indigo’, ‘ivory’, ‘khaki’, ‘lavender’, ‘lavenderblush’, ‘lawngreen’, ‘lemonchiffon’, ‘lightblue’, ‘lightcoral’, ‘lightcyan’, ‘lightgoldenrodyellow’, ‘lightgray’, ‘lightgreen’, ‘lightgrey’, ‘lightpink’, ‘lightsalmon’, ‘lightseagreen’, ‘lightskyblue’, ‘lightslategray’, ‘lightslategrey’, ‘lightsteelblue’, ‘lightyellow’, ‘limegreen’, ‘linen’, ‘magenta’, ‘mediumaquamarine’, ‘mediumblue’, ‘mediumorchid’, ‘mediumpurple’, ‘mediumseagreen’, ‘mediumslateblue’, ‘mediumspringgreen’, ‘mediumturquoise’, ‘mediumvioletred’, ‘midnightblue’, ‘mintcream’, ‘mistyrose’, ‘moccasin’, ‘navajowhite’, ‘oldlace’, ‘olivedrab’, ‘orangered’, ‘orchid’, ‘palegoldenrod’, ‘palegreen’, ‘paleturquoise’, ‘palevioletred’, ‘papayawhip’, ‘peachpuff’, ‘peru’, ‘pink’, ‘plum’, ‘powderblue’, ‘rosybrown’, ‘royalblue’, ‘saddlebrown’, ‘salmon’, ‘sandybrown’, ‘seagreen’, ‘seashell’, ‘sienna’, ‘skyblue’, ‘slateblue’, ‘slategray’, ‘slategrey’, ‘snow’, ‘springgreen’, ‘steelblue’, ‘tan’, ‘thistle’, ‘tomato’, ‘turquoise’, ‘violet’, ‘wheat’, ‘whitesmoke’, ‘yellowgreen’, ‘rebeccapurple’],Color
,HexColor
, str, str,ExprRef
, Dict[required=[expr]],Gradient
,LinearGradient
, Dict[required=[gradient, stops]],RadialGradient
, Dict[required=[gradient, stops]], None Default stroke color. This property has higher precedence than
config.color
. Set tonull
to remove stroke.Default value: (None)
- strokeCap
ExprRef
, Dict[required=[expr]],StrokeCap
, Literal[‘butt’, ‘round’, ‘square’] The stroke cap for line ending style. One of
"butt"
,"round"
, or"square"
.Default value:
"butt"
- strokeDash
ExprRef
, Dict[required=[expr]], Sequence[float] An array of alternating stroke, space lengths for creating dashed or dotted lines.
- strokeDashOffset
ExprRef
, Dict[required=[expr]], float The offset (in pixels) into which to begin drawing with the stroke dash array.
- strokeJoin
ExprRef
, Dict[required=[expr]],StrokeJoin
, Literal[‘miter’, ‘round’, ‘bevel’] The stroke line join method. One of
"miter"
,"round"
or"bevel"
.Default value:
"miter"
- strokeMiterLimit
ExprRef
, Dict[required=[expr]], float The miter limit at which to bevel a line join.
- strokeOffset
ExprRef
, Dict[required=[expr]], float The offset in pixels at which to draw the group stroke and fill. If unspecified, the default behavior is to dynamically offset stroked groups such that 1 pixel stroke widths align with the pixel grid.
- strokeOpacity
ExprRef
, Dict[required=[expr]], float The stroke opacity (value between [0,1]).
Default value:
1
- strokeWidth
ExprRef
, Dict[required=[expr]], float The stroke width, in pixels.
- tension
ExprRef
, Dict[required=[expr]], float Depending on the interpolation type, sets the tension parameter (for line and area marks).
- text
ExprRef
, Dict[required=[expr]],Text
, Sequence[str], str Placeholder text if the
text
channel is not specified- theta
ExprRef
, Dict[required=[expr]], float For arc marks, the arc length in radians if theta2 is not specified, otherwise the start arc angle. (A value of 0 indicates up or “north”, increasing values proceed clockwise.)
For text marks, polar coordinate angle in radians.
- theta2
ExprRef
, Dict[required=[expr]], float The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise.
- timeUnitBandPositionfloat
Default relative band position for a time unit. If set to
0
, the marks will be positioned at the beginning of the time unit band step. If set to0.5
, the marks will be positioned in the middle of the time unit band step.- timeUnitBandSizefloat
Default relative band size for a time unit. If set to
1
, the bandwidth of the marks will be equal to the time unit band step. If set to0.5
, bandwidth of the marks will be half of the time unit band step.- tooltip
ExprRef
, Dict[required=[expr]],TooltipContent
, Dict[required=[content]], None, bool, float, str The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.
If
tooltip
istrue
or{"content": "encoding"}
, then all fields fromencoding
will be used.If
tooltip
is{"content": "data"}
, then all fields that appear in the highlighted data point will be used.If set to
null
orfalse
, then no tooltip will be used.
See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.
Default value:
null
- url
ExprRef
, Dict[required=[expr]],URI
, str The URL of the image file for image marks.
- width
ExprRef
, Dict[required=[expr]], float Width of the marks.
- x
ExprRef
, Dict[required=[expr]], float, str X coordinates of the marks, or width of horizontal
"bar"
and"area"
without specifiedx2
orwidth
.The
value
of this channel can be a number or a string"width"
for the width of the plot.- x2
ExprRef
, Dict[required=[expr]], float, str X2 coordinates for ranged
"area"
,"bar"
,"rect"
, and"rule"
.The
value
of this channel can be a number or a string"width"
for the width of the plot.- y
ExprRef
, Dict[required=[expr]], float, str Y coordinates of the marks, or height of vertical
"bar"
and"area"
without specifiedy2
orheight
.The
value
of this channel can be a number or a string"height"
for the height of the plot.- y2
ExprRef
, Dict[required=[expr]], float, str Y2 coordinates for ranged
"area"
,"bar"
,"rect"
, and"rule"
.The
value
of this channel can be a number or a string"height"
for the height of the plot.
- align
- __init__(align=Undefined, angle=Undefined, aria=Undefined, ariaRole=Undefined, ariaRoleDescription=Undefined, aspect=Undefined, baseline=Undefined, blend=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, description=Undefined, dir=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, endAngle=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, innerRadius=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, outerRadius=Undefined, padAngle=Undefined, radius=Undefined, radius2=Undefined, shape=Undefined, size=Undefined, smooth=Undefined, startAngle=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, timeUnitBandPosition=Undefined, timeUnitBandSize=Undefined, tooltip=Undefined, url=Undefined, width=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)#
Methods
__init__
([align, angle, aria, ariaRole, ...])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, indent, sort_keys, ...])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