bokeh.core.property_mixins#

将一组属性批量添加到 Bokeh 模型的混合类。

一些属性组经常一起出现在 Bokeh 模型中。例如，任何暴露填充颜色属性以用于渲染的模型几乎总是会想要暴露填充 alpha 属性。为了减少样板代码并简化定义包含这些属性集的模型，请使用本模块中的混合类

  • FillProps — 填充颜色和 alpha 属性

  • HatchProps — 用于阴影图案、颜色、alpha 等的属性

  • ImageProps — 用于图像全局 alpha 的属性

  • LineProps — 用于线条颜色、虚线、宽度等的属性

  • TextProps — 用于文本颜色、字体等的属性

要将这些属性包含在 Bokeh 模型中，请使用 Include 属性，如以下示例所示

class SomeGlyph(Glyph):

    fill_props = Include(FillProps, help="""
    The {prop} values for the annular wedges.
    """)

这会将所有填充属性 fill_color 和 fill_alpha 添加到此模型中。帮助字符串包含一个占位符 {prop}。当此类的文档由 bokeh-model 指令渲染时，占位符将被替换为与每个属性相关的更多信息。

class FillProps(**properties: Any)[source]#

与渲染填充区域相关的属性。

映射 BokehJS properties.FillVector 类。

fill_alpha = 1.0#
类型:

AlphaSpec

用于填充路径的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

fill_color = 'gray'#
类型:

ColorSpec

用于填充路径的颜色。

可接受的值是

  • 任何 命名的 CSS 颜色，例如 'green'、'indigo'

  • RGB(A) 十六进制字符串，例如 '#FF0000'、'#44444444'

  • CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)'、'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

  • 0 到 255 之间的整数 3 元组 (r, g, b)

  • 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的整数

  • 使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

class HatchProps(**properties: Any)[source]#

与渲染填充区域相关的属性。

映射 BokehJS properties.HatchVector 类。

hatch_alpha = 1.0#
类型:

AlphaSpec

用于阴影的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

hatch_color = 'black'#
类型:

ColorSpec

用于阴影的颜色。

可接受的值是

  • 任何 命名的 CSS 颜色，例如 'green'、'indigo'

  • RGB(A) 十六进制字符串，例如 '#FF0000'、'#44444444'

  • CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)'、'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

  • 0 到 255 之间的整数 3 元组 (r, g, b)

  • 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的整数

  • 使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

hatch_pattern = None#
类型:

HatchPatternSpec

内置图案可以指定为长名称

blank, dot, ring, horizontal_line, vertical_line, cross, horizontal_dash, vertical_dash, spiral, right_diagonal_line, left_diagonal_line, diagonal_cross, right_diagonal_dash, left_diagonal_dash, horizontal_wave, vertical_wave, criss_cross

或作为单字母缩写

