API 参考

altair.theme.BarConfigKwds#

class altair.theme.BarConfigKwds#

altair.BarConfig TypedDict 封装器。
参数：

align

文本或范围标记（area, bar, image, rect, rule）的水平对齐方式。可选值为 "left", "right", "center" 之一。

**注意：**范围标记*不*支持表达式引用。

angle

文本的旋转角度，单位为度。

aria

一个布尔标志，指示是否应包含 ARIA 属性（仅限 SVG 输出）。如果为 false，则输出的 SVG 元素上将设置 “aria-hidden” 属性，从而从 ARIA 可访问性树中移除标记项。

ariaRole

设置标记项的用户界面元素类型，用于 ARIA 可访问性（仅限 SVG 输出）。如果指定，此属性决定 “role” 属性。警告：此属性为实验性质，将来可能会更改。

ariaRoleDescription

标记项角色的易于人类阅读、作者本地化的描述，用于 ARIA 可访问性（仅限 SVG 输出）。如果指定，此属性决定 “aria-roledescription” 属性。警告：此属性为实验性质，将来可能会更改。

aspect

是否保持图像标记的宽高比。

baseline

对于文本标记，垂直文本基线。可选值为 "alphabetic"（默认）、"top"、"middle"、"bottom"、"line-top"、"line-bottom" 之一，或提供其中一个有效值的表达式引用。"line-top" 和 "line-bottom" 的值与 "top" 和 "bottom" 类似，但相对于 lineHeight 计算，而非仅相对于 fontSize 计算。

文本或范围标记（area, bar, image, rect, rule）的水平对齐方式。可选值为 "left", "right", "center" 之一。

对于范围标记，标记的垂直对齐方式。可选值为 "top", "middle", "bottom" 之一。

binSpacing

分箱字段的柱子间偏移量。理想值是 0（统计学家偏好）或 1（Vega-Lite 默认值，D3 示例风格）。

**默认值：** 1

blend

用于在当前背景上绘制项目的颜色混合模式。可以使用任何有效的 CSS mix-blend-mode 值。

__默认值：__ "source-over"

color

默认颜色。

**默认值：** ■ "#4682b4"

fill 和 stroke 属性的优先级高于 color，并将覆盖 color。

continuousBandSize

连续刻度上柱子的默认大小。

**默认值：** 5

cornerRadius

圆角矩形或弧形拐角的像素半径。

**默认值：** 0

cornerRadiusBottomLeft

圆角矩形或弧形拐角的像素半径。

圆角矩形左下角的像素半径。

cornerRadiusBottomRight

圆角矩形或弧形拐角的像素半径。

圆角矩形右下角的像素半径。

  • cornerRadiusEnd

  • 对于垂直柱，左上角和右上角半径。

对于水平柱，右上角和右下角半径。

cornerRadiusTopLeft

圆角矩形或弧形拐角的像素半径。

圆角矩形右上角的像素半径。

cornerRadiusTopRight

圆角矩形或弧形拐角的像素半径。

圆角矩形左上角的像素半径。

cursor

鼠标悬停在标记上时使用的光标。可以使用任何有效的 CSS 光标类型。

description

标记项的文本描述，用于 ARIA 可访问性（仅限 SVG 输出）。如果指定，此属性决定 “aria-label” 属性。

dir

文本方向。可选值为 "ltr"（从左到右）或 "rtl"（从右到左）。此属性决定了文本在响应 limit 参数时被截断的方向。

**默认值：** "ltr"

discreteBandSize

离散维度柱子的默认大小。如果未指定，默认大小为 step-2，这会在柱子之间提供 2 像素的偏移。

dx

文本标签与其锚点之间的水平偏移量，单位为像素。偏移量在应用 angle 属性的旋转后应用。

dy

文本标签与其锚点之间的垂直偏移量，单位为像素。偏移量在应用 angle 属性的旋转后应用。

ellipsis

响应 limit 参数而截断文本时使用的省略号字符串。

**默认值：** "…"

endAngle

弧形标记的结束角度，单位为弧度。值为 0 表示向上（北），值增大表示顺时针方向。

fill

