网格#

用于在 Bokeh 图表上显示网格线的指南渲染器。

class Grid(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类: GuideRenderer

根据提供的 Ticker 显示水平或垂直网格线。

axis = None#

类型:: Nullable(Instance(Axis))

要委托刻度的轴。如果 ticker 属性为 None，则 Grid 将使用指定轴上的 ticker 来计算绘制网格线的位置。否则，如果 ticker 不为 None，则它将优先于任何轴。

band_fill_alpha = 0#

类型:: Alpha

网格线之间交替条带的填充 alpha 值。

band_fill_color = None#

类型:: Nullable(Color)

网格线之间交替条带的填充颜色。

band_hatch_alpha = 1.0#

类型:: Alpha

网格线之间交替条带的阴影 alpha 值。

band_hatch_color = 'black'#

类型:: Nullable(Color)

网格线之间交替条带的阴影颜色。

band_hatch_extra = {}#

类型:: Dict(String, Instance(Texture))

网格线之间交替条带的阴影额外属性。

band_hatch_pattern = None#

类型:: Nullable(String)

网格线之间交替条带的阴影图案。

band_hatch_scale = 12.0#

类型:: 大小

网格线之间交替条带的阴影比例。

band_hatch_weight = 1.0#

类型:: 大小

网格线之间交替条带的阴影粗细。

bounds = 'auto'#

类型:: Either(Auto, Tuple(Float, Float))

渲染网格线的边界。默认情况下，网格将查找相应的轴以请求边界。如果找不到，则网格将跨越整个可见范围。

context_menu = None#

类型:: Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键可显示本机上下文菜单。

cross_bounds = 'auto'#

类型:: Either(Auto, Tuple(Float, Float))

渲染网格线在正交方向上的边界。默认情况下，网格将跨越整个可见范围。

css_classes = []#

类型:: 列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}#

类型:: Dict(String, Instance(Node))

允许定义动态计算的 CSS 变量。

例如，这可以用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。

此处定义的变量等效于在 CSS 样式表中 :host { ... } 下设置相同的变量。

注意

此属性处于实验阶段，可能随时更改。

dimension = 0#

类型:: 整数

轴网格线将与之相交的维度。x 轴是维度 0（垂直网格线），y 轴是维度 1（水平网格线）。

grid_line_alpha = 1.0#

类型:: Alpha

网格线的线透明度。

grid_line_cap = 'butt'#

类型:: Enum(LineCap)

网格线的线帽。

grid_line_color = '#e5e5e5'#

类型:: Nullable(Color)

网格线的线颜色。

grid_line_dash = []#

类型:: 虚线图案

网格线的线虚线。

grid_line_dash_offset = 0#

类型:: 整数

网格线的线虚线偏移量。

grid_line_join = 'bevel'#

类型:: Enum(LineJoin)

网格线的线连接。

grid_line_width = 1#

类型:: 浮点数

网格线的线宽。

group = None#

类型:: Nullable(Instance(RendererGroup))

注意

此属性处于实验阶段，可能随时更改。

level = 'underlay'#

类型:: Enum(RenderLevel)

指定绘制此渲染器的级别。

minor_grid_line_alpha = 1.0#

类型:: Alpha

次要网格线的线透明度。

minor_grid_line_cap = 'butt'#

类型:: Enum(LineCap)

次要网格线的线帽。

minor_grid_line_color = None#

类型:: Nullable(Color)

次要网格线的线颜色。

minor_grid_line_dash = []#

类型:: 虚线图案

次要网格线的线虚线。

minor_grid_line_dash_offset = 0#

类型:: 整数

次要网格线的线虚线偏移量。

minor_grid_line_join = 'bevel'#

类型:: Enum(LineJoin)

次要网格线的线连接。

minor_grid_line_width = 1#

类型:: 浮点数

次要网格线的线宽。

name = None#

类型:: Nullable(String)

此模型的任意用户提供的名称。

查询文档以检索特定 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不保证任何提供的名称的唯一性或其他条件，并且 Bokeh 不会出于任何原因直接使用该名称。

propagate_hover = False#

类型:: 布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

此属性处于实验阶段，可能随时更改。

styles = {}#

类型:: Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#

类型:: 列表

要用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 的组件都使用影子 DOM，因此任何包含的样式表都必须反映这一点，例如使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True#

类型:: 布尔值

指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。在处理经常更新的对象（我们不需要其更新的值）时，将其设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端回调仍然可以工作。

tags = []#

类型:: 列表

要附加到此模型的一系列可选的任意用户提供的值。

查询文档以检索特定 Bokeh 模型时，此数据很有用。

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者，这仅仅是一种方便的方式，可以将任何必要的元数据附加到模型，这些元数据可以通过 CustomJS 回调等访问。

注意

不保证任何提供的标签的唯一性或其他条件，并且 Bokeh 不会出于任何原因直接使用这些标签。

ticker = None#

类型:: Nullable(Instance(Ticker))

用于计算网格线位置的刻度器。

visible = True#

类型:: 布尔值

渲染器是否可见。

x_range_name = 'default'#

类型:: 字符串

用于在绘图上渲染 Glyph 时计算屏幕位置的特定（命名）x 范围。如果未设置，则使用默认 x 范围。

y_range_name = 'default'#

类型:: 字符串

用于在绘图上渲染 Glyph 时计算屏幕位置的特定（命名）y 范围。如果未设置，则使用默认 y 范围。

apply_theme(property_values: dict[str, Any]) → None#

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传入的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应该修改它）。

参数：: property_values (dict) – 用于代替默认值的主题值
返回值：: 无

classmethod clear_extensions() → None#

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self#

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]#

收集此类中所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包含在任何父类上定义的属性。

返回值：: DataSpec 属性的名称
返回类型：: set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#: 属性描述符列表，按定义顺序排列。

destroy() → None#: 清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

参数：: other (HasProps) – 要比较的另一个实例
返回值：: 如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None#

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，它简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，无论何时另一个属性更改值。

参数：

attr (str) – 此模型上 Bokeh 属性的名称
other (Model) – 要链接到 self.attr 的 Bokeh 模型
other_attr (str) – other 上要链接在一起的属性
attr_selector (int | str) – 用于链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发：: ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到图表的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None#

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则会自动在其前面加上 "change:" 前缀。

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可以用来响应。例如，要在一个回调中运行，无论何时数据流式传输到 ColumnDataSource，请在源上使用 "stream" 事件。

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

在类中查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数：

name (str) – 要查找的属性的名称
raises (bool) – 如果缺少属性，是否抛出异常或返回 None

返回值：

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None#

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数：

attr (str) – 此对象上的属性名称
*callbacks (callable) – 要注册的回调函数

返回值：

无

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

当此模型上发生指定的事件时运行回调。

并非所有模型都支持所有事件。有关哪些模型能够触发哪些事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]#

生成适合从 Glyph 派生的函数的 Python Parameter 值。

返回值：: list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]#

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值：: 属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]#

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包含在任何父类上定义的属性。

返回值：: 具有引用的属性的名称
返回类型：: set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

收集一个字典，将属性名称映射到其值。

此方法始终遍历类层次结构，并包含在任何父类上定义的属性。

不可序列化的属性会被跳过，并且属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回重新构建对象实例所需的信息，以实现无损恢复。

参数：: include_defaults (bool, 可选) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）
返回值：: 属性名称到其值的映射
返回类型：: 字典

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

使用谓词查询HasProps实例的属性值。

参数：

query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False
include_defaults (bool, 可选) – 是否包含用户未显式设置的属性（默认值：True）

返回值：

匹配属性的属性名称和值的映射

返回类型：

字典

references() → set[Model]#: 返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: 从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]#

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数：: selector (类似 JSON 的)
返回值：: Model 序列

select_one(selector: SelectorType) → Model | None#

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: 类似 JSON 的

返回值：: Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

根据 JSON 设置此对象上的属性值。

参数：

name (str) – 要设置的属性的名称
value (JSON 值) – 要设置为属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止 Bokeh 应用程序的“回弹”更新。

在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知。会话可以将事件设置器与其自身进行比较，并抑制任何源自自身的更新。

返回值：

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数：

selector (类似 JSON 的)
updates (dict)

返回值：

无

themed_values() → dict[str, Any] | None#

获取任何主题提供的覆盖。

结果以字典形式返回，键为属性名称，值为属性值；如果主题未覆盖此实例的任何值，则返回 None。

返回值：: 字典或 None

to_serializable(serializer: Serializer) → ObjectRefRep#: 将此对象转换为可序列化表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#

unapply_theme() → None#

移除任何主题值并恢复默认值。

返回值：: 无

update(**kwargs: Any) → None#

根据给定的关键字参数更新对象的属性。

返回值：: 无

示例

以下等价

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None#: 此模型所附加的 Document（可以是 None）