‘ ‘, ‘.’, ‘o’, ‘-’, ‘|’, ‘+’, ‘”’, ‘:’, ‘@’, ‘/’, ‘\’, ‘x’, ‘,’, ‘`’, ‘v’, ‘>’, ‘*’

hatch_scale = 12.0#
类型:

NumberSpec

用于大致衡量图案的“大小”。一般来说，数字越大，图案就越分散。

hatch_weight = 1.0#
类型:

NumberSpec

用于图案绘制的线条粗细值。

class ImageProps(**properties: Any)[source]#

与渲染图像相关的属性。

镜像 BokehJS properties.ImageVector 类。

global_alpha = 1.0#
类型:

AlphaSpec

用于图像的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

class LineProps(**properties: Any)[source]#

与渲染路径操作相关的属性。

镜像 BokehJS properties.LineVector 类。

line_alpha = 1.0#
类型:

AlphaSpec

用于描边路径的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

line_cap = 'butt'#
类型:

LineCapSpec

路径段的终止方式。

可接受的值是

  • 'butt' A line segment with no end cap extending beyond the explicit end coordinate.

  • 'round' A line segment with a rounded end cap extending beyond the explicit end coordinate.

  • 'square' A line segment with a squared end cap extending beyond the explicit end coordinate.

line_color = 'black'#
类型:

ColorSpec

用于描边路径的颜色。

可接受的值是

  • 任何 命名的 CSS 颜色，例如 'green'、'indigo'

  • RGB(A) 十六进制字符串，例如 '#FF0000'、'#44444444'

  • CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)'、'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

  • 0 到 255 之间的整数 3 元组 (r, g, b)

  • 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的整数

  • 使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

line_dash = []#
类型:

DashPatternSpec

线条的虚线方式。

line_dash_offset = 0#
类型:

IntSpec

虚线模式开始的距离（以像素为单位）。

line_join = 'bevel'#
类型:

LineJoinSpec

路径段的连接方式。

可接受的值是

  • 'miter' Two line segments joined with a miter (sharp-angle) join style.

  • 'round' Two line segments joined with a round join style.

  • 'bevel' Two line segments joined with a bevel (truncated) join style.

line_width = 1#
类型:

NumberSpec

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

class ScalarFillProps(**properties: Any)[source]#

与渲染填充区域相关的属性。

镜像 BokehJS properties.Fill 类。

fill_alpha = 1.0#
类型:

Alpha

用于填充路径的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

fill_color = 'gray'#
类型:

Nullable(Color)

用于填充路径的颜色。

class ScalarHatchProps(**properties: Any)[source]#

与渲染填充区域相关的属性。

镜像 BokehJS properties.Hatch 类。

hatch_alpha = 1.0#
类型:

Alpha

用于阴影的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

hatch_color = 'black'#
类型:

Nullable(Color)

用于阴影的颜色。

hatch_pattern = None#
类型:

Nullable(String)

内置图案可以指定为长名称

blank, dot, ring, horizontal_line, vertical_line, cross, horizontal_dash, vertical_dash, spiral, right_diagonal_line, left_diagonal_line, diagonal_cross, right_diagonal_dash, left_diagonal_dash, horizontal_wave, vertical_wave, criss_cross

或作为单字母缩写

‘ ‘, ‘.’, ‘o’, ‘-’, ‘|’, ‘+’, ‘”’, ‘:’, ‘@’, ‘/’, ‘\’, ‘x’, ‘,’, ‘`’, ‘v’, ‘>’, ‘*’

hatch_scale = 12.0#
类型:

大小

用于大致衡量图案的“大小”。一般来说，数字越大，图案就越分散。

hatch_weight = 1.0#
类型:

大小

用于图案绘制的线条粗细值。

class ScalarImageProps(**properties: Any)[source]#

与渲染图像相关的属性。

镜像 BokehJS properties.Image 类。

global_alpha = 1.0#
类型:

Alpha

用于图像的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

class ScalarLineProps(**properties: Any)[source]#

与渲染路径操作相关的属性。

镜像 BokehJS properties.Line 类。

line_alpha = 1.0#
类型:

Alpha

用于描边路径的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

line_cap = 'butt'#
类型:

Enum(LineCap)

路径段的终止方式。

可接受的值是

  • 'butt' A line segment with no end cap extending beyond the explicit end coordinate.

  • 'round' A line segment with a rounded end cap extending beyond the explicit end coordinate.

  • 'square' A line segment with a squared end cap extending beyond the explicit end coordinate.

line_color = 'black'#
类型:

Nullable(Color)

用于描边路径的颜色。

line_dash = []#
类型:

虚线图案

线条的虚线方式。

line_dash_offset = 0#
类型:

整数

虚线模式开始的距离（以像素为单位）。

line_join = 'bevel'#
类型:

Enum(LineJoin)

路径段的连接方式。

可接受的值是

  • 'miter' Two line segments joined with a miter (sharp-angle) join style.

  • 'round' Two line segments joined with a round join style.

  • 'bevel' Two line segments joined with a bevel (truncated) join style.

line_width = 1#
类型:

浮点数

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

class ScalarTextProps(**properties: Any)[source]#

与文本渲染相关的属性。

镜像 BokehJS properties.Text 类。

text_align = 'left'#
类型:

Enum(TextAlign)

渲染文本时使用的水平锚点。

可接受的值是

  • 'left'

  • 'right'

  • 'center'

text_alpha = 1.0#
类型:

Alpha

用于填充文本的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

渲染文本时使用的垂直锚点。

可接受的值是

  • 'top'

  • 'middle'

  • 'bottom'

  • 'alphabetic'

  • 'hanging'

  • 'ideographic'

text_color = '#444444'#
类型:

Nullable(Color)

用于填充文本的颜色。

text_font = 'helvetica'#
类型:

字符串

用于渲染文本的字体名称，例如 'times', 'helvetica'。

text_font_style = 'normal'#
类型:

Enum(FontStyle)

用于渲染文本的样式。

可接受的值是

  • 'normal' 正常文本

  • 'italic' 斜体文本

  • 'bold' 粗体文本

  • "bold italic" *粗体斜体文本*

text_line_height = 1.2#
类型:

浮点数

在多行文本中，每行应该分配多少额外空间。该值以数字形式提供，但应视为字体大小的百分比。默认值为 120%。将其设置为 1.0，即 100%，意味着不会使用任何额外空间。

text_outline_color = None#
类型:

Nullable(Color)

用于描绘文本轮廓的颜色。

class TextProps(**properties: Any)[source]#

与文本渲染相关的属性。

镜像 BokehJS properties.TextVector 类。

text_align = 'left'#
类型:

TextAlignSpec

渲染文本时使用的水平锚点。

可接受的值是

  • 'left'

  • 'right'

  • 'center'

text_alpha = 1.0#
类型:

AlphaSpec

用于填充文本的 alpha 值。

可接受的值是 0 到 1 之间的浮点数（0 代表透明，1 代表不透明）。

text_baseline = 'bottom'#
类型:

TextBaselineSpec

渲染文本时使用的垂直锚点。

可接受的值是

  • 'top'

  • 'middle'

  • 'bottom'

  • 'alphabetic'

  • 'hanging'

  • 'ideographic'

text_color = '#444444'#
类型:

ColorSpec

用于填充文本的颜色。

可接受的值是

  • 任何 命名的 CSS 颜色，例如 'green'、'indigo'

  • RGB(A) 十六进制字符串，例如 '#FF0000'、'#44444444'

  • CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)'、'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

  • 0 到 255 之间的整数 3 元组 (r, g, b)

  • 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的整数

  • 使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

text_font = Value(value='helvetica', transform=Unspecified, units=Unspecified)#
类型:

StringSpec

用于渲染文本的字体名称，例如 'times', 'helvetica'。

text_font_style = 'normal'#
类型:

FontStyleSpec

用于渲染文本的样式。

可接受的值是

  • 'normal' 正常文本

  • 'italic' 斜体文本

  • 'bold' 粗体文本

  • "bold italic" *粗体斜体文本*

text_line_height = 1.2#
类型:

NumberSpec

在多行文本中，每行应该分配多少额外空间。该值以数字形式提供，但应视为字体大小的百分比。默认值为 120%。将其设置为 1.0，即 100%，意味着不会使用任何额外空间。

text_outline_color = None#
类型:

ColorSpec

用于描绘文本轮廓的颜色。

可接受的值是

  • 任何 命名的 CSS 颜色，例如 'green'、'indigo'

  • RGB(A) 十六进制字符串，例如 '#FF0000'、'#44444444'

  • CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)'、'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

  • 0 到 255 之间的整数 3 元组 (r, g, b)

  • 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的整数

  • 使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数