默认填充颜色。此属性优先级高于 config.color。设置为 null 以移除填充。

**默认值：** (无)

fillOpacity

分箱字段的柱子间偏移量。理想值是 0（统计学家偏好）或 1（Vega-Lite 默认值，D3 示例风格）。

填充不透明度（值在 [0,1] 之间）。

filled

标记的颜色是用作填充色还是描边色。

**默认值：** 对于所有 point, line, 和 rule 标记以及 graticule 数据源的 geoshape 标记为 false；否则为 true。

**注意：**此属性不能用于 样式配置。

font

文本字体（例如，"Helvetica Neue"）。

fontSize

字体大小，单位为像素。

**默认值：** 11

fontStyle

字体样式（例如，"italic"）。

fontWeight

字体粗细。可以是字符串（例如 "bold", "normal"）或数字（100, 200, 300, ..., 900，其中 "normal" = 400，"bold" = 700）。

height

标记的高度。

href

鼠标点击时加载的 URL。如果定义，标记将作为超链接。

innerRadius

圆角矩形或弧形拐角的像素半径。

弧形标记的内半径，单位为像素。innerRadius 是 radius2 的别名。

interpolate

  • 用于线和面积标记的线条插值方法。以下之一：

  • "linear"：分段线性线段，如折线。

  • "linear-closed"：闭合线性线段形成多边形。

  • "step"：交替水平和垂直线段，如阶梯函数。

  • "step-before"：交替垂直和水平线段，如阶梯函数。

  • "step-after"：交替水平和垂直线段，如阶梯函数。

  • "basis"：B 样条，两端控制点重复。

  • "basis-open"：开放 B 样条；可能不与起点或终点相交。

  • "basis-closed"：闭合 B 样条，如循环。

  • "cardinal"：Cardinal 样条，两端控制点重复。

  • "cardinal-open"：开放 Cardinal 样条；可能不与起点或终点相交，但会与其他控制点相交。

  • "cardinal-closed"：闭合 Cardinal 样条，如循环。

  • "bundle"：等同于 basis，但使用 tension 参数拉直样条。

"monotone"：保持 y 单调性的三次插值。

invalid

  • 无效数据模式，定义了标记和相应刻度如何表示无效值（连续刻度中 null 和 NaN 且未定义无效值输出）。

  • "filter" — 从可视化标记和刻度中排除所有无效值。对于路径标记（线、面积、轨迹），此选项将创建连接有效点的路径，如同数据行中不存在无效值一样。

  • "break-paths-filter-domains" — 在无效值处中断路径标记（线、面积、轨迹）。对于非路径标记，等同于 "filter"。所有刻度域将排除这些被过滤的数据点。

  • "break-paths-show-domains" — 在无效值处中断路径（线、面积、轨迹）。对于非路径标记，隐藏无效值。所有刻度域将包含这些被过滤的数据点（对于路径和非路径标记）。

  • "show" 或 null — 在标记和刻度域中显示所有数据点。每个刻度将使用在 config.scale.invalid 中定义的无效值输出，或者如果未指定，默认情况下无效值将生成与零（如果刻度包含零）或最小值（如果刻度不包含零）相同的视觉值。

"break-paths-show-path-domains"（默认）— 对于基于路径的标记（线/面积/轨迹），这等同于 "break-paths-show-domains"；对于非路径标记，等同于 "filter"。

**注意**：如果任何通道的刻度在 config.scale.invalid 中定义了无效值输出，则这些刻度的所有值都将被视为“有效”，因为它们可以为刻度生成合理的输出。因此，这些通道的字段不会被过滤，也不会导致路径中断。

limit

文本标记的最大长度，单位为像素。如果渲染大小超过此限制，文本值将自动截断。

**默认值：** 0 – 表示无限制

lineBreak

一个分隔符，例如换行符，用于将文本字符串分成多行。如果文本是数组值，此属性将被忽略。

lineHeight

多行文本标记的行高，单位为像素（后续文本行之间的间距）。

minBandSize

条形和矩形标记的最小带大小。**默认值：** 0.25

opacity

总不透明度（值在 [0,1] 之间）。

