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, 可选) – 如果数据低于 low 值,则使用的颜色。如果为 None,则低于 low 的值将映射到调色板中的第一种颜色。(默认值: None)

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

  • nan_color (color, 可选) – 从列映射数据失败时使用的默认颜色 (默认值: “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, 可选) – 当列数据具有多级因子时应用的起始切片索引。(默认值: 0)

  • end (int, 可选) – 当列数据具有多级因子时应用的结束切片索引。(默认值: None)

  • nan_color (color, 可选) – 从列映射数据失败时使用的默认颜色 (默认值: “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, 可选) – 当列数据具有多级因子时应用的起始切片索引。(默认值: 0)

  • end (int, 可选) – 当列数据具有多级因子时应用的结束切片索引。(默认值: 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 可以通过字形类型进行参数化。

参数:
  • field_name (str) – 用于配置 DataSpec 的字段名称

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

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

  • start (int, 可选) – 当列数据具有多级因子时应用的起始切片索引。(默认值: 0)

  • end (int, 可选) – 当列数据具有多级因子时应用的结束切片索引。(默认值: 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, 可选) – 要应用的偏移量 (默认值: 0)

  • distribution (str, 可选) – "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, 可选) – 如果数据低于 low 值,则使用的颜色。如果为 None,则低于 low 的值将映射到调色板中的第一种颜色。(默认值: None)

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

  • nan_color (color, 可选) – 从列映射数据失败时使用的默认颜色 (默认值: “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, 可选) – 如果数据低于 low 值,则使用的颜色。如果为 None,则低于 low 的值将映射到调色板中的第一种颜色。(默认值: None)

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

  • nan_color (color, 可选) – 从列映射数据失败时使用的默认颜色 (默认值: “gray”)

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

创建一个 DataSpec 字典,用于为 ColumnDataSource 生成 Stack 表达式。

示例

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

将生成一个 Stack,该 Stack 对数据源的 "sales""marketing" 列求和,并将这些值用作 VBartop 坐标。

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

创建应用任意客户端 TransformColumnDataSource 列的 DataSpec 字典。

参数:
  • field_name (str) – 用于配置 DataSpec 的字段名称

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

返回值:

Field