altair.theme.OverlayMarkDefKwds#

class altair.theme.OverlayMarkDefKwds#

altair.OverlayMarkDef TypedDict 封装器。

参数:
align

文本或范围标记(区域、条形、图像、矩形、规则)的水平对齐方式。取值为 "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

对于范围标记,标记的垂直对齐方式。取值为 "top""middle""bottom"

注意: 范围标记支持表达式引用。

blend

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

__默认值:__ "source-over"

clip

标记是否裁剪到包含组的宽度和高度。

color

默认颜色。

默认值: "#4682b4"

注意

  • 此属性不能在样式配置中使用。

  • fillstroke 属性的优先级高于 color,并将覆盖 color

cornerRadius

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

默认值: 0

cornerRadiusBottomLeft

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

默认值: 0

cornerRadiusBottomRight

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

默认值: 0

cornerRadiusTopLeft

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

默认值: 0

cornerRadiusTopRight

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

默认值: 0

cursor

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

description

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

dir

文本的方向。取值为 "ltr"(从左到右)或 "rtl"(从右到左)之一。此属性决定了在响应限制参数时,文本从哪一侧被截断。

默认值: "ltr"

dx

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

dy

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

ellipsis

文本因限制参数被截断时使用的省略号字符串。

默认值: "…"

endAngle

弧形标记的结束角度,以弧度为单位。值为 0 表示向上(北),增加的值按顺时针方向进行。

fill

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

默认值: (无)

fillOpacity

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

默认值: 1

filled

标记的颜色是否应作为填充颜色而非描边颜色使用。

默认值: 对于所有 pointlinerule 标记以及 格网 数据源的 geoshape 标记为 false;否则为 true

注意: 此属性不能在样式配置中使用。

font

设置文本的字体(例如,"Helvetica Neue")。

fontSize

字体大小,以像素为单位。

默认值: 11

fontStyle

字体样式(例如,"italic")。

fontWeight

字体粗细。可以是字符串(例如 "bold""normal")或数字(100200300 等,"normal" = 400"bold" = 700)。

height

标记的高度。

href

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

innerRadius

弧形标记的内半径,以像素为单位。innerRadiusradius2 的别名。

默认值: 0

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,但使用张力参数来拉直样条。

  • "monotone":在 y 方向上保持单调性的三次插值。

invalid

无效数据模式,定义了标记和相应的比例如何表示无效值(连续比例尺中对无效值定义输出时的 nullNaN)。

  • "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

多行文本标记的行高,以像素为单位(后续文本行之间的间距)。

opacity

整体不透明度(值在 [0,1] 之间)。

默认值: 对于带有 pointtickcirclesquare 标记的非聚合图以及分层 bar 图表为 0.7,否则为 1

order

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

orient

非堆叠条形图、刻度图、区域图和线图的方向。取值可以是水平(默认)或垂直。

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

  • 对于区域,此属性决定了 Vega 输出的 orient 属性。

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

outerRadius

弧形标记的外半径,以像素为单位。outerRadiusradius 的别名。

默认值: 0

padAngle

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

radius

对于弧形标记,主(外)半径,以像素为单位。

对于文本标记,极坐标径向偏移,以像素为单位,文本相对于由 xy 属性确定的原点。

默认值: min(plot_width, plot_height)/2

radius2

弧形标记的副(内)半径,以像素为单位。

默认值: 0

radius2Offset

radius2 的偏移。

radiusOffset

radius 的偏移。

shape

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

  • 绘图形状:"circle""square""cross""diamond""triangle-up""triangle-down""triangle-right""triangle-left"

  • 线符号 "stroke"

  • 居中的方向形状 "arrow""wedge""triangle"

  • 自定义 SVG 路径字符串(为保证正确缩放,自定义形状路径应定义在一个以 -1 到 1 为 x 和 y 维度的方形边界框内。)

默认值: "circle"

size

标记的默认大小。

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

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

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

默认值

  • 30 用于 point, circle, square 标记;宽度/高度的 step

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

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

  • 11 用于文本标记。

smooth

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

startAngle

弧形标记的起始角度,以弧度为单位。值为 0 表示向上(北),增加的值按顺时针方向进行。

stroke

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

默认值: (无)

strokeCap

线末端样式的描边帽。取值为 "butt""round""square" 之一。

默认值: "butt"

strokeDash

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

strokeDashOffset

开始使用描边虚线数组绘制的偏移量(以像素为单位)。

strokeJoin

描边线连接方法。取值为 "miter""round""bevel" 之一。

默认值: "miter"

strokeMiterLimit

斜切线连接的斜接限制。

strokeOffset

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

strokeOpacity

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

默认值: 1

strokeWidth

描边宽度,以像素为单位。

style

一个字符串或字符串数组,指示应用于标记的自定义样式名称。样式是定义在样式配置中的标记属性默认值集合。如果 style 是数组,则后面的样式将覆盖前面的样式。encoding 中明确定义的任何标记属性将覆盖样式默认值。

默认值: 标记的名称。例如,bar 标记默认具有样式 "bar"注意: 任何指定的样式都将增强默认样式。例如,带有 "style": "foo" 的 bar 标记将从 config.style.barconfig.style.foo 继承(指定的样式 "foo" 具有更高的优先级)。

tension

根据插值类型,设置张力参数(用于线和区域标记)。

text

如果未指定 text 通道,则为占位符文本

theta
  • 对于弧形标记,如果未指定 theta2,则为弧长(以弧度为单位),否则为起始弧角。(值为 0 表示向上或“北”,增加的值按顺时针方向进行。)

  • 对于文本标记,为极坐标角度,以弧度为单位。

theta2

弧形标记的结束角度,以弧度为单位。值为 0 表示向上或“北”,增加的值按顺时针方向进行。

theta2Offset

theta2 的偏移。

thetaOffset

theta 的偏移。

timeUnitBandPosition

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

timeUnitBandSize

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

tooltip

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

  • 如果 tooltiptrue{"content": "encoding"},则将使用 encoding 中的所有字段。

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

  • 如果设置为 nullfalse,则不使用工具提示。

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

默认值: null

url

图像标记的图像文件 URL。

width

标记的宽度。

x

标记的 X 坐标,或者未指定 x2width 的水平 "bar""area" 的宽度。

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

x2

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

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

x2Offset

x2 位置的偏移。

xOffset

x 位置的偏移。

y

标记的 Y 坐标,或者未指定 y2height 的垂直 "bar""area" 的高度。

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

y2

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

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

y2Offset

y2 位置的偏移。

yOffset

y 位置的偏移。

__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()

属性

align

angle

aria

ariaRole

ariaRoleDescription

aspect

baseline

blend

clip

color

cornerRadius

cornerRadiusBottomLeft

cornerRadiusBottomRight

cornerRadiusTopLeft

cornerRadiusTopRight

cursor

description

dir

dx

dy

ellipsis

endAngle

fill

fillOpacity

filled

font

fontSize

fontStyle

fontWeight

height

href

innerRadius

interpolate

invalid

limit

lineBreak

lineHeight

opacity

order

orient

outerRadius

padAngle

radius

radius2

radius2Offset

radiusOffset

shape

size

smooth

startAngle

stroke

strokeCap

strokeDash

strokeDashOffset

strokeJoin

strokeMiterLimit

strokeOffset

strokeOpacity

strokeWidth

style

tension

text

theta

theta2

theta2Offset

thetaOffset

timeUnitBandPosition

timeUnitBandSize

tooltip

url

width

x

x2

x2Offset

xOffset

y

y2

y2Offset

yOffset