**默认值：** 对于带有 point, tick, circle 或 square 标记的非聚合图表或分层 bar 图表为 0.7，否则为 1。

order

对于线和轨迹标记，此 order 属性可以设置为 null 或 false，以使线条使用数据源中的原始顺序。

orient

  • 非堆叠条形图、刻度图、面积图和折线图的方向。值可以是水平（默认）或垂直。

  • 对于条形、规则和刻度，这决定了条形和刻度的大小应该应用于 x 还是 y 维度。

  • 对于面积图，此属性决定了 Vega 输出的 orient 属性。

对于线和轨迹标记，如果未指定 config.sortLineBy，此属性决定了线中点的排序顺序。对于堆叠图表，这始终由堆叠的方向决定；因此，显式指定的值将被忽略。

outerRadius

圆角矩形或弧形拐角的像素半径。

弧形标记的外半径，单位为像素。outerRadius 是 radius 的别名。

padAngle

应用于弧形两侧的角度填充，单位为弧度。

radius

对于弧形标记，主（外）半径，单位为像素。

对于文本标记，极坐标径向偏移，单位为像素，从由 x 和 y 属性确定的原点出发。

**默认值：** min(plot_width, plot_height)/2

radius2

圆角矩形或弧形拐角的像素半径。

弧形标记的次（内）半径，单位为像素。

shape

  • 点标记的形状。支持的值包括：

  • 绘图形状："circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", 或 "triangle-left"。

  • 线条符号 "stroke"

  • 中心定向形状 "arrow", "wedge", 或 "triangle"

自定义 SVG 路径字符串（为确保正确大小，自定义形状路径应定义在一个方形边界框内，x 和 y 维度上的坐标范围从 -1 到 1。）

**默认值：** "circle"

size

  • 标记的默认大小。

  • 对于 point/circle/square，这表示标记的像素面积。请注意，此值设置的是符号的面积；边长将随此值的平方根增加。

  • 对于 bar，这表示条形的带大小，单位为像素。

对于 text，这表示字体大小，单位为像素。

  • 默认值

  • 30 用于点、圆、方形标记；width/height 的 step

  • 2 用于离散维度的条形标记；

  • 5 用于连续维度的条形标记；

11 用于文本标记。

smooth

一个布尔标志（默认为 true），指示图像在调整大小时是否应平滑。如果为 false，则应直接缩放单个像素而不是通过平滑插值。对于 SVG 渲染，此选项在某些浏览器中可能因缺乏标准化而无法工作。

startAngle

弧形标记的起始角度，单位为弧度。值为 0 表示向上（北），值增大表示顺时针方向。

stroke

默认填充颜色。此属性优先级高于 config.color。设置为 null 以移除填充。

默认描边颜色。此属性优先级高于 config.color。设置为 null 以移除描边。

strokeCap

线条结束风格的描边帽。可选值为 "butt", "round" 或 "square" 之一。

**默认值：** "butt"

strokeDash

用于创建虚线或点划线的描边、空间长度交替数组。

strokeDashOffset

开始绘制描边虚线数组的偏移量（单位为像素）。

strokeJoin

描边线连接方法。可选值为 "miter", "round" 或 "bevel" 之一。

**默认值：** "miter"

strokeMiterLimit

斜接线连接的斜接限制。

strokeOffset

绘制组描边和填充的像素偏移量。如果未指定，默认行为是动态偏移描边组，使得 1 像素描边宽度与像素网格对齐。

strokeOpacity

分箱字段的柱子间偏移量。理想值是 0（统计学家偏好）或 1（Vega-Lite 默认值，D3 示例风格）。

描边不透明度（值在 [0,1] 之间）。

strokeWidth

描边宽度，单位为像素。

tension

根据插值类型，设置张力参数（适用于线和面积标记）。

text

如果未指定 text 通道，则使用的占位符文本。

  • theta

  • 对于弧形标记，如果未指定 theta2，则为弧长（单位为弧度），否则为起始弧角。（值为 0 表示向上或“北”，值增大表示顺时针方向。）

对于文本标记，极坐标角度，单位为弧度。

theta2

