bokeh.transform#

用于应用客户端计算的辅助函数，例如对数据字段或 ColumnDataSource 表达式进行转换。

cumsum(field_name: str, include_zero: bool = False) → Expr[source]#

创建一个 DataSpec 字典，以生成 ColumnDataSource 的 CumSum 表达式。

参数：

  • field_name (str) – 用于配置 CumSum 的字段名

  • include_zero (bool, 可选) – 是否在总和中包含零 (默认值：False)

示例

p.wedge(start_angle=cumsum('angle', include_zero=True),
        end_angle=cumsum('angle'),
        ...)

将生成一个 CumSum 表达式，该表达式对数据源的 "angle" 列求和。对于 start_angle 值，累积和将从零值开始。对于 end_angle，不会添加初始零 (即和将从第一个角度值开始，并包括最后一个)。

dodge(field_name: str, value: float, range: Range | None = None) → Field[source]#

创建一个 DataSpec 字典，该字典将客户端 Dodge 转换应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • value (float) – 要添加到列数据的固定偏移量

  • range (Range, 可选) – 用于在必要时计算合成坐标的范围，例如当列数据是分类数据时的 FactorRange (默认值：None)

返回值：

Field

eqhist_cmap(field_name: str, palette: Sequence[ColorLike], low: float, high: float, low_color: ColorLike | None = None, high_color: ColorLike | None = None, nan_color: ColorLike = 'gray') → Field[source]#

创建一个 DataSpec 字典，该字典将客户端 EqHistColorMapper 转换应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • palette (seq[color]) – 用于颜色映射的颜色列表

  • low (float) – 用于映射到调色板的范围的最小值。低于此值的数值将被钳制为 low。

  • high (float) – 用于映射到调色板的范围的最大值。高于此值的数值将被钳制为 high。

  • low_color (color, optional) – 如果数据低于 low 值，则使用该颜色。如果为 None，则低于 low 的值将映射到调色板中的第一种颜色。（默认值：None）

  • high_color (color, optional) – 如果数据高于 high 值，则使用该颜色。如果为 None，则高于 high 的值将映射到调色板中的最后一种颜色。（默认值：None）

  • nan_color (color, optional) – 在映射来自列的数据时，如果映射失败，则使用默认颜色（默认值：“gray”）

factor_cmap(field_name: str, palette: Sequence[ColorLike], factors: Factors, start: float = 0, end: float | None = None, nan_color: ColorLike = 'gray') → Field[source]#

创建一个 DataSpec 字典，该字典将客户端 CategoricalColorMapper 转换应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • palette (seq[color]) – 用于颜色映射的颜色列表

  • factors (seq) – 与调色板相对应的分类因子的序列

  • start (int, optional) – 当列数据具有多级因子时，要应用的起始切片索引。（默认值：0）

  • end (int, optional) – 当列数据具有多级因子时，要应用的结束切片索引。（默认值：None）

  • nan_color (color, optional) – 在映射来自列的数据时，如果映射失败，则使用默认颜色（默认值：“gray”）

返回值：

Field

factor_hatch(field_name: str, patterns: Sequence[str], factors: Factors, start: float = 0, end: float | None = None) → Field[source]#

创建一个 DataSpec 字典，该字典将客户端 CategoricalPatternMapper 转换应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • patterns (seq[string]) – 要用于映射的阴影图案列表

  • factors (seq) – 与调色板相对应的分类因子的序列

  • start (int, optional) – 当列数据具有多级因子时，要应用的起始切片索引。（默认值：0）

  • end (int, optional) – 当列数据具有多级因子时，要应用的结束切片索引。（默认值：None）

返回值：

Field

在版本 1.1.1 中添加

factor_mark(field_name: str, markers: Sequence[str], factors: Factors, start: float = 0, end: float | None = None) → Field[source]#

创建一个 DataSpec 字典，该字典将客户端 CategoricalMarkerMapper 转换应用于 ColumnDataSource 列。

