altair.theme.LegendConfigKwds#
- class altair.theme.LegendConfigKwds#
altair.LegendConfig的TypedDict包装器。- 参数:
- aria
一个布尔标志，指示是否应包含 ARIA attributes（仅限 SVG 输出）。如果为
false，则输出 SVG 分组将设置“aria-hidden”属性，从而从 ARIA 可访问性树中移除图例。默认值:
true- clipHeight
裁剪符号图例条目并限制其大小的像素高度。
- columnPadding
符号图例条目之间的水平像素填充。
默认值:
10。- columns
排列符号图例条目的列数。值
0或更低表示单行，每条目一列。- cornerRadius
整个图例的圆角半径。
- description
此图例的文本描述，用于 ARIA accessibility（仅限 SVG 输出）。如果
aria属性为 true，则对于 SVG 输出，“aria-label” attribute 将设置为此描述。如果未指定描述，则将自动生成。- direction
图例的方向，可以是
"vertical"或"horizontal"之一。默认值
对于顶部/底部
orient``ed legends， ``"horizontal"对于左侧/右侧
orient``ed legends， ``"vertical"对于左上/右上/左下/右下
orient``ed legends， 渐变图例为 ``"horizontal"，符号图例为"vertical"。
- disable
默认禁用图例
- fillColor
整个图例的背景填充颜色。
- gradientDirection
渐变图例的默认方向（
"horizontal"或"vertical"）。默认值:
"vertical"。- gradientHorizontalMaxLength
当
config.legend.gradientLength未定义时，水平渐变的最大图例长度。默认值:
200- gradientHorizontalMinLength
当
config.legend.gradientLength未定义时，水平渐变的最小图例长度。默认值:
100- gradientLabelLimit
颜色渐变标签允许的最大像素长度。
- gradientLabelOffset
颜色渐变标签的垂直像素偏移。
默认值:
2。- gradientLength
颜色渐变主轴的像素长度。此值对应于垂直渐变的高度或水平渐变的宽度。
默认值:
200。- gradientOpacity
颜色渐变的透明度。
- gradientStrokeColor
渐变描边的颜色，可以是十六进制颜色代码或常规颜色名称。
默认值:
"lightGray"。- gradientStrokeWidth
渐变描边的宽度，以像素为单位。
默认值:
0。- gradientThickness
颜色渐变的像素厚度。此值对应于垂直渐变的宽度或水平渐变的高度。
默认值:
16。- gradientVerticalMaxLength
当
config.legend.gradientLength未定义时，垂直渐变的最大图例长度。默认值:
200- gradientVerticalMinLength
当
config.legend.gradientLength未定义时，垂直渐变的最小图例长度。默认值:
100- gridAlign
应用于符号图例行和列的对齐方式。支持的字符串值包括
"all"、"each"（默认）和none。更多信息请参见网格布局文档。默认值:
"each"。- labelAlign
图例标签的对齐方式，可以是 left、center 或 right。
- labelBaseline
图例标签基线的位置，可以是
"top"、"middle"、"bottom"或"alphabetic"。默认值:
"middle"。- labelColor
图例标签的颜色，可以是十六进制颜色代码或常规颜色名称。
- labelFont
图例标签的字体。
- labelFontSize
图例标签的字体大小。
默认值:
10。- labelFontStyle
图例标签的字体样式。
- labelFontWeight
图例标签的字体粗细。
- labelLimit
图例刻度标签允许的最大像素宽度。
默认值:
160。- labelOffset
图例标签的偏移量。
默认值:
4。- 标签不透明度
labelOpacity
- 标签的透明度。
labelOverlap
默认值: 对数刻度为
"greedy"，否则为true。- labelPadding
图例和图例标签之间的像素填充。
- labelSeparation
标签边界框之间必须存在的最小间隔（默认值
0），以便将其视为不重叠。如果未启用 labelOverlap 分辨率，则忽略此属性。- layout
- legendX
对于方向为“none”的图例的自定义 x 坐标。
- legendY
对于方向为“none”的图例的自定义 y 坐标。
- offset
图例相对于数据区域和坐标轴的像素偏移量。
默认值:
18。- orient
图例的方向，它决定了图例在场景中的位置。可以是
"left"、"right"、"top"、"bottom"、"top-left"、"top-right"、"bottom-left"、"bottom-right"或"none"之一。默认值:
"right"- padding
图例分组的边框和内容之间的填充。
默认值:
0。- rowPadding
符号图例条目之间的垂直像素填充。
默认值:
2。- strokeColor
整个图例的边框描边颜色。
- strokeDash
整个图例的边框描边虚线样式。
- strokeWidth
整个图例的边框描边宽度。
- symbolBaseFillColor
图例符号的默认填充颜色。仅在图例没有
"fill"比例颜色编码时应用。默认值:
"transparent"。- symbolBaseStrokeColor
图例符号的默认描边颜色。仅在图例没有
"fill"比例颜色编码时应用。默认值:
"gray"。- symbolDash
用于虚线符号描边的交替 [描边, 空格] 长度数组。
- symbolDashOffset
开始使用符号描边虚线数组绘制的像素偏移。
- symbolDirection
符号图例的默认方向（
"horizontal"或"vertical"）。默认值:
"vertical"。- symbolFillColor
图例符号的颜色。
- symbolLimit
符号图例允许的最大条目数。超出部分将被丢弃。
- symbolOffset
图例符号的水平像素偏移。
默认值:
0。- symbolOpacity
图例符号的透明度。
- symbolSize
图例符号的大小，以像素为单位。
默认值:
100。- symbolStrokeColor
图例符号的描边颜色。
- symbolStrokeWidth
符号描边的宽度。
默认值:
1.5。- symbolType
符号形状。可以是绘图形状中的一个：
circle（默认）、square、cross、diamond、triangle-up、triangle-down、triangle-right或triangle-left；或线条符号stroke；或中心方向形状中的一个：arrow、wedge或triangle。此外，也可以提供自定义的 SVG path string。为了正确缩放，自定义形状路径应定义在一个方形边界框内，x 和 y 维度的坐标范围从 -1 到 1。默认值:
"circle"。- tickCount
定量图例所需的刻度值数量。
- title
设置为 null 可禁用轴、图例或标题的标题。
- titleAlign
图例标题的水平文本对齐。
默认值:
"left"。- titleAnchor
放置图例标题的文本锚点位置。
- titleBaseline
图例标题的垂直文本基线。可以是
"alphabetic"（默认）、"top"、"middle"、"bottom"、"line-top"或"line-bottom"之一。"line-top"和"line-bottom"的值与"top"和"bottom"的操作类似，但它们是相对于 lineHeight 计算的，而不是单独相对于 fontSize 计算。默认值:
"top"。- titleColor
图例标题的颜色，可以是十六进制颜色代码或常规颜色名称。
- titleFont
图例标题的字体。
- titleFontSize
图例标题的字体大小。
- titleFontStyle
图例标题的字体样式。
- titleFontWeight
图例标题的字体粗细。可以是字符串（例如
"bold"、"normal"）或数字（100、200、300、...、900，其中"normal"=400，"bold"=700）。- titleLimit
图例标题允许的最大像素宽度。
默认值:
180。- titleLineHeight
多行标题文本或基线为
"line-top"或"line-bottom"的标题文本的像素行高。- titleOpacity
图例标题的透明度。
- titleOrient
图例标题的方向。
- titlePadding
标题和图例之间的像素填充。
默认值:
5。- unselectedOpacity
未选中图例条目的透明度。
默认值 0.35.
- zindex
整数 z-index，指示图例分组相对于其他轴、标记和图例分组的分层。
- __init__(*args, **kwargs)#
方法
__init__(*args, **kwargs)clear()copy()fromkeys(iterable[, value])使用来自 iterable 的键和设置为 value 的值创建一个新字典。
get(key[, default])如果字典中存在 key，则返回其值，否则返回 default。
items()keys()pop(key[, default])如果未找到 key，则在提供了 default 时返回 default；否则引发 KeyError。
popitem(/)移除并返回一个 (key, value) 对作为 2 元组。
setdefault(key[, default])如果字典中不存在 key，则插入 key 并将其值设置为 default。
update([E, ]**F)如果 E 存在并且有 .keys() 方法，则执行：for k in E: D[k] = E[k]。如果 E 存在并且没有 .keys() 方法，则执行：for k, v in E: D[k] = v。在这两种情况下，都会接着执行：for k in F: D[k] = F[k]。
values()属性
ariaclipHeightcolumnPaddingcolumnscornerRadiusdescriptiondirectiondisablefillColorgradientDirectiongradientHorizontalMaxLengthgradientHorizontalMinLengthgradientLabelLimitgradientLabelOffsetgradientLengthgradientOpacitygradientStrokeColorgradientStrokeWidthgradientThicknessgradientVerticalMaxLengthgradientVerticalMinLengthgridAlignlabelAlignlabelBaselinelabelColorlabelFontlabelFontSizelabelFontStylelabelFontWeightlabelLimitlabelOffset标签不透明度标签的透明度。labelPaddinglabelSeparationlayoutlegendXlegendYoffsetorientpaddingrowPaddingstrokeColorstrokeDashstrokeWidthsymbolBaseFillColorsymbolBaseStrokeColorsymbolDashsymbolDashOffsetsymbolDirectionsymbolFillColorsymbolLimitsymbolOffsetsymbolOpacitysymbolSizesymbolStrokeColorsymbolStrokeWidthsymbolTypetickCounttitletitleAligntitleAnchortitleBaselinetitleColortitleFonttitleFontSizetitleFontStyletitleFontWeighttitleLimittitleLineHeighttitleOpacitytitleOrienttitlePaddingunselectedOpacityzindex