altair.theme.TitleConfigKwds#
- class altair.theme.TitleConfigKwds#
altair.TitleConfig
TypedDict
wrapper.- Parameters:
- align
Horizontal text alignment for title text. One of
"left"
,"center"
, or"right"
.- anchor
The anchor position for placing the title and subtitle text. One of
"start"
,"middle"
, or"end"
. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.- angle
Angle in degrees of title and subtitle text.
- 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 group, removing the title from the ARIA accessibility tree.Default value:
true
- baseline
Vertical text baseline for title and subtitle text. One of
"alphabetic"
(default),"top"
,"middle"
,"bottom"
,"line-top"
, or"line-bottom"
. The"line-top"
and"line-bottom"
values operate similarly to"top"
and"bottom"
, but are calculated relative to the lineHeight rather than fontSize alone.- color
Text color for title text.
- dx
Delta offset for title and subtitle text x-coordinate.
- dy
Delta offset for title and subtitle text y-coordinate.
- font
Font name for title text.
- fontSize
Font size in pixels for title text.
- fontStyle
Font style for title text.
- fontWeight
Font weight for title text. This can be either a string (e.g
"bold"
,"normal"
) or a number (100
,200
,300
, …,900
where"normal"
=400
and"bold"
=700
).- frame
The reference frame for the anchor position, one of
"bounds"
(to anchor relative to the full bounding box) or"group"
(to anchor relative to the group width or height).- limit
The maximum allowed length in pixels of title and subtitle text.
- lineHeight
Line height in pixels for multi-line title text or title text with
"line-top"
or"line-bottom"
baseline.- offset
The orthogonal offset in pixels by which to displace the title group from its position along the edge of the chart.
- orient
Default title orientation (
"top"
,"bottom"
,"left"
, or"right"
)- subtitleColor
Text color for subtitle text.
- subtitleFont
Font name for subtitle text.
- subtitleFontSize
Font size in pixels for subtitle text.
- subtitleFontStyle
Font style for subtitle text.
- subtitleFontWeight
Font weight for subtitle text. This can be either a string (e.g
"bold"
,"normal"
) or a number (100
,200
,300
, …,900
where"normal"
=400
and"bold"
=700
).- subtitleLineHeight
Line height in pixels for multi-line subtitle text.
- subtitlePadding
The padding in pixels between title and subtitle text.
- zindex
The integer z-index indicating the layering of the title group relative to other axis, mark, and legend groups.
Default value:
0
.
- __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
align
anchor
angle
aria
baseline
color
dx
dy
font
fontSize
fontStyle
fontWeight
frame
limit
lineHeight
offset
orient
subtitleColor
subtitleFont
subtitleFontSize
subtitleFontStyle
subtitleFontWeight
subtitleLineHeight
subtitlePadding
zindex