弧形标记的结束角度，单位为弧度。值为 0 表示向上或“北”，值增大表示顺时针方向。

timeUnitBandPosition

时间单位的默认相对带位置。如果设置为 0，标记将定位在时间单位带步骤的开头。如果设置为 0.5，标记将定位在时间单位带步骤的中间。

timeUnitBandSize

时间单位的默认相对带大小。如果设置为 1，标记的带宽将等于时间单位带步骤。如果设置为 0.5，标记的带宽将是时间单位带步骤的一半。

tooltip

  • 鼠标悬停时显示的工具提示文本字符串，或定义应从哪些字段派生工具提示的对象。

  • 如果 tooltip 为 true 或 {"content": "encoding"}，则将使用 encoding 中的所有字段。

  • 如果 tooltip 为 {"content": "data"}，则将使用高亮数据显示点中出现的所有字段。

如果设置为 null 或 false，则不会使用工具提示。

有关 Vega-Lite 中工具提示的详细讨论，请参阅工具提示文档。

**默认值：** null

url

图像标记的图像文件 URL。

width

标记的宽度，或未指定 x2 或 width 的水平 "bar" 和 "area" 的宽度。

此通道的 value 可以是数字，也可以是表示图表宽度的字符串 "width"。

x2

范围 "area", "bar", "rect" 和 "rule" 的 X2 坐标。

y

x2

标记的 Y 坐标，或未指定 y2 或 height 的垂直 "bar" 和 "area" 的高度。

此通道的 value 可以是数字，也可以是表示图表高度的字符串 "height"。

y2

范围 "area", "bar", "rect" 和 "rule" 的 Y2 坐标。

__init__(*args, **kwargs)#

y2

方法

__init__(*args, **kwargs)

clear

copy()

fromkeys(iterable[, value])()

创建一个新字典，其中键来自 iterable，值设置为 value。

get(key[, default])

如果键在字典中，返回键的值，否则返回 default。

items

keys()

pop(key[, default])()

如果找不到键，并且给定 default，则返回 default；否则引发 KeyError。

popitem

删除并返回一个 (key, value) 对，作为 2 元组。(/)

setdefault(key[, default])

如果键不在字典中，则插入键，值为 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

属性()

上一页

altair.theme.AxisResolveMapKwds

下一页

altair.theme.BindCheckboxKwds

参数：

**注意：**范围标记*不*支持表达式引用。

文本的旋转角度，单位为度。

一个布尔标志，指示是否应包含 ARIA 属性（仅限 SVG 输出）。如果为 false，则输出的 SVG 元素上将设置 “aria-hidden” 属性，从而从 ARIA 可访问性树中移除标记项。

设置标记项的用户界面元素类型，用于 ARIA 可访问性（仅限 SVG 输出）。如果指定，此属性决定 “role” 属性。警告：此属性为实验性质，将来可能会更改。

标记项角色的易于人类阅读、作者本地化的描述，用于 ARIA 可访问性（仅限 SVG 输出）。如果指定，此属性决定 “aria-roledescription” 属性。警告：此属性为实验性质，将来可能会更改。

是否保持图像标记的宽高比。

对于范围标记，标记的垂直对齐方式。可选值为 "top", "middle", "bottom" 之一。

**默认值：** 1

__默认值：__ "source-over"

fill 和 stroke 属性的优先级高于 color，并将覆盖 color。

**默认值：** 5

**默认值：** 0

圆角矩形左下角的像素半径。

圆角矩形右下角的像素半径。

对于水平柱，右上角和右下角半径。

圆角矩形右上角的像素半径。

圆角矩形左上角的像素半径。

鼠标悬停在标记上时使用的光标。可以使用任何有效的 CSS 光标类型。

标记项的文本描述，用于 ARIA 可访问性（仅限 SVG 输出）。如果指定，此属性决定 “aria-label” 属性。

**默认值：** "ltr"

离散维度柱子的默认大小。如果未指定，默认大小为 step-2，这会在柱子之间提供 2 像素的偏移。

文本标签与其锚点之间的水平偏移量，单位为像素。偏移量在应用 angle 属性的旋转后应用。

