altair.AreaConfig#
- class altair.AreaConfig(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, line=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, outerRadius=Undefined, padAngle=Undefined, point=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)#
AreaConfig schema wrapper.
- Parameters:
- aligndict,
Align
,ExprRef
, Literal[âleftâ, âcenterâ, ârightâ] 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.
- angledict, float,
ExprRef
The rotation angle of the text, in degrees.
- ariabool, dict,
ExprRef
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.- ariaRolestr, dict,
ExprRef
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.
- ariaRoleDescriptionstr, dict,
ExprRef
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.
- aspectbool, dict,
ExprRef
Whether to keep aspect ratio of image marks.
- baselinedict,
ExprRef
,Baseline
,TextBaseline
, Literal[âalphabeticâ, âline-bottomâ, âline-topâ, âtopâ, âmiddleâ, âbottomâ] 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.
- blenddict,
Blend
,ExprRef
, Literal[None, âmultiplyâ, âscreenâ, âoverlayâ, âdarkenâ, âlightenâ, âcolor-dodgeâ, âcolor-burnâ, âhard-lightâ, âsoft-lightâ, âdifferenceâ, âexclusionâ, âhueâ, âsaturationâ, âcolorâ, âluminosityâ] 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"
- colorstr, dict,
Color
,ExprRef
,Gradient
,HexColor
,ColorName
,LinearGradient
,RadialGradient
, 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â] 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
.
- cornerRadiusdict, float,
ExprRef
The radius in pixels of rounded rectangles or arcsâ corners.
Default value:
0
- cornerRadiusBottomLeftdict, float,
ExprRef
The radius in pixels of rounded rectanglesâ bottom left corner.
Default value:
0
- cornerRadiusBottomRightdict, float,
ExprRef
The radius in pixels of rounded rectanglesâ bottom right corner.
Default value:
0
- cornerRadiusTopLeftdict, float,
ExprRef
The radius in pixels of rounded rectanglesâ top right corner.
Default value:
0
- cornerRadiusTopRightdict, float,
ExprRef
The radius in pixels of rounded rectanglesâ top left corner.
Default value:
0
- cursordict,
Cursor
,ExprRef
, 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â] The mouse cursor used over the mark. Any valid CSS cursor type can be used.
- descriptionstr, dict,
ExprRef
A text description of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the âaria-labelâ attribute.
- dirdict,
ExprRef
, Literal[âltrâ, ârtlâ],TextDirection
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"
- dxdict, float,
ExprRef
The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.
- dydict, float,
ExprRef
The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.
- ellipsisstr, dict,
ExprRef
The ellipsis string for text truncated in response to the limit parameter.
Default value:
"âŠ"
- endAngledict, float,
ExprRef
The end angle in radians for arc marks. A value of
0
indicates up (north), increasing values proceed clockwise.- fillstr, dict, None,
Color
,ExprRef
,Gradient
,HexColor
,ColorName
,LinearGradient
,RadialGradient
, 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â] Default fill color. This property has higher precedence than
config.color
. Set tonull
to remove fill.Default value: (None)
- fillOpacitydict, float,
ExprRef
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.
- fontstr, dict,
ExprRef
The typeface to set the text in (e.g.,
"Helvetica Neue"
).- fontSizedict, float,
ExprRef
The font size, in pixels.
Default value:
11
- fontStylestr, dict,
ExprRef
,FontStyle
The font style (e.g.,
"italic"
).- fontWeightdict,
ExprRef
,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
).- heightdict, float,
ExprRef
Height of the marks.
- hrefstr, dict,
URI
,ExprRef
A URL to load upon mouse click. If defined, the mark acts as a hyperlink.
- innerRadiusdict, float,
ExprRef
The inner radius in pixels of arc marks.
innerRadius
is an alias forradius2
.Default value:
0
- interpolatedict,
ExprRef
,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.
- invalidNone,
MarkInvalidDataMode
, Literal[âfilterâ, âbreak-paths-filter-domainsâ, âbreak-paths-show-domainsâ, âbreak-paths-show-path-domainsâ, âshowâ] Invalid data mode, which defines how the marks and corresponding scales should represent invalid values (
null
andNaN
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"
ornull
â Show all data points in the marks and scale domains. Each scale will use the output for invalid values defined inconfig.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.- limitdict, float,
ExprRef
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- linebool, dict,
OverlayMarkDef
A flag for overlaying line on top of area marks, or an object defining the properties of the overlayed lines.
If this value is an empty object (
{}
) ortrue
, lines with default properties will be used.If this value is
false
, no lines would be automatically added to area marks.
Default value:
false
.- lineBreakstr, dict,
ExprRef
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.
- lineHeightdict, float,
ExprRef
The line height in pixels (the spacing between subsequent lines of text) for multi-line text marks.
- opacitydict, 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.- orderbool, None
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.
- outerRadiusdict, float,
ExprRef
The outer radius in pixels of arc marks.
outerRadius
is an alias forradius
.Default value:
0
- padAngledict, float,
ExprRef
The angular padding applied to sides of the arc, in radians.
- pointbool, dict, Literal[âtransparentâ],
OverlayMarkDef
A flag for overlaying points on top of line or area marks, or an object defining the properties of the overlayed points.
If this property is
"transparent"
, transparent points will be used (for enhancing tooltips and selections).If this property is an empty object (
{}
) ortrue
, filled points with default properties will be used.If this property is
false
, no points would be automatically added to line or area marks.
Default value:
false
.- radiusdict, float,
ExprRef
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
- radius2dict, float,
ExprRef
The secondary (inner) radius in pixels of arc marks.
Default value:
0
- shapestr, dict,
ExprRef
,SymbolShape
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"
- sizedict, float,
ExprRef
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.
- smoothbool, dict,
ExprRef
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.
- startAngledict, float,
ExprRef
The start angle in radians for arc marks. A value of
0
indicates up (north), increasing values proceed clockwise.- strokestr, dict, None,
Color
,ExprRef
,Gradient
,HexColor
,ColorName
,LinearGradient
,RadialGradient
, 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â] Default stroke color. This property has higher precedence than
config.color
. Set tonull
to remove stroke.Default value: (None)
- strokeCapdict,
ExprRef
,StrokeCap
, Literal[âbuttâ, âroundâ, âsquareâ] The stroke cap for line ending style. One of
"butt"
,"round"
, or"square"
.Default value:
"butt"
- strokeDashdict, Sequence[float],
ExprRef
An array of alternating stroke, space lengths for creating dashed or dotted lines.
- strokeDashOffsetdict, float,
ExprRef
The offset (in pixels) into which to begin drawing with the stroke dash array.
- strokeJoindict,
ExprRef
,StrokeJoin
, Literal[âmiterâ, âroundâ, âbevelâ] The stroke line join method. One of
"miter"
,"round"
or"bevel"
.Default value:
"miter"
- strokeMiterLimitdict, float,
ExprRef
The miter limit at which to bevel a line join.
- strokeOffsetdict, float,
ExprRef
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.
- strokeOpacitydict, float,
ExprRef
The stroke opacity (value between [0,1]).
Default value:
1
- strokeWidthdict, float,
ExprRef
The stroke width, in pixels.
- tensiondict, float,
ExprRef
Depending on the interpolation type, sets the tension parameter (for line and area marks).
- textstr, dict,
Text
, Sequence[str],ExprRef
Placeholder text if the
text
channel is not specified- thetadict, float,
ExprRef
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.
- theta2dict, float,
ExprRef
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.- tooltipstr, bool, dict, None, float,
ExprRef
,TooltipContent
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
- urlstr, dict,
URI
,ExprRef
The URL of the image file for image marks.
- widthdict, float,
ExprRef
Width of the marks.
- xdict, float,
ExprRef
, Literal[âwidthâ] 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.- x2dict, float,
ExprRef
, Literal[âwidthâ] 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.- ydict, float,
ExprRef
, Literal[âheightâ] 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.- y2dict, float,
ExprRef
, Literal[âheightâ] 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.
- aligndict,
- __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, line=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, outerRadius=Undefined, padAngle=Undefined, point=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])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.