注意

此转换主要仅对 scatter 有用，scatter 可以由 glyph 类型参数化。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • markers (seq[string]) – 要用于映射的标记列表

  • factors (seq) – 与调色板相对应的分类因子的序列

  • start (int, optional) – 当列数据具有多级因子时，要应用的起始切片索引。（默认值：0）

  • end (int, optional) – 当列数据具有多级因子时，要应用的结束切片索引。（默认值：None）

返回值：

Field

jitter(field_name: str, width: float, mean: float = 0, distribution: JitterRandomDistributionType = 'uniform', range: Range | None = None) → Field[source]#

创建一个 DataSpec 字典，该字典将客户端 Jitter 转换应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • width (float) – 要应用的随机分布的宽度

  • mean (float, optional) – 要应用的偏移量（默认值：0）

  • distribution (str, optional) – "uniform" 或 "normal"（默认值："uniform"）

  • range (Range, 可选) – 用于在必要时计算合成坐标的范围，例如当列数据是分类数据时的 FactorRange (默认值：None)

返回值：

Field

linear_cmap(field_name: str, palette: Sequence[ColorLike], low: float, high: float, low_color: ColorLike | None = None, high_color: ColorLike | None = None, nan_color: ColorLike = 'gray') → Field[source]#

创建 DataSpec 字典，将客户端 LinearColorMapper 转换应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • palette (seq[color]) – 用于颜色映射的颜色列表

  • low (float) – 用于映射到调色板的范围的最小值。低于此值的数值将被钳制为 low。

  • high (float) – 用于映射到调色板的范围的最大值。高于此值的数值将被钳制为 high。

  • low_color (color, optional) – 如果数据低于 low 值，则使用该颜色。如果为 None，则低于 low 的值将映射到调色板中的第一种颜色。（默认值：None）

  • high_color (color, optional) – 如果数据高于 high 值，则使用该颜色。如果为 None，则高于 high 的值将映射到调色板中的最后一种颜色。（默认值：None）

  • nan_color (color, optional) – 在映射来自列的数据时，如果映射失败，则使用默认颜色（默认值：“gray”）

log_cmap(field_name: str, palette: Sequence[ColorLike], low: float, high: float, low_color: ColorLike | None = None, high_color: ColorLike | None = None, nan_color: ColorLike = 'gray') → Field[source]#

创建 DataSpec 字典，将客户端 LogColorMapper 转换应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 用于配置 DataSpec 的字段名

  • palette (seq[color]) – 用于颜色映射的颜色列表

  • low (float) – 用于映射到调色板的范围的最小值。低于此值的数值将被钳制为 low。

  • high (float) – 用于映射到调色板的范围的最大值。高于此值的数值将被钳制为 high。

  • low_color (color, optional) – 如果数据低于 low 值，则使用该颜色。如果为 None，则低于 low 的值将映射到调色板中的第一种颜色。（默认值：None）

  • high_color (color, optional) – 如果数据高于 high 值，则使用该颜色。如果为 None，则高于 high 的值将映射到调色板中的最后一种颜色。（默认值：None）

  • nan_color (color, optional) – 在映射来自列的数据时，如果映射失败，则使用默认颜色（默认值：“gray”）

stack(*fields: str) → Expr[source]#

创建 DataSpec 字典以生成 ColumnDataSource 的 Stack 表达式。

示例

p.vbar(bottom=stack("sales", "marketing"), ...

将生成一个 Stack，它将数据源的 "sales" 和 "marketing" 列相加，并使用这些值作为 VBar 的 top 坐标。

transform(field_name: str, transform: Transform) → Field[source]#

创建 DataSpec 字典，将任意的客户端 Transform 应用于 ColumnDataSource 列。

参数：

  • field_name (str) – 要配置 DataSpec 的字段名称

  • transform (Transform) – 要应用于该字段的转换

返回值：

Field