文本标签与其锚点之间的垂直偏移量，单位为像素。偏移量在应用 angle 属性的旋转后应用。

**默认值：** "…"

弧形标记的结束角度，单位为弧度。值为 0 表示向上（北），值增大表示顺时针方向。

**默认值：** (无)

填充不透明度（值在 [0,1] 之间）。

**注意：**此属性不能用于 样式配置。

文本字体（例如，"Helvetica Neue"）。

**默认值：** 11

字体样式（例如，"italic"）。

字体粗细。可以是字符串（例如 "bold", "normal"）或数字（100, 200, 300, ..., 900，其中 "normal" = 400，"bold" = 700）。

标记的高度。

鼠标点击时加载的 URL。如果定义，标记将作为超链接。

弧形标记的内半径，单位为像素。innerRadius 是 radius2 的别名。

"monotone"：保持 y 单调性的三次插值。

**注意**：如果任何通道的刻度在 config.scale.invalid 中定义了无效值输出，则这些刻度的所有值都将被视为“有效”，因为它们可以为刻度生成合理的输出。因此，这些通道的字段不会被过滤，也不会导致路径中断。

**默认值：** 0 – 表示无限制

一个分隔符，例如换行符，用于将文本字符串分成多行。如果文本是数组值，此属性将被忽略。

多行文本标记的行高，单位为像素（后续文本行之间的间距）。

条形和矩形标记的最小带大小。**默认值：** 0.25

**默认值：** 对于带有 point, tick, circle 或 square 标记的非聚合图表或分层 bar 图表为 0.7，否则为 1。

对于线和轨迹标记，此 order 属性可以设置为 null 或 false，以使线条使用数据源中的原始顺序。

对于线和轨迹标记，如果未指定 config.sortLineBy，此属性决定了线中点的排序顺序。对于堆叠图表，这始终由堆叠的方向决定；因此，显式指定的值将被忽略。

弧形标记的外半径，单位为像素。outerRadius 是 radius 的别名。

应用于弧形两侧的角度填充，单位为弧度。

**默认值：** min(plot_width, plot_height)/2

弧形标记的次（内）半径，单位为像素。

**默认值：** "circle"

11 用于文本标记。

一个布尔标志（默认为 true），指示图像在调整大小时是否应平滑。如果为 false，则应直接缩放单个像素而不是通过平滑插值。对于 SVG 渲染，此选项在某些浏览器中可能因缺乏标准化而无法工作。

弧形标记的起始角度，单位为弧度。值为 0 表示向上（北），值增大表示顺时针方向。

默认描边颜色。此属性优先级高于 config.color。设置为 null 以移除描边。

**默认值：** "butt"

用于创建虚线或点划线的描边、空间长度交替数组。

开始绘制描边虚线数组的偏移量（单位为像素）。

**默认值：** "miter"

斜接线连接的斜接限制。

绘制组描边和填充的像素偏移量。如果未指定，默认行为是动态偏移描边组，使得 1 像素描边宽度与像素网格对齐。

描边不透明度（值在 [0,1] 之间）。

描边宽度，单位为像素。

根据插值类型，设置张力参数（适用于线和面积标记）。

如果未指定 text 通道，则使用的占位符文本。

对于文本标记，极坐标角度，单位为弧度。

弧形标记的结束角度，单位为弧度。值为 0 表示向上或“北”，值增大表示顺时针方向。

时间单位的默认相对带位置。如果设置为 0，标记将定位在时间单位带步骤的开头。如果设置为 0.5，标记将定位在时间单位带步骤的中间。

时间单位的默认相对带大小。如果设置为 1，标记的带宽将等于时间单位带步骤。如果设置为 0.5，标记的带宽将是时间单位带步骤的一半。

**默认值：** null

图像标记的图像文件 URL。

标记的宽度，或未指定 x2 或 width 的水平 "bar" 和 "area" 的宽度。

范围 "area", "bar", "rect" 和 "rule" 的 X2 坐标。

标记的 Y 坐标，或未指定 y2 或 height 的垂直 "bar" 和 "area" 的高度。

范围 "area", "bar", "rect" 和 "rule" 的 Y2 坐标。

在本页