Mix-in classes that bulk add groups of properties to Bokeh models.
Some groups of properties often show up in Bokeh models together. For instance, any model that exposes a fill color property for use when rendering will almost always want to expose a fill alpha as well. To reduce boilerplate code and simplify defining models with these sets of properties, use the mix-in classes in this module:
FillProps — properties for fill color and alpha
FillProps
HatchProps — properties for hatching pattern, color, alpha, etc.
HatchProps
LineProps — properties for line color, dashing, width, etc.
LineProps
TextProps — properties for text color, font, etc.
TextProps
To include these properties in a Bokeh model, use the Include property as shown here:
Include
class SomeGlyph(Glyph): fill_props = Include(FillProps, use_prefix=False, help=""" The %s values for the annular wedges. """)
This adds all the fill properties fill_color and fill_alpha to this model with one simple statement. Note that the help string contains a placeholder format %s. When docs for this class are rendered by the bokeh_model Sphinx extension, the placeholder will be replaced with more information specific to each property. The setting use_prefix means that the names of the properties added to SomeGlyph are exactly fill_alpha and fill_color. Some situations require a different usage, for more information see the docs for Include.
fill_color
fill_alpha
use_prefix
SomeGlyph
Properties relevant to rendering fill regions.
Mirrors the BokehJS properties.FillVector class.
properties.FillVector
AlphaSpec
1.0
An alpha value to use to fill paths with.
Acceptable values are numbers in 0..1 range (transparent..opaque).
ColorSpec
'gray'
A color to use to fill paths with.
Acceptable values are: any of the named CSS colors, e.g 'green', 'indigo' RGB(A) hex strings, e.g., '#FF0000', '#44444444' CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' a 3-tuple of integers (r, g, b) between 0 and 255 a 4-tuple of (r, g, b, a) where r, g, b are integers between 0..255 and a is between 0..1 a 32-bit unsiged integers using the 0xRRGGBBAA byte order pattern
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
'green'
'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
'#FF0000'
'#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)'
'rgba(255, 0, 127, 0.6)'
'rgb(0 127 0 / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0..255 and a is between 0..1
a 32-bit unsiged integers using the 0xRRGGBBAA byte order pattern
Mirrors the BokehJS properties.HatchVector class.
properties.HatchVector
hatch_alpha
An alpha value to use to hatching with.
hatch_color
'black'
A color to use to hatching with.
hatch_pattern
HatchPatternSpec
None
Built-in patterns are can either be specified as long names:
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
or as one-letter abbreviations:
‘ ‘, ‘.’, ‘o’, ‘-‘, ‘|’, ‘+’, ‘”’, ‘:’, ‘@’, ‘/’, ‘\’, ‘x’, ‘,’, ‘`’, ‘v’, ‘>’, ‘*’
hatch_scale
NumberSpec
12.0
A rough measure of the ‘size’ of the hatching pattern. Generally speaking, the higher the number, the more spread out the pattern will be.
hatch_weight
A width value for line-strokes used in hatching.
Properties relevant to rendering path operations.
Mirrors the BokehJS properties.LineVector class.
properties.LineVector
line_alpha
An alpha value to use to stroke paths with.
line_cap
LineCapSpec
'butt'
How path segments should be terminated.
'round'
'square'
line_color
A color to use to stroke paths with.
line_dash
DashPatternSpec
[]
How should the line be dashed.
line_dash_offset
IntSpec
0
The distance into the line_dash (in pixels) that the pattern should start from.
line_join
LineJoinSpec
'bevel'
How path segments should be joined together.
'miter'
line_width
1
Stroke width in units of pixels.
ScalarFillProps
Mirrors the BokehJS properties.Fill class.
properties.Fill
Alpha
An alpha value to use to %s with.
Acceptable values are floating-point numbers between 0 and 1 (0 being transparent and 1 being opaque).
Nullable(Color)
Nullable
Color
ScalarHatchProps
Mirrors the BokehJS properties.Hatch class.
properties.Hatch
Nullable(String)
String
Size
ScalarLineProps
Mirrors the BokehJS properties.Line class.
properties.Line
Enum(LineCap)
Enum
LineCap
DashPattern
Int
Enum(LineJoin)
LineJoin
Float
ScalarTextProps
Properties relevant to rendering text.
Mirrors the BokehJS properties.Text class.
properties.Text
Note
There is currently only support for filling text. An interface to stroke the outlines of text has not yet been exposed.
text_align
Enum(TextAlign)
TextAlign
'left'
Horizontal anchor point to use when rendering text.
'right'
'center'
text_alpha
An alpha value to use to fill text with.
text_baseline
Enum(TextBaseline)
TextBaseline
'bottom'
Vertical anchor point to use when rendering text.
'top'
'middle'
'alphabetic'
'hanging'
'ideographic'
text_color
'#444444'
A color to use to fill text with.
text_font
'helvetica'
Name of a font to use for rendering text, e.g., 'times', 'helvetica'.
'times'
text_font_style
Enum(FontStyle)
FontStyle
'normal'
A style to use for rendering text.
'normal' normal text
'italic' italic text
'italic'
'bold' bold text
'bold'
"bold italic" *bold italic text*
"bold italic"
text_line_height
1.2
In multi-line text, how much additional space should be allocated for each line. The value is provided as a number, but should be treated as a percentage of font size. The default is 120%. Setting it to 1.0, so 100%, means no additional space will be used.
Mirrors the BokehJS properties.TextVector class.
properties.TextVector
TextAlignSpec
TextBaselineSpec
StringSpec
{'value': 'helvetica'}
FontStyleSpec