holoviews.plotting.mpl.annotation module#

class holoviews.plotting.mpl.annotation.ABLine2D(slope, intercept, *args, **kwargs)[source]#

Bases: Line2D

Draw a line based on its slope and y-intercept.

Additional arguments are passed to the matplotlib.lines.Line2D constructor.

Methods

set(*[, agg_filter, alpha, animated, ...])

Set multiple properties at once.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, dash_capstyle=<UNSET>, dash_joinstyle=<UNSET>, dashes=<UNSET>, data=<UNSET>, drawstyle=<UNSET>, fillstyle=<UNSET>, gapcolor=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, marker=<UNSET>, markeredgecolor=<UNSET>, markeredgewidth=<UNSET>, markerfacecolor=<UNSET>, markerfacecoloralt=<UNSET>, markersize=<UNSET>, markevery=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, solid_capstyle=<UNSET>, solid_joinstyle=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xdata=<UNSET>, ydata=<UNSET>, zorder=<UNSET>)[source]#

Set multiple properties at once.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

Supported properties are

Properties:: agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image alpha: float or None animated: bool antialiased or aa: bool clip_box: ~matplotlib.transforms.BboxBase or None clip_on: bool clip_path: Patch or (Path, Transform) or None color or c: :mpltype:`color` dash_capstyle: .CapStyle or {‘butt’, ‘projecting’, ‘round’} dash_joinstyle: .JoinStyle or {‘miter’, ‘round’, ‘bevel’} dashes: sequence of floats (on/off ink in points) or (None, None) data: (2, N) array or two 1D arrays drawstyle or ds: {‘default’, ‘steps’, ‘steps-pre’, ‘steps-mid’, ‘steps-post’}, default: ‘default’ figure: ~matplotlib.figure.Figure or ~matplotlib.figure.SubFigure fillstyle: {‘full’, ‘left’, ‘right’, ‘bottom’, ‘top’, ‘none’} gapcolor: :mpltype:`color` or None gid: str in_layout: bool label: object linestyle or ls: {‘-’, ‘–’, ‘-.’, ‘:’, ‘’, …} or (offset, on-off-seq) linewidth or lw: float marker: marker style string, ~.path.Path or ~.markers.MarkerStyle markeredgecolor or mec: :mpltype:`color` markeredgewidth or mew: float markerfacecolor or mfc: :mpltype:`color` markerfacecoloralt or mfcalt: :mpltype:`color` markersize or ms: float markevery: None or int or (int, int) or slice or list[int] or float or (float, float) or list[bool] mouseover: bool path_effects: list of .AbstractPathEffect picker: float or callable[[Artist, Event], tuple[bool, dict]] pickradius: float rasterized: bool sketch_params: (scale: float, length: float, randomness: float) snap: bool or None solid_capstyle: .CapStyle or {‘butt’, ‘projecting’, ‘round’} solid_joinstyle: .JoinStyle or {‘miter’, ‘round’, ‘bevel’} transform: ~matplotlib.transforms.Transform url: str visible: bool xdata: 1D array ydata: 1D array zorder: float

class holoviews.plotting.mpl.annotation.AnnotationPlot(annotation, **params)[source]#

Bases: ElementPlot

AnnotationPlot handles the display of all annotation elements.

Methods

update_handles(key, axis, annotation, ...)

Update the elements of the plot.

initialize_plot

Parameter Definitions

Parameters inherited from:

show_legend = Boolean(default=False, label='Show legend'): Whether to show legend for the plot.

initialize_plot(*args, **kwargs)[source]#: Initialize the matplotlib figure.

update_handles(key, axis, annotation, ranges, style)[source]#: Update the elements of the plot.

class holoviews.plotting.mpl.annotation.ArrowPlot(annotation, **params)[source]#

Bases: AnnotationPlot

Draw an arrow using the information supplied to the Arrow annotation

Methods

draw_annotation

Parameter Definitions

Parameters inherited from:

class holoviews.plotting.mpl.annotation.HLinePlot(annotation, **params)[source]#

Bases: AnnotationPlot

Draw a horizontal line on the axis

Methods

draw_annotation(axis, position, opts)

Draw a horizontal line on the axis

Parameter Definitions

Parameters inherited from:

draw_annotation(axis, position, opts)[source]#: Draw a horizontal line on the axis

class holoviews.plotting.mpl.annotation.HLinesAnnotationPlot(annotation, **params)[source]#

Bases: _SyntheticAnnotationPlot

Parameter Definitions

Parameters inherited from:

class holoviews.plotting.mpl.annotation.HSpanPlot(annotation, **params)[source]#

Bases: AnnotationPlot

Draw a horizontal span on the axis

Methods

draw_annotation(axis, positions, opts)

Draw a horizontal span on the axis

Parameter Definitions

Parameters inherited from:

draw_annotation(axis, positions, opts)[source]#: Draw a horizontal span on the axis

class holoviews.plotting.mpl.annotation.HSpansAnnotationPlot(annotation, **params)[source]#

Bases: _SyntheticAnnotationPlot

Parameter Definitions

Parameters inherited from:

class holoviews.plotting.mpl.annotation.LabelsPlot(*args, **kwargs)[source]#

Bases: ColorbarPlot

Methods

`init_artists`(ax, plot_args, plot_kwargs)	Initializes the artist based on the plot method declared on the plot.
`teardown_handles`()	If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

get_data

Parameter Definitions

Parameters inherited from:

xoffset = Number(allow_None=True, inclusive_bounds=(True, True), label='Xoffset'): Amount of offset to apply to labels along x-axis.
yoffset = Number(allow_None=True, inclusive_bounds=(True, True), label='Yoffset'): Amount of offset to apply to labels along x-axis.

init_artists(ax, plot_args, plot_kwargs)[source]#: Initializes the artist based on the plot method declared on the plot.

teardown_handles()[source]#: If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

class holoviews.plotting.mpl.annotation.SlopePlot(annotation, **params)[source]#

Bases: AnnotationPlot

Methods

draw_annotation(axis, position, opts)

Draw a horizontal line on the axis

Parameter Definitions

Parameters inherited from:

draw_annotation(axis, position, opts)[source]#: Draw a horizontal line on the axis

class holoviews.plotting.mpl.annotation.SplinePlot(annotation, **params)[source]#

Bases: AnnotationPlot

Draw the supplied Spline annotation (see Spline docstring)

Methods

draw_annotation

Parameter Definitions

Parameters inherited from:

class holoviews.plotting.mpl.annotation.TextPlot(annotation, **params)[source]#

Bases: AnnotationPlot

Draw the Text annotation object

Methods

draw_annotation

Parameter Definitions

Parameters inherited from:

class holoviews.plotting.mpl.annotation.VLinePlot(annotation, **params)[source]#

Bases: AnnotationPlot

Draw a vertical line on the axis

Methods

draw_annotation

Parameter Definitions

Parameters inherited from:

class holoviews.plotting.mpl.annotation.VLinesAnnotationPlot(annotation, **params)[source]#

Bases: _SyntheticAnnotationPlot

Parameter Definitions

Parameters inherited from:

class holoviews.plotting.mpl.annotation.VSpanPlot(annotation, **params)[source]#

Bases: AnnotationPlot

Draw a vertical span on the axis

Methods

draw_annotation(axis, positions, opts)

Draw a vertical span on the axis

Parameter Definitions

Parameters inherited from:

draw_annotation(axis, positions, opts)[source]#: Draw a vertical span on the axis

class holoviews.plotting.mpl.annotation.VSpansAnnotationPlot(annotation, **params)[source]#

Bases: _SyntheticAnnotationPlot

Parameter Definitions

Parameters inherited from: