U /eR@sdZddlmZddlZeeZddlmZm Z m Z m Z m Z m Z mZmZmZmZmZmZddlmZmZddlmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4ddl5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;mZ>dd l?m@Z@mAZAdd lBmCZCdd lDmEZEd dlFmGZGd dlHmIZImJZJd dlKmLZLd dlMmNZNmOZOd dlPmQZQmRZRd dlSmTZTdZUddZVddZWeGdddeOZXeGdddeXZYGdddeZZeGdd d eXeZZ[Gd!d"d"eCZ\Gd#d$d$eXZ]Gd%d&d&eXZ^Gd'd(d(eYZ_Gd)d*d*eXeZZ`Gd+d,d,eYZaGd-d.d.e[ZbGd/d0d0eYeZZcGd1d2d2eXZdGd3d4d4eXZeGd5d6d6eXeZZfGd7d8d8e[ZgGd9d:d:eXZhGd;d<dd>eXZjdS)?zN Renderers for various kinds of annotations that can be added to Bokeh plots ) annotationsN) Anchor AngleUnits Dimension FontStyleLegendClickPolicyLegendLocation Orientation RenderMode SpatialUnits TextAlignTooltipAttachment VerticalAlign)HasPropsabstract)AlphaAngle AngleSpecAutoBoolColorDatetimeDictEitherEnumFloatIncludeInstanceIntList NonNullableNullNullableNullStringSpec NumberSpecOverridePropertyUnitsSpecSeqString StringSpecTextLikeTuplefieldvalue) FillProps LinePropsScalarFillPropsScalarHatchPropsScalarLinePropsScalarTextProps TextProps)error)BAD_COLUMN_NAME2NON_MATCHING_DATA_SOURCES_ON_LEGEND_ITEM_RENDERERS)Model)convert_datetime_type) TickFormatter)LabelingPolicy NoOverlap) ColorMapper) GlyphRendererRenderer)ColumnDataSource DataSource)Ticker) AnnotationArrowBand BoxAnnotationColorBarDataAnnotationLabelLabelSetLegend LegendItemPolyAnnotationSlopeSpanTextAnnotationTitleTooltip ToolbarPanelWhiskercCsddlm}|S)Nr;OpenHead) arrow_headsrXrWrZzDataAnnotation.zJ Local data source to use when rendering annotations on the plot. rdhelpN)rerfrgrhrrCsourcerZrZrZr[rJsrJc@seZdZeedddZdS)_HasRenderModeZcanvasa Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas. The default mode is "canvas". .. note:: This property is deprecated and will be removed in bokeh 3.0. .. note:: The HTML labels won't be present in the output using the "save" tool. .. warning:: Not all visual styling properties are supported if the render_mode is set to "css". The border_line_dash property isn't fully supported and border_line_dash_offset isn't supported at all. Setting text_alpha will modify the opacity of the entire background box and border in addition to the text. Finally, clipping Label annotations inside of the plot area isn't supported in "css" mode. rmN)rerfrgrr Z render_moderZrZrZr[rpsrpc@seZdZdZdS)rRzG Base class for text annotation models such as labels and titles. N)rerfrgrhrZrZrZr[rRsrRcsxeZdZdZddfdd ZeddZeee ddZ e e d dZ ed d d Zeed dZeeddZZS)rNz None)returncs*tj||t|jtr&t|j|_dSrj)super__init__ isinstancelabelstrr.)selfargskwargs __class__rZr[rts zLegendItem.__init__z A label for this legend. Can be a string, or a column of a ColumnDataSource. If ``label`` is a field, then it must be in the renderers' data_source. rnz A list of the glyph renderers to draw in the legend. If ``label`` is a field, then all data_sources of renderers must be the same. a The column data index to use for drawing the representative items. If None (the default), then Bokeh will automatically choose an index to use. If the label does not refer to a data column name, this is typically the first data point in the data source. Otherwise, if the label does refer to a column name, the legend will have "groupby" behavior, and will choose and display representative points from every "group" in the column. If set to a number, Bokeh will use that number as the index in all cases. Tz Whether the legend item should be displayed. See :ref:`userguide_annotations_legends_item_visibility` in the user guide. rmcCs4|jr0d|jkr0tdd|jDdkr0t|SdS)Nr-cSsh|] }|jqSrZ) data_source).0rrZrZr[ sz>LegendItem._check_data_sources_on_renderers..r;)rvlen renderersrw)rxrZrZr[ _check_data_sources_on_rendererssz+LegendItem._check_data_sources_on_rendererscCsP|jrLd|jkrLt|jdkr&t|S|jdj}|jd|jkrLt|SdS)Nr-r;r)rvrrrwr~getZ column_names)rxrorZrZr[!_check_field_label_on_data_sources  z,LegendItem._check_field_label_on_data_source)rerfrgrhrtr$rvr rr@rr#rindexrZvisibler6r8rr7r __classcell__rZrZr{r[rNs   rNc@seZdZdZeeeeeedddZ ee dddZ e e ddZeed d d Zed d Zedd ZedddZeeddd Zedd Zedd Zeeddd Zeeddd ZeedddZedd Z edd Z!edd Z"edd Z#eedd d Z$ed!d Z%ed d Z&edd"dZ'ed#d$dZ(ed#d%dZ)ed#d&dZ*ed#d'dZ+ed(d)dZ,ed(d*dZ-ed+d,dZ.e/e0e1d-d2e/ee e/e0e3d.d/Z4d0S)1rMz Render informational legends for a plot. See :ref:`userguide_annotations_legends` for information on plotting legends. top_righta The location where the legend should draw itself. It's either one of ``bokeh.core.enums.LegendLocation``'s enumerated values, or a ``(x, y)`` tuple indicating an absolute location absolute location in screen coordinates (pixels from the bottom-left corner). rmZverticalzi Whether the legend entries should be placed vertically or horizontally when they are drawn. # The title text to render. r}title/ The {prop} values for the title text. prefixrn13pxrcitaliczI The distance (in pixels) to separate the title from the legend. borderz3 The {prop} for the legend border outline. z#e5e5e5g? backgroundz5 The {prop} for the legend background style. Zinactivez The {prop} for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent). nonez@ Defines what happens when a lengend's item is clicked. #ffffffffffff?Zwhitegffffff?rvz+ The {prop} for the legend labels. ZmiddlezS The distance (in pixels) to separate the label from its associated glyph. zV The minimum height (in pixels) of the area that legend labels should occupy. zU The minimum width (in pixels) of the area that legend labels should occupy. zN The height (in pixels) that the rendered legend glyph should occupy. zM The width (in pixels) that the rendered legend glyph should occupy. r_z- Amount of margin around the legend. z Amount of padding around the contents of the legend. Only applicable when border is visible, otherwise collapses to 0. z? Amount of spacing (in pixels) between legend entries. a A list of :class:`~bokeh.model.annotations.LegendItem` instances to be rendered in the legend. This can be specified explicitly, for instance: .. code-block:: python legend = Legend(items=[ LegendItem(label="sin(x)" , renderers=[r0, r1]), LegendItem(label="2*sin(x)" , renderers=[r2]), LegendItem(label="3*sin(x)" , renderers=[r3, r4]) ]) But as a convenience, can also be given more compactly as a list of tuples: .. code-block:: python legend = Legend(items=[ ("sin(x)" , [r0, r1]), ("2*sin(x)" , [r2]), ("3*sin(x)" , [r3, r4]) ]) where each tuple is of the form: *(label, renderers)*. cCsdd|DS)NcSs g|]}t|d|ddqS)rr;)rvr)rN)ritemrZrZr[ lsz#Legend...rZ)itemsrZrZr[rklrlzLegend.N)5rerfrgrhrrr r,rlocationr orientationr#r)rrr4 title_propsr&title_text_font_sizetitle_text_font_stylertitle_standoffr3 border_propsborder_line_colorZborder_line_alphar1background_propsZinactive_propsrZ click_policybackground_fill_colorbackground_fill_alphaZinactive_fill_colorZinactive_fill_alphaZ label_propsZlabel_text_baselineZlabel_text_font_sizelabel_standoffZ label_heightZ label_widthZ glyph_heightZ glyph_widthmarginpaddingspacingr rrNacceptsr@rrZrZrZr[rMsB                    rMc@seZdZdZeeeeeedddZ eee e dddZ ee e ddZee e d dZed d dZeed dZeed ddZeddZeddZe dddZeeee dddZeeee dddZe eeee!iddZ"ee#ddddZ$ee%ddZ&e dddZ'e dddZ(eed d!dZ)ed"dZ*e d#d$dZ+ee,d%d&dZ-ed'dZ.e d#d(dZ/e d)d*dZ0ee,d+d,dZ1ed-dZ2e d)d.dZ3e d)d*dZ4ee,d/d0dZ5ed-dZ6ee,d1d2dZ7ed-dZ8ee9d3d4dZ:ed'dZ;ed5dZrZrZrZr[rkrlzColorBar.zN Allows to filter out labels, e.g. declutter labels to avoid overlap. a A color mapper containing a color palette to render. .. warning:: If the `low` and `high` attributes of the ``ColorMapper`` aren't set, ticks and tick labels won't be rendered. Additionally, if a ``LogTicker`` is passed to the `ticker` argument and either or both of the logarithms of `low` and `high` values of the color_mapper are non-numeric (i.e. `low=0`), the tick and tick labels won't be rendered. zK Amount of margin (in pixels) around the outside of the color bar. r_zU Amount of padding (in pixels) between the color scale and color bar border. Z major_labelz. The {prop} of the major tick labels. Z11pxrzR The distance (in pixels) to separate the tick labels from the color bar. Z major_tickz( The {prop} of the major ticks. rz^ The distance (in pixels) that major ticks should extend into the main plot area. rz` The distance (in pixels) that major ticks should extend out of the main plot area. Z minor_tickz( The {prop} of the minor ticks. Nz^ The distance (in pixels) that minor ticks should extend into the main plot area. barz5 The {prop} for the color scale bar outline. rz6 The {prop} for the color bar border outline. rz8 The {prop} for the color bar background style. r)=rerfrgrhrrrr,rrr rrrheightwidthZ scale_alphar#r)rrr4rr&rrrrrDZtickerr< formatterrr+Zmajor_label_overridesr=Zmajor_label_policyr?Z color_mapperrrZmajor_label_propsZmajor_label_text_font_sizerr3Zmajor_tick_propsZmajor_tick_line_colorZ major_tick_inZmajor_tick_outZminor_tick_propsZminor_tick_line_colorZ minor_tick_inZminor_tick_outZ bar_propsZbar_line_colorrrr1rrrrZrZrZr[rInsH                   rIc@seZdZdZeedddZeedddZee dddZ e e d d d Z eed d dZeedddZee dddZe e d ed dZeedd ZdS)rFzw Render arrows as an annotation. See :ref:`userguide_annotations_arrows` for information on plotting arrows. x_startz> The x-coordinates to locate the start of the arrows. rmy_startz> The y-coordinates to locate the start of the arrows. datazq The unit type for the start_x and start_y attributes. Interpreted as "data space" units by default. .models.arrow_heads.ArrowHead$ Instance of ``ArrowHead``. r}x_endz< The x-coordinates to locate the end of the arrows. y_endz< The y-coordinates to locate the end of the arrows. zm The unit type for the end_x and end_y attributes. Interpreted as "data space" units by default. z/ The {prop} values for the arrow body. N)rerfrgrhr%r-rrrr Z start_unitsr#rstartrrZ end_unitsr\endrr0Z body_propsrZrZrZr[rFsrFc@seZdZdZeeeeddZe e dddZ eeeeddZ e e dddZ eeeed dZe e dd dZeeeed dZe e dd dZeed dZeed dZeed dZeddZeddZeddZeddZdS)rHz Render a shaded rectangular region as an annotation. See :ref:`userguide_annotations_box_annotations` for information on plotting box annotations. z The x-coordinates of the left edge of the box annotation. Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch. r}rz[ The unit type for the left attribute. Interpreted as |data units| by default. rmz The x-coordinates of the right edge of the box annotation. Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch. z\ The unit type for the right attribute. Interpreted as |data units| by default. z The y-coordinates of the bottom edge of the box annotation. Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch. z] The unit type for the bottom attribute. Interpreted as |data units| by default. z The y-coordinates of the top edge of the box annotation. Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch. zZ The unit type for the top attribute. Interpreted as |data units| by default. z( The {prop} values for the box. 333333?rc#cccccc皙?#fff9baN)rerfrgrhrr"rr%leftrr Z left_unitsrightZ right_unitsbottomZ bottom_unitstopZ top_unitsrr3 line_propsr1 fill_propsr2 hatch_propsr& line_alpha line_color fill_alpha fill_colorrZrZrZr[rH/s       rHc@seZdZdZeededddZeededddZeededd dZ e e d d d Z e ed dZeddZeddZe ed dZeddZeddZdS)rGz Render a filled area band along a dimension. See :ref:`userguide_annotations_bands` for information on plotting bands. lowerrzG The coordinates of the lower portion of the filled area band. rdZ units_enumZ units_defaultrnupperzG The coordinates of the upper portion of the filled area band. baseC The orthogonal coordinates of the upper and lower values. rz The direction of the band can be specified by setting this property to "height" (``y`` direction) or "width" (``x`` direction). rmz) The {prop} values for the band. r}rrcrrrN)rerfrgrhr'r-r rrrrr dimensionrr3rr&rrr1rrrrZrZrZr[rGzs     rGc@seZdZdZeeddeeZ e e dddZ eeddeeZ e e dddZed d dZed d dZe ed ddZed ddZed ddZeeddZeedddZeddZeedddZeddZ dS)rKa Render a single text label as an annotation. ``Label`` will render a single text label at given ``x`` and ``y`` coordinates, which can be in either screen (pixel) space, or data (axis range) space. The label can also be configured with a screen space offset from ``x`` and ``y``, by using the ``x_offset`` and ``y_offset`` properties. Additionally, the label can be rotated with the ``angle`` property. There are also standard text, fill, and line properties to control the appearance of the text, its background, as well as the rectangular bounding box border. See :ref:`userguide_annotations_labels` for information on plotting labels. z The x-coordinate in screen coordinates to locate the text anchors. Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch. r}rzX The unit type for the x attribute. Interpreted as |data units| by default. rmz The y-coordinate in screen coordinates to locate the text anchors. Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch. zX The unit type for the y attribute. Interpreted as |data units| by default. # The text value to render. rzH The angle to rotate the text, as measured from the horizontal. ZradzA Acceptable values for units are ``"rad"`` and ``"deg"`` z Offset value to apply to the x-coordinate. This is useful, for instance, if it is desired to "float" text a fixed distance in |screen units| from a given data position. z Offset value to apply to the y-coordinate. This is useful, for instance, if it is desired to "float" text a fixed distance in |screen units| from a given data position. ) The {prop} values for the text. r6 The {prop} values for the text bounding box. rNrcr)!rerfrgrhr!rrrr:xrr x_unitsyy_unitsr)textranglerZ angle_unitsx_offsety_offsetrr4 text_propsr1rr&rr3rrrZrZrZr[rKs*        rKc@seZdZdZeedddZeedddZ eedddZ eedd dZ e ed d dZ ed d dZed ddZed ddZeeddZeedddZeddZeedddZeddZdS)rLa. Render multiple text labels as annotations. ``LabelSet`` will render multiple text labels at given ``x`` and ``y`` coordinates, which can be in either screen (pixel) space, or data (axis range) space. In this case (as opposed to the single ``Label`` model), ``x`` and ``y`` can also be the name of a column from a :class:`~bokeh.models.sources.ColumnDataSource`, in which case the labels will be "vectorized" using coordinate values from the specified columns. The label can also be configured with a screen space offset from ``x`` and ``y``, by using the ``x_offset`` and ``y_offset`` properties. These offsets may be vectorized by giving the name of a data source column. Additionally, the label can be rotated with the ``angle`` property (which may also be a column name.) There are also standard text, fill, and line properties to control the appearance of the text, its background, as well as the rectangular bounding box border. The data source is provided by setting the ``source`` property. rz7 The x-coordinates to locate the text anchors. rmr] The unit type for the ``xs`` attribute. Interpreted as |data units| by default. rz7 The y-coordinates to locate the text anchors. ] The unit type for the ``ys`` attribute. Interpreted as |data units| by default. rz$ The text values to render. rzI The angles to rotate the text, as measured from the horizontal. z Offset values to apply to the x-coordinates. This is useful, for instance, if it is desired to "float" text a fixed distance in |screen units| from a given data position. z Offset values to apply to the y-coordinates. This is useful, for instance, if it is desired to "float" text a fixed distance in |screen units| from a given data position. rr}rrrNrcr)rerfrgrhr%r-rrr rrrr*rrrrrrr5rr/rr&rr0rrrZrZrZr[rLs     rLc@seZdZdZeegddZeedddZ eegddZ eedddZ e e dd Ze edd Ze edd Zed d Zed d Zed d Zedd ZdS)rOz Render a shaded polygonal region as an annotation. See :ref:`userguide_annotations_polygon_annotations` for information on plotting polygon annotations. z2 The x-coordinates of the region to draw. rmrrz2 The y-coordinates of the region to draw. rz, The {prop} values for the polygon. r}rrcrrrN)rerfrgrhr(rxsrr Zxs_unitsZysZys_unitsrr3rr1rr2rr&rrrrrZrZrZr[rOHs      rOc@s4eZdZdZeeddZeeddZee ddZ dS)rPz} Render a sloped line as an annotation. See :ref:`userguide_annotations_slope` for information on plotting slopes. z3 The gradient of the line, in |data units| r}z6 The y intercept of the line, in |data units| z) The {prop} values for the line. N) rerfrgrhr#rZgradientZ y_interceptrr3rrZrZrZr[rPvs  rPc@sLeZdZdZeeddeeZ e e dddZ e e dddZeed dZd S) rQz Render a horizontal or vertical line span. See :ref:`userguide_annotations_spans` for information on plotting spans. z The location of the span, along ``dimension``. Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch. r}rze The unit type for the location attribute. Interpreted as "data space" units by default. rmrz The direction of the span can be specified by setting this property to "height" (``y`` direction) or "width" (``x`` direction). z) The {prop} values for the span. N)rerfrgrhr#rrrr:rrr Zlocation_unitsrrrr3rrZrZrZr[rQs rQc@seZdZdZedddZeedddZee dddZ e d d dZ e d d dZ e d ddZedddZeddZeedddZedddZeddZeedddZeddZeedddZeddZdS)rSz Render a single title box as an annotation. See :ref:`userguide_annotations_titles` for information on plotting titles. rrrmrz[ Alignment of the text in its enclosing space, *across* the direction of the text. rzZ Alignment of the text in its enclosing space, *along* the direction of the text. rz How much additional space should be allocated for the title. The value is provided as a number, but should be treated as a percentage of font size. The default is 100%, which means no additional space will be used. ra+ Offset the text by a number of pixels (can be positive or negative). Shifts the text in different directions based on the location of the title: * above: shifts title right * right: shifts title down * below: shifts title right * left: shifts title up r_z Z helveticaz\ Name of a font to use for rendering text, e.g., ``'times'``, ``'helvetica'``. rrcZboldz A style to use for rendering text. Acceptable values are: - ``'normal'`` normal text - ``'italic'`` *italic text* - ``'bold'`` **bold text** z#444444z+ A color to use to fill text with. z2 An alpha value to use to fill text with. r}rrrNr)rerfrgrhr)rrrZvertical_alignr ZalignrZtext_line_heightoffsetZstandoffZ text_fontZtext_font_sizerZtext_font_stylerZ text_colorrZ text_alpharr1rr&rr3rrrZrZrZr[rSs         rSc@s>eZdZdZeddZeeddZe dddZ e dd dZ d S) rTz Render a tooltip. .. note:: This model is currently managed by BokehJS and is not useful directly from python. overlayrcz Whether the tooltip should be displayed to the left or right of the cursor position or above or below it, or if it should be automatically placed in the horizontal or vertical dimension. r}Tz Whether to display outside a central plot frame area. .. note: This property is deprecated and will be removed in bokeh 3.0. rmz2 Whether tooltip's arrow should be shown. N) rerfrgrhr&rirr attachmentrZ inner_onlyZ show_arrowrZrZrZr[rTs    rTc@seZdZdZeededddZee de ddZ eed edd dZ ee de ddZ eed edd dZeed ddZeeddZeddZdS)rVz Render a whisker along a dimension. See :ref:`userguide_annotations_whiskers` for information on plotting whiskers. rrz; The coordinates of the lower end of the whiskers. rrrrmrz; The coordinates of the upper end of the whiskers. rrrz The direction of the whisker can be specified by setting this property to "height" (``y`` direction) or "width" (``x`` direction). z1 The {prop} values for the whisker body. r}ZunderlayrcN)rerfrgrhr'r-r rr#rraZ lower_headrZ upper_headrrrrrr0rr&rirZrZrZr[rVs rVc@seZdZedddZdS)rUz.models.tools.Toolbarz A toolbar to display. r}N)rerfrgrZtoolbarrZrZrZr[rU5srU)krh __future__rlogging getLoggerrelogZ core.enumsrrrrrr r r r r rrZcore.has_propsrrZcore.propertiesrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.Zcore.property_mixinsr/r0r1r2r3r4r5Zcore.validationr6Zcore.validation.errorsr7r8modelr9Zutil.serializationr: formattersr<Zlabelingr=r>Zmappersr?rr@rAsourcesrBrCZtickersrD__all__r\rarErJrprRrNrMrIrFrHrGrKrLrOrPrQrSrTrVrUrZrZrZr[sX  8|$       5-K'VQ.N&