altair.theme.BarConfigKwds#
- class altair.theme.BarConfigKwds#
altair.BarConfigTypedDictwrapper.- Parameters:
- align
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
The rotation angle of the text, in degrees.
- aria
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
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
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
Whether to keep aspect ratio of image marks.
- baseline
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 thelineHeightrather thanfontSizealone.For range marks, the vertical alignment of the marks. One of
"top","middle","bottom".Note: Expression reference is not supported for range marks.
- binSpacing
Offset between bars for binned field. The ideal value for this is either 0 (preferred by statisticians) or 1 (Vega-Lite default, D3 example style).
Default value:
1- blend
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
Default color.
Default value: ■
"#4682b4"Note:
This property cannot be used in a style config.
The
fillandstrokeproperties have higher precedence thancolorand will overridecolor.
- continuousBandSize
The default size of the bars on continuous scales.
Default value:
5- cornerRadius
The radius in pixels of rounded rectangles or arcs’ corners.
Default value:
0- cornerRadiusBottomLeft
The radius in pixels of rounded rectangles’ bottom left corner.
Default value:
0- cornerRadiusBottomRight
The radius in pixels of rounded rectangles’ bottom right corner.
Default value:
0- cornerRadiusEnd
For vertical bars, top-left and top-right corner radius.
For horizontal bars, top-right and bottom-right corner radius.
- cornerRadiusTopLeft
The radius in pixels of rounded rectangles’ top right corner.
Default value:
0- cornerRadiusTopRight
The radius in pixels of rounded rectangles’ top left corner.
Default value:
0- cursor
The mouse cursor used over the mark. Any valid CSS cursor type can be used.
- description
A text description of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the “aria-label” attribute.
- dir
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"- discreteBandSize
The default size of the bars with discrete dimensions. If unspecified, the default size is
step-2, which provides 2 pixel offset between bars.- dx
The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.
- dy
The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.
- ellipsis
The ellipsis string for text truncated in response to the limit parameter.
Default value:
"…"- endAngle
The end angle in radians for arc marks. A value of
0indicates up (north), increasing values proceed clockwise.- fill
Default fill color. This property has higher precedence than
config.color. Set tonullto remove fill.Default value: (None)
- fillOpacity
The fill opacity (value between [0,1]).
Default value:
1- filled
Whether the mark’s color should be used as fill color instead of stroke color.
Default value:
falsefor allpoint,line, andrulemarks as well asgeoshapemarks for graticule data sources; otherwise,true.Note: This property cannot be used in a style config.
- font
The typeface to set the text in (e.g.,
"Helvetica Neue").- fontSize
The font size, in pixels.
Default value:
11- fontStyle
The font style (e.g.,
"italic").- fontWeight
The font weight. This can be either a string (e.g
"bold","normal") or a number (100,200,300, …,900where"normal"=400and"bold"=700).- height
Height of the marks.
- href
A URL to load upon mouse click. If defined, the mark acts as a hyperlink.
- innerRadius
The inner radius in pixels of arc marks.
innerRadiusis an alias forradius2.Default value:
0- interpolate
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.
- invalid
Invalid data mode, which defines how the marks and corresponding scales should represent invalid values (
nullandNaNin 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.invalidor, 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.- limit
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
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
The line height in pixels (the spacing between subsequent lines of text) for multi-line text marks.
- minBandSize
The minimum band size for bar and rectangle marks. Default value:
0.25- opacity
The overall opacity (value between [0,1]).
Default value:
0.7for non-aggregate plots withpoint,tick,circle, orsquaremarks or layeredbarcharts and1otherwise.- order
For line and trail marks, this
orderproperty can be set tonullorfalseto make the lines use the original order in the data sources.- orient
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.sortLineByis not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.
- outerRadius
The outer radius in pixels of arc marks.
outerRadiusis an alias forradius.Default value:
0- padAngle
The angular padding applied to sides of the arc, in radians.
- radius
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
xandyproperties.Default value:
min(plot_width, plot_height)/2- radius2
The secondary (inner) radius in pixels of arc marks.
Default value:
0- shape
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
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:
30for point, circle, square marks; width/height’sstep2for bar marks with discrete dimensions;5for bar marks with continuous dimensions;11for text marks.
- smooth
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
The start angle in radians for arc marks. A value of
0indicates up (north), increasing values proceed clockwise.- stroke
Default stroke color. This property has higher precedence than
config.color. Set tonullto remove stroke.Default value: (None)
- strokeCap
The stroke cap for line ending style. One of
"butt","round", or"square".Default value:
"butt"- strokeDash
An array of alternating stroke, space lengths for creating dashed or dotted lines.
- strokeDashOffset
The offset (in pixels) into which to begin drawing with the stroke dash array.
- strokeJoin
The stroke line join method. One of
"miter","round"or"bevel".Default value:
"miter"- strokeMiterLimit
The miter limit at which to bevel a line join.
- strokeOffset
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
The stroke opacity (value between [0,1]).
Default value:
1- strokeWidth
The stroke width, in pixels.
- tension
Depending on the interpolation type, sets the tension parameter (for line and area marks).
- text
Placeholder text if the
textchannel is not specified- theta
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
The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise.
- timeUnitBandPosition
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.- timeUnitBandSize
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
The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.
If
tooltipistrueor{"content": "encoding"}, then all fields fromencodingwill be used.If
tooltipis{"content": "data"}, then all fields that appear in the highlighted data point will be used.If set to
nullorfalse, then no tooltip will be used.
See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.
Default value:
null- url
The URL of the image file for image marks.
- width
Width of the marks.
- x
X coordinates of the marks, or width of horizontal
"bar"and"area"without specifiedx2orwidth.The
valueof this channel can be a number or a string"width"for the width of the plot.- x2
X2 coordinates for ranged
"area","bar","rect", and"rule".The
valueof this channel can be a number or a string"width"for the width of the plot.- y
Y coordinates of the marks, or height of vertical
"bar"and"area"without specifiedy2orheight.The
valueof this channel can be a number or a string"height"for the height of the plot.- y2
Y2 coordinates for ranged
"area","bar","rect", and"rule".The
valueof this channel can be a number or a string"height"for the height of the plot.
- __init__(*args, **kwargs)#
Methods
__init__(*args, **kwargs)clear()copy()fromkeys(iterable[, value])Create a new dictionary with keys from iterable and values set to value.
get(key[, default])Return the value for key if key is in the dictionary, else default.
items()keys()pop(key[, default])If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem(/)Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()Attributes
alignangleariaariaRoleariaRoleDescriptionaspectbaselinebinSpacingblendcolorcontinuousBandSizecornerRadiuscornerRadiusBottomLeftcornerRadiusBottomRightcornerRadiusEndcornerRadiusTopLeftcornerRadiusTopRightcursordescriptiondirdiscreteBandSizedxdyellipsisendAnglefillfillOpacityfilledfontfontSizefontStylefontWeightheighthrefinnerRadiusinterpolateinvalidlimitlineBreaklineHeightminBandSizeopacityorderorientouterRadiuspadAngleradiusradius2shapesizesmoothstartAnglestrokestrokeCapstrokeDashstrokeDashOffsetstrokeJoinstrokeMiterLimitstrokeOffsetstrokeOpacitystrokeWidthtensiontextthetatheta2timeUnitBandPositiontimeUnitBandSizetooltipurlwidthxx2yy2