altair.theme.AxisConfigKwds

class altair.theme.AxisConfigKwds

altair.AxisConfig TypedDict 包装器。

参数:

aria

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

默认值: true

bandPosition

一个插值分数，指示对于 band 比例尺，轴刻度应放置在哪里。值为 0 时，刻度放置在频带的左边缘。值为 0.5 时，刻度放置在频带的中间。

默认值: 0.5

description

此轴的文本描述，用于 ARIA 可访问性（仅限 SVG 输出）。如果 aria 属性为 true，则对于 SVG 输出，将 “aria-label”属性设置为此描述。如果未指定描述，则会自动生成。

disable

默认禁用轴。

domain

一个布尔标志，指示是否应将域（轴基线）包含在轴中。

默认值: true

domainCap

域线结束样式的描边端点样式。可选值为 "butt"、"round" 或 "square"`。

默认值: "butt"

domainColor

轴域线的颜色。

默认值: "gray"`。

domainDash

虚线域线的交替 [描边，间距] 长度数组。

domainDashOffset

开始绘制域虚线数组的像素偏移量。

domainOpacity

轴域线的透明度。

domainWidth

轴域线的描边宽度

默认值: 1

format

与默认的 "number" 和 "time" 格式类型一起使用时，这是指南（轴、图例、标题）和文本标记标签的文本格式模式。

• 如果格式类型是 "number"（例如，对于定量字段），这是 D3 的数字格式模式。

• 如果格式类型是 "time"（例如，对于时间字段），这是 D3 的时间格式模式。

更多示例请参见格式文档。

与自定义格式类型一起使用时，此值将作为 format 与 datum.value 一起传递给注册的函数。

默认值: 数字格式派生自numberFormat配置，时间格式派生自timeFormat配置。

formatType

标签的格式类型。可选值为 "number"、"time" 或注册的自定义格式类型。

默认值

• 对于时间字段以及带有 timeUnit 的有序字段和标称字段，默认值为 "time"`。

• 对于定量字段以及不带 timeUnit 的有序字段和标称字段，默认值为 "number"`。

grid

一个布尔标志，指示网格线是否应包含在轴中

默认值: 对于非分箱的连续比例尺为 true；否则为 false。

gridCap

网格线结束样式的描边端点样式。可选值为 "butt"、"round" 或 "square"`。

默认值: "butt"

gridColor

网格线的颜色。

默认值: "lightGray"`。

gridDash

虚线网格线的交替 [描边，间距] 长度数组。

gridDashOffset

开始绘制网格虚线数组的像素偏移量。

gridOpacity

网格的描边透明度（值介于 [0,1] 之间）

默认值: 1

gridWidth

网格的宽度，以像素为单位。

默认值: 1

labelAlign

轴刻度标签的水平文本对齐方式，覆盖当前轴方向的默认设置。

labelAngle

轴标签的旋转角度。

默认值: 对于标称和有序字段为 -90；否则为 0。

labelBaseline

轴刻度标签的垂直文本基线，覆盖当前轴方向的默认设置。可选值为 "alphabetic"（默认）、"top"、"middle"、"bottom"、"line-top" 或 "line-bottom"`。值 "line-top" 和 "line-bottom" 的操作类似于 "top" 和 "bottom"`，但计算时是相对于 lineHeight 而不是单独的 fontSize。

labelBound

指示标签超出轴范围时是否应隐藏。如果为 false（默认），则不执行边界重叠分析。如果为 true，则如果标签超出轴范围超过 1 像素，则隐藏标签。如果此属性为数字，则指定像素容差：标签边界框可能超出轴范围的最大量。

默认值: false`。

labelColor

刻度标签的颜色，可以是十六进制颜色代码或常规颜色名称。

labelExpr

用于自定义标签的Vega 表达式。

注意: 标签文本和值可以通过轴后端 datum 对象的 label 和 value 属性进行访问。

labelFlush

指示第一个和最后一个轴标签是否应与比例尺范围齐平对齐。水平轴的齐平对齐将左对齐第一个标签，右对齐最后一个标签。对于垂直轴，则应用底部和顶部文本基线。如果此属性为数字，它还指示偏移第一个和最后一个标签的像素数；例如，值为 2 会齐平对齐第一个和最后一个标签，并将其从轴中心向外推 2 像素。额外的调整有时可以帮助标签在视觉上更好地与相应的轴刻度分组。

默认值: 对于连续 x 比例尺的轴为 true。否则为 false`。

labelFlushOffset

指示偏移齐平调整标签的像素数。例如，值为 2 会将齐平调整标签从轴中心向外推 2 像素。偏移可以帮助标签在视觉上更好地与相应的轴刻度分组。

默认值: 0`。

labelFont

刻度标签的字体。

labelFontSize

标签的字体大小，以像素为单位。

labelFontStyle

标题的字体样式。

labelFontWeight

轴刻度标签的字体粗细。

labelLimit

轴刻度标签的最大允许像素宽度。

默认值: 180

labelLineHeight

多行标签文本或带有 "line-top" 或 "line-bottom" 基线的标签文本的行高，以像素为单位。

labelOffset

除了 tickOffset 外，应用于标签的像素位置偏移。

默认值: 0

labelOpacity

标签的透明度。

labelOverlap

用于解决轴标签重叠的策略。如果为 false（默认），则不尝试减少重叠。如果设置为 true 或 "parity"，则使用每隔一个标签删除的策略（这对于标准线性轴很有效）。如果设置为 "greedy"，则对标签进行线性扫描，移除与最后一个可见标签重叠的任何标签（这通常对对数比例轴更有效）。

默认值: 对于非对数比例尺的非标称字段为 true；对于对数比例尺为 "greedy"；否则为 false`。

labelPadding

标签和刻度之间的像素间距。

默认值: 2

labelSeparation

标签边界框之间必须存在的最小间隔才能被视为不重叠（默认 0`）。如果未启用 labelOverlap 分辨率，则忽略此属性。

labels

一个布尔标志，指示标签是否应包含在轴中。

默认值: true`。

maxExtent

轴刻度线和标签应使用的最大像素范围。这决定了轴标题的最大偏移值。

默认值: undefined`。

minExtent

轴刻度线和标签应使用的最小像素范围。这决定了轴标题的最小偏移值。

默认值: 对于 y 轴为 30；对于 x 轴为 undefined。

offset

轴相对于包含组或数据矩形边缘的偏移量，以像素为单位。

默认值: 派生自轴配置的 offset（默认为 0）。

orient

轴的方向。可选值为 "top"、"bottom"、"left" 或 "right"`。方向可用于进一步指定轴类型（例如，朝向图表右边缘的 y 轴）。

默认值: 对于 x 轴为 "bottom"，对于 y 轴为 "left"`。

position

轴的锚点位置，以像素为单位。对于具有顶部或底部方向的 x 轴，这设置轴组的 x 坐标。对于具有左侧或右侧方向的 y 轴，这设置轴组的 y 坐标。

默认值: 0

style

一个字符串或字符串数组，指示应用于轴的自定义样式名称。样式是在样式配置中定义的轴属性的命名集合。如果 style 是一个数组，则后面的样式将覆盖前面的样式。

默认值:（无）注意: 任何指定的样式都将增强默认样式。例如，带有 "style": "foo" 的 x 轴标记将使用 config.axisX 和 config.style.foo（指定的样式 "foo" 具有更高的优先级）。

tickBand

对于频带比例尺，指示刻度线和网格线是应放置在频带的 "center"（默认）还是频带的“范围”以指示间隔

tickCap

刻度线结束样式的描边端点样式。可选值为 "butt"、"round" 或 "square"`。

默认值: "butt"

tickColor

轴刻度线的颜色。

默认值: "gray"

tickCount

所需的刻度数量，适用于可视化定量比例尺的轴。结果数量可能不同，以便值是“好的”（2、5、10 的倍数）并位于底层比例尺的范围内。

对于类型为 "time" 或 "utc" 的比例尺，刻度计数可以是一个时间间隔指定符。合法的字符串值有 "millisecond"、"second"、"minute"、"hour"、"day"、"week"、"month" 和 "year"`。或者，一个对象值的时间间隔指定符形式 {"interval": "month", "step": 3} 包含所需的间隔步数。在此，将为每个季度边界（一月、四月、七月、十月）生成刻度。

默认值: 对于 x 使用公式 ceil(width/40) 确定，对于 y 使用 ceil(height/40) 确定。

tickDash

虚线刻度线标记的交替 [描边，间距] 长度数组。

tickDashOffset

开始绘制刻度线标记虚线数组的像素偏移量。

tickExtra

布尔标志，指示是否应为轴的初始位置添加额外的轴刻度。此标志对于设置 band 比例尺的轴样式很有用，以便刻度线放置在频带边界而不是频带中间。与 "bandPosition": 1 和轴 "padding" 值 0 结合使用。

tickMinStep

轴刻度之间的最小期望步长，以比例尺域值为单位。例如，值 1 表示刻度之间的距离不应小于 1 个单位。如果指定了 tickMinStep，则将在必要时调整 tickCount 值，以强制执行最小步长值。

tickOffset

应用于刻度、标签和网格线的像素位置偏移。

tickOpacity

刻度线的透明度。

tickRound

布尔标志，指示像素位置值是否应四舍五入到最接近的整数。

默认值: true

tickSize

轴刻度线的大小，以像素为单位。

默认值: 5

tickWidth

刻度线的宽度，以像素为单位。

默认值: 1

ticks

布尔值，确定轴是否应包含刻度。

默认值: true

title

字段的标题。如果为 null，则移除标题。

默认值: 派生自字段名称和转换函数（aggregate、bin 和 timeUnit`）。如果字段具有聚合函数，则该函数会作为标题的一部分显示（例如，"Sum of Profit"`）。如果字段已分箱或应用了时间单位，则应用的函数会显示在括号中（例如，"Profit (binned)"、"Transaction Date (year-month)"`）。否则，标题仅为字段名称。

注意:

1) 您可以通过在config中提供 fieldTitle 属性或通过 compile 函数的选项提供 fieldTitle 函数来定制默认字段标题格式。

2) 如果同时定义了字段定义的 title 和轴、标题或图例的 title，则将使用轴/标题/图例的标题。

titleAlign

轴标题的水平文本对齐方式。

titleAnchor

放置轴标题的文本锚点位置。

titleAngle

轴标题的角度，以度为单位。

titleBaseline

轴标题的垂直文本基线。可选值为 "alphabetic"（默认）、"top"、"middle"、"bottom"、"line-top" 或 "line-bottom"`。值 "line-top" 和 "line-bottom" 的操作类似于 "top" 和 "bottom"`，但计算时是相对于 lineHeight 而不是单独的 fontSize。

titleColor

标题的颜色，可以是十六进制颜色代码或常规颜色名称。

titleFont

标题的字体。（例如，"Helvetica Neue"`）。

titleFontSize

标题的字体大小。

titleFontStyle

标题的字体样式。

titleFontWeight

标题的字体粗细。这可以是字符串（例如 "bold"、"normal"`）或数字（100、200、300、……、900，其中 "normal" = 400，"bold" = 700`）。

titleLimit

轴标题的最大允许像素宽度。

titleLineHeight

多行标题文本或带有 "line-top" 或 "line-bottom" 基线的标题文本的行高，以像素为单位。

titleOpacity

轴标题的透明度。

titlePadding

标题和轴之间的像素间距。

titleX

轴标题相对于轴组的 X 坐标。

titleY

轴标题相对于轴组的 Y 坐标。

translate

轴布局的坐标空间平移偏移量。默认情况下，轴在 x 和 y 坐标上平移 0.5 像素的偏移量，以便使描边线与像素网格对齐。但是，对于矢量图形输出，这些像素特定的调整可能不受欢迎，在这种情况下可以更改 translate（例如，更改为零）。

默认值: 0.5

values

明确设置可见的轴刻度值。

zindex

一个非负整数，指示轴的 z-index。如果 zindex 为 0，则轴应绘制在所有图表元素后面。要将其放在前面，请将 zindex 设置为 1 或更大。

默认值: 0（在标记后面）。

__init__(*args, **kwargs)

方法

__init__(*args, **kwargs)
clear()
copy()
fromkeys(iterable[, value])	创建一个新字典，其键来自 iterable，值设置为 value。
get(key[, default])	如果 key 在字典中，则返回 key 的值，否则返回 default。
items()
keys()
pop(key[, default])	如果未找到 key，则返回 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()

属性

aria
bandPosition
description
disable
domain
domainCap
domainColor
domainDash
domainDashOffset
domainOpacity
domainWidth
format
formatType
grid
gridCap
gridColor
gridDash
gridDashOffset
gridOpacity
gridWidth
labelAlign
labelAngle
labelBaseline
labelBound
labelColor
labelExpr
labelFlush
labelFlushOffset
labelFont
labelFontSize
labelFontStyle
labelFontWeight
labelLimit
labelLineHeight
labelOffset
labelOpacity
labelOverlap
labelPadding
labelSeparation
labels
maxExtent
minExtent
offset
orient
position
style
tickBand
tickCap
tickColor
tickCount
tickDash
tickDashOffset
tickExtra
tickMinStep
tickOffset
tickOpacity
tickRound
tickSize
tickWidth
ticks
title
titleAlign
titleAnchor
titleAngle
titleBaseline
titleColor
titleFont
titleFontSize
titleFontStyle
titleFontWeight
titleLimit
titleLineHeight
titleOpacity
titlePadding
titleX
titleY
translate
zindex