HexTile

class HexTile(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Glyph, LineGlyph, FillGlyph, HatchGlyph

Render horizontal tiles on a regular hexagonal grid.

Example

from bokeh.io import curdoc, show
from bokeh.models import ColumnDataSource, Grid, HexTile, LinearAxis, Plot

source = ColumnDataSource(dict(
        q=[0,  0, -1, -1,  1, 1, 0],
        r=[0, -1,  0,  1, -1, 0, 1],
    ),
)

plot = Plot(
    title=None, width=300, height=300,
    min_border=0, toolbar_location=None)

glyph = HexTile(q="q", r="r", size=1, fill_color="#fb9a99", line_color="white")
plot.add_glyph(source, glyph)

xaxis = LinearAxis()
plot.add_layout(xaxis, 'below')

yaxis = LinearAxis()
plot.add_layout(yaxis, 'left')

plot.add_layout(Grid(dimension=0, ticker=xaxis.ticker))
plot.add_layout(Grid(dimension=1, ticker=yaxis.ticker))

curdoc().add_root(plot)

show(plot)

JSON Prototype

{
  "aspect_scale": 1.0, 
  "decorations": [], 
  "fill_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "fill_color": {
    "type": "value", 
    "value": "gray"
  }, 
  "hatch_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "hatch_color": {
    "type": "value", 
    "value": "black"
  }, 
  "hatch_extra": {
    "type": "map"
  }, 
  "hatch_pattern": {
    "type": "value", 
    "value": null
  }, 
  "hatch_scale": {
    "type": "value", 
    "value": 12.0
  }, 
  "hatch_weight": {
    "type": "value", 
    "value": 1.0
  }, 
  "id": "p59752", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "line_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "line_cap": {
    "type": "value", 
    "value": "butt"
  }, 
  "line_color": {
    "type": "value", 
    "value": null
  }, 
  "line_dash": {
    "type": "value", 
    "value": []
  }, 
  "line_dash_offset": {
    "type": "value", 
    "value": 0
  }, 
  "line_join": {
    "type": "value", 
    "value": "bevel"
  }, 
  "line_width": {
    "type": "value", 
    "value": 1
  }, 
  "name": null, 
  "orientation": "pointytop", 
  "q": {
    "field": "q", 
    "type": "field"
  }, 
  "r": {
    "field": "r", 
    "type": "field"
  }, 
  "scale": {
    "type": "value", 
    "value": 1.0
  }, 
  "size": 1.0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

aspect_scale = 1.0

Type:

Float

Match a plot’s aspect ratio scaling.

Use this parameter to match the aspect ratio scaling of a plot when using aspect_scale with a value other than 1.0.

decorations = []

Type:

List

A collection of glyph decorations, e.g. arrow heads.

Use GlyphRenderer.add_decoration() for easy setup for all glyphs of a glyph renderer. Use this property when finer control is needed.

Note

Decorations are only for aiding visual appearance of a glyph, but they don’t participate in hit testing, etc.

fill_alpha = 1.0

Type:

AlphaSpec

The fill alpha values for the hex tiles.

fill_color = 'gray'

Type:

ColorSpec

The fill color values for the hex tiles.

hatch_alpha = 1.0

Type:

AlphaSpec

The hatch alpha values for the hex tiles.

hatch_color = 'black'

Type:

ColorSpec

The hatch color values for the hex tiles.

hatch_extra = {}

Type:

Dict(String, Instance(Texture))

The hatch extra values for the hex tiles.

hatch_pattern = None

Type:

HatchPatternSpec

The hatch pattern values for the hex tiles.

hatch_scale = 12.0

Type:

FloatSpec

The hatch scale values for the hex tiles.

hatch_weight = 1.0

Type:

FloatSpec

The hatch weight values for the hex tiles.

line_alpha = 1.0

Type:

AlphaSpec

The line alpha values for the hex tiles.

line_cap = 'butt'

Type:

LineCapSpec

The line cap values for the hex tiles.

line_color = None

Type:

ColorSpec

The line color values for the hex tiles.

line_dash = []

Type:

DashPatternSpec

The line dash values for the hex tiles.

line_dash_offset = 0

Type:

IntSpec

The line dash offset values for the hex tiles.

line_join = 'bevel'

Type:

LineJoinSpec

The line join values for the hex tiles.

line_width = 1

Type:

FloatSpec

The line width values for the hex tiles.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

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

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

orientation = 'pointytop'

Type:

Enum(HexTileOrientation)

The orientation of the hex tiles.

Use "pointytop" to orient the tile so that a pointed corner is at the top. Use "flattop" to orient the tile so that a flat side is at the top.

q = Field(field='q', transform=Unspecified, units=Unspecified)

Type:

NumberSpec

The “column” axial coordinates of the tile centers.

r = Field(field='r', transform=Unspecified, units=Unspecified)

Type:

NumberSpec

The “row” axial coordinates of the tile centers.

scale = 1.0

Type:

NumberSpec

A scale factor for individual tiles.

size = 1.0

Type:

Float

The radius (in data units) of the hex tiling.

The radius is always measured along the cartesian y-axis for “pointy_top” orientation, and along the cartesian x-axis for “flat_top” orientation. If the aspect ratio of the underlying cartesian system is not 1-1, then the tiles may be “squished” in one direction. To ensure that the tiles are always regular hexagons, consider setting the match_aspect property of the plot to True.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models

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

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

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

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link

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

is equivalent to the following

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

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range

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

which is equivalent to

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

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically

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

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source

source.js_on_change('streaming', callback)

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

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

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

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

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

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

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

Returns:

list(Parameter)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

具有引用的属性的名称

Return type:

set[str]

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

收集将属性名称映射到其值的字典。

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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

Parameters:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

Returns:

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

Return type:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

Returns:

Model

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

从 JSON 在此对象上设置属性值。

Parameters:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对 Bokeh 应用程序进行“回旋镖”更新。

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

Returns:

None

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

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

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

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

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

结果作为从属性名称到值的字典返回，如果没有任何主题覆盖此实例的任何值，则返回 None。

Returns:

dict 或 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

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

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

以下是等效的

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)