B
d9 @ sx d Z ddddddddd d
d g Zd d
lZd d
lZd d
lZd d
lZyd dlmZ W n ek
rn d dlmZ Y nX ddl m
Z
dd Z dd Z dd Z
G dd deZG dd deZG dd d eZG dd deZG dd deZG dd deZG dd
d
eZG dd d eZG d d d eZG d d d eZG d d! d!eZG d"d# d#eZG d$d% d%eZe e e gZ d
S )&a6
Plugins to add behavior to mpld3 charts
=======================================
Plugins are means of adding additional javascript features to D3-rendered
matplotlib plots. A number of plugins are defined here; it is also possible
to create nearly any imaginable behavior by defining your own custom plugin.
connectclear get_plugins
PluginBaseResetZoomBoxZoomPointLabelTooltipPointHTMLTooltipLineLabelTooltip
MousePosition N)Iterable )get_idc C s t | | jS )z%Get the list of plugins in the figure)r
mpld3_plugins)fig r Z/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/mpld3/plugins.pyr s c G sL t | tjjstdt| ds.tdd | _x|D ]}| j| q4W dS )a Connect one or more plugins to a figure
Parameters
----------
fig : matplotlib Figure instance
The figure to which the plugins will be connected
*plugins :
Additional arguments should be plugins which will be connected
to the figure.
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import plugins
>>> fig, ax = plt.subplots()
>>> lines = ax.plot(range(10), '-k')
>>> plugins.connect(fig, plugins.LineLabelTooltip(lines[0]))
z0plugins.connect: first argument must be a figurer N)
isinstance
matplotlibZfigureZFigure
ValueErrorhasattrDEFAULT_PLUGINSr append)r pluginspluginr r r r ! s
c C s
g | _ dS )z5Clear all plugins from the figure, including defaultsN)r )r r r r r = s c @ s$ e Zd Zdd Zdd Zdd ZdS )r c C s | j S )N)dict_)selfr r r get_dictC s zPluginBase.get_dictc C s2 t | dr*t | dr"| j| jS | jS ndS d S )N
JAVASCRIPTjs_args_ )r r renderr )r r r r
javascriptF s
zPluginBase.javascriptc C s t | dr| jS dS d S )Ncss_r! )r r$ )r r r r cssO s
zPluginBase.cssN)__name__
__module__ __qualname__r r# r% r r r r r B s c @ s e Zd ZdZddiZdS )r z A Plugin to add a reset buttontyperesetN)r& r' r( __doc__r r r r r r V s c @ s e Zd ZdZdddZdS )r aL A Plugin to display coordinates for the current mouse position
Example
-------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import fig_to_html, plugins
>>> fig, ax = plt.subplots()
>>> points = ax.plot(range(10), 'o')
>>> plugins.connect(fig, plugins.MousePosition())
>>> fig_to_html(fig)
.3gc C s d||d| _ d S )NZ
mouseposition)r) fontsizefmt)r )r r. r/ r r r __init__h s zMousePosition.__init__N)r, r- )r& r' r( r+ r0 r r r r r [ s c @ s e Zd ZdZdddZdS )r a A Plugin to add zoom behavior to the plot
Parameters
----------
button : boolean, optional
if True (default), then add a button to enable/disable zoom behavior
enabled : boolean, optional
specify whether the zoom should be enabled by default. By default,
zoom is enabled if button == False, and disabled if button == True.
Notes
-----
Even if ``enabled`` is specified, other plugins may modify this state.
TNc C s |d kr| }d||d| _ d S )NZzoom)r) buttonenabled)r )r r1 r2 r r r r0 } s
z
Zoom.__init__)TN)r& r' r( r+ r0 r r r r r n s c @ s e Zd ZdZdddZdS )r a A Plugin to add box-zoom behavior to the plot
Parameters
----------
button : boolean, optional
if True (default), then add a button to enable/disable zoom behavior
enabled : boolean, optional
specify whether the zoom should be enabled by default. By default,
zoom is enabled if button == False, and disabled if button == True.
Notes
-----
Even if ``enabled`` is specified, other plugins may modify this state.
TNc C s |d kr| }d||d| _ d S )NZboxzoom)r) r1 r2 )r )r r1 r2 r r r r0 s
zBoxZoom.__init__)TN)r& r' r( r+ r0 r r r r r s c @ s e Zd ZdZdddZdS ) r a A Plugin to enable a tooltip: text which hovers over points.
Parameters
----------
points : matplotlib Collection or Line2D object
The figure element to apply the tooltip to
labels : array or None
If supplied, specify the labels for each point in points. If not
supplied, the (x, y) values will be used.
hoffset, voffset : integer
The number of pixels to offset the tooltip text. Default is
hoffset = 0, voffset = 10
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import fig_to_html, plugins
>>> fig, ax = plt.subplots()
>>> points = ax.plot(range(10), 'o')
>>> plugins.connect(fig, PointLabelTooltip(points[0]))
>>> fig_to_html(fig)
Nr
mousec C sL |dkrt d|t|tjjr*d}nd }dt||||||d| _d S )N)z bottom leftztop leftz bottom rightz top rightr4 zinvalid location: {0}ptstooltip)r) idlabelshoffsetvoffsetlocation)r formatr r linesLine2Dr r )r pointsr8 r9 r: r; suffixr r r r0 s zPointLabelTooltip.__init__)Nr r3 r4 )r& r' r( r+ r0 r r r r r s c @ s e Zd ZdZdddZdS ) r
a A Plugin to enable a tooltip: text which hovers over a line.
Parameters
----------
line : matplotlib Line2D object
The figure element to apply the tooltip to
label : string
If supplied, specify the labels for each point in points. If not
supplied, the (x, y) values will be used.
hoffset, voffset : integer
The number of pixels to offset the tooltip text. Default is
hoffset = 0, voffset = 10
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import fig_to_html, plugins
>>> fig, ax = plt.subplots()
>>> lines = ax.plot(range(10), 'o')
>>> plugins.connect(fig, LineLabelTooltip(lines[0]))
>>> fig_to_html(fig)
Nr r3 r4 c C s@ |dkrt d|dt||d kr*|n|g|||d| _d S )N)z bottom leftztop leftz bottom rightz top rightr4 zinvalid location: {0}r6 )r) r7 r8 r9 r: r; )r r< r r )r r? labelr9 r: r; r r r r0 s zLineLabelTooltip.__init__)Nr r3 r4 )r& r' r( r+ r0 r r r r r
s c @ s e Zd ZdZdddZdS ) LinkedBrusha' A Plugin to enable linked brushing between plots
Parameters
----------
points : matplotlib Collection or Line2D object
A representative of the scatter plot elements to brush.
button : boolean, optional
if True (default), then add a button to enable/disable zoom behavior
enabled : boolean, optional
specify whether the zoom should be enabled by default. default=True.
Examples
--------
>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpld3 import fig_to_html, plugins
>>> X = np.random.random((3, 100))
>>> fig, ax = plt.subplots(3, 3)
>>> for i in range(2):
... for j in range(2):
... points = ax[i, j].scatter(X[i], X[j])
>>> plugins.connect(fig, LinkedBrush(points))
>>> fig_to_html(fig)
Notes
-----
Notice that in the above example, only one of the four sets of points is
passed to the plugin. This is all that is needed: for the sake of efficient
data storage, mpld3 keeps track of which plot objects draw from the same
data.
Also note that for the linked brushing to work correctly, the data must
not contain any NaNs. The presence of NaNs makes the different data views
have different sizes, so that mpld3 is unable to link the related points.
Tc C s2 t |tjjrd}nd }d||t||d| _d S )Nr5 Z linkedbrush)r) r1 r2 r7 )r r r= r> r r )r r? r1 r2 r@ r r r r0
s zLinkedBrush.__init__N)TT)r& r' r( r+ r0 r r r r rB s #rB c @ s e Zd ZdZdZdddZdS ) r a A Plugin to enable an HTML tooltip:
formated text which hovers over points.
Parameters
----------
points : matplotlib Collection or Line2D object
The figure element to apply the tooltip to
labels : list
The labels for each point in points, as strings of unescaped HTML.
targets : list
The urls that each point will open when clicked.
hoffset, voffset : integer, optional
The number of pixels to offset the tooltip text. Default is
hoffset = 0, voffset = 10
css : str, optional
css to be included, for styling the label html if desired
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import fig_to_html, plugins
>>> fig, ax = plt.subplots()
>>> points = ax.plot(range(10), 'o')
>>> labels = ['{title}
'.format(title=i) for i in range(10)]
>>> plugins.connect(fig, PointHTMLTooltip(points[0], labels))
>>> fig_to_html(fig)
a
mpld3.register_plugin("htmltooltip", HtmlTooltipPlugin);
HtmlTooltipPlugin.prototype = Object.create(mpld3.Plugin.prototype);
HtmlTooltipPlugin.prototype.constructor = HtmlTooltipPlugin;
HtmlTooltipPlugin.prototype.requiredProps = ["id"];
HtmlTooltipPlugin.prototype.defaultProps = {labels:null,
target:null,
hoffset:0,
voffset:10,
targets:null};
function HtmlTooltipPlugin(fig, props){
mpld3.Plugin.call(this, fig, props);
};
HtmlTooltipPlugin.prototype.draw = function(){
var obj = mpld3.get_element(this.props.id);
var labels = this.props.labels;
var targets = this.props.targets;
var tooltip = d3.select("body").append("div")
.attr("class", "mpld3-tooltip")
.style("position", "absolute")
.style("z-index", "10")
.style("visibility", "hidden");
obj.elements()
.on("mouseover", function(d, i){
tooltip.html(labels[i])
.style("visibility", "visible");
})
.on("mousemove", function(d, i){
tooltip
.style("top", d3.event.pageY + this.props.voffset + "px")
.style("left",d3.event.pageX + this.props.hoffset + "px");
}.bind(this))
.on("mousedown.callout", function(d, i){
window.open(targets[i],"_blank");
})
.on("mouseout", function(d, i){
tooltip.style("visibility", "hidden");
});
};
Nr r3 c C s^ || _ || _|| _|| _|| _|p$d| _t|tjj r r r )r r? r8 rC r9 r: r% r@ r r r r0 ` s
zPointHTMLTooltip.__init__)NNr r3 N)r& r' r( r+ r r0 r r r r r s + c @ s e Zd ZdZdZdddZdS ) LineHTMLTooltipaN A Plugin to enable an HTML tooltip:
formated text which hovers over points.
Parameters
----------
points : matplotlib Line2D object
The figure element to apply the tooltip to
label : string
The label for the line, as strings of unescaped HTML.
hoffset, voffset : integer, optional
The number of pixels to offset the tooltip text. Default is
hoffset = 0, voffset = 10
css : str, optional
css to be included, for styling the label html if desired
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import fig_to_html, plugins
>>> fig, ax = plt.subplots()
>>> lines = ax.plot(range(10))
>>> label = 'line {title}
'.format(title='A')
>>> plugins.connect(fig, LineHTMLTooltip(lines[0], label))
>>> fig_to_html(fig)
a
mpld3.register_plugin("linehtmltooltip", LineHTMLTooltip);
LineHTMLTooltip.prototype = Object.create(mpld3.Plugin.prototype);
LineHTMLTooltip.prototype.constructor = LineHTMLTooltip;
LineHTMLTooltip.prototype.requiredProps = ["id"];
LineHTMLTooltip.prototype.defaultProps = {label:null,
hoffset:0,
voffset:10};
function LineHTMLTooltip(fig, props){
mpld3.Plugin.call(this, fig, props);
};
LineHTMLTooltip.prototype.draw = function(){
var obj = mpld3.get_element(this.props.id, this.fig);
var label = this.props.label
var tooltip = d3.select("body").append("div")
.attr("class", "mpld3-tooltip")
.style("position", "absolute")
.style("z-index", "10")
.style("visibility", "hidden");
obj.elements()
.on("mouseover", function(d, i){
tooltip.html(label)
.style("visibility", "visible");
})
.on("mousemove", function(d, i){
tooltip
.style("top", d3.event.pageY + this.props.voffset + "px")
.style("left",d3.event.pageX + this.props.hoffset + "px");
}.bind(this))
.on("mouseout", function(d, i){
tooltip.style("visibility", "hidden");})
};
Nr r3 c C s< || _ || _|| _|| _|p d| _dt||||d| _d S )Nr! Zlinehtmltooltip)r) r7 rA r9 r: )linerA r: r9 r$ r r )r rE rA r9 r: r% r r r r0 s
zLineHTMLTooltip.__init__)Nr r3 N)r& r' r( r+ r r0 r r r r rD t s
$ rD c @ s* e Zd ZdZdZdZdd
d Zd d
ZdS )InteractiveLegendPlugina A plugin for an interactive legends.
Inspired by http://bl.ocks.org/simzou/6439398
Parameters
----------
plot_elements : iterable of matplotlib elements
the elements to associate with a given legend items
labels : iterable of strings
The labels for each legend element
ax : matplotlib axes instance, optional
the ax to which the legend belongs. Default is the first
axes. The legend will be plotted to the right of the specified
axes
alpha_unsel : float, optional
the alpha value to multiply the plot_element(s) associated alpha
with the legend item when the legend item is unselected.
Default is 0.2
alpha_over : float, optional
the alpha value to multiply the plot_element(s) associated alpha
with the legend item when the legend item is overlaid.
Default is 1 (no effect), 1.5 works nicely !
start_visible : boolean, optional (could be a list of booleans)
defines if objects should start selected on not.
font_size : int, optional
defines legend font-size.
Default is 10.
legend_offset : list of int (length: 2)
defines horizontal offset and vertical offset of legend.
Default is (0, 0).
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import fig_to_html, plugins
>>> N_paths = 5
>>> N_steps = 100
>>> x = np.linspace(0, 10, 100)
>>> y = 0.1 * (np.random.random((N_paths, N_steps)) - 0.5)
>>> y = y.cumsum(1)
>>> fig, ax = plt.subplots()
>>> labels = ["a", "b", "c", "d", "e"]
>>> line_collections = ax.plot(x, y.T, lw=4, alpha=0.6)
>>> interactive_legend = plugins.InteractiveLegendPlugin(line_collections,
... labels,
... alpha_unsel=0.2,
... alpha_over=1.5,
... start_visible=True,
... font_size=14,
... legend_offset=(-100,20))
>>> plugins.connect(fig, interactive_legend)
>>> fig_to_html(fig)
a
mpld3.register_plugin("interactive_legend", InteractiveLegend);
InteractiveLegend.prototype = Object.create(mpld3.Plugin.prototype);
InteractiveLegend.prototype.constructor = InteractiveLegend;
InteractiveLegend.prototype.requiredProps = ["element_ids", "labels"];
InteractiveLegend.prototype.defaultProps = {"ax":null,
"alpha_unsel":0.2,
"alpha_over":1.0,
"start_visible":true,
"font_size": 10,
"legend_offset": [0,0]}
function InteractiveLegend(fig, props){
mpld3.Plugin.call(this, fig, props);
};
InteractiveLegend.prototype.draw = function(){
var alpha_unsel = this.props.alpha_unsel;
var alpha_over = this.props.alpha_over;
var font_size = this.props.font_size;
var legend_offset = this.props.legend_offset;
var legendItems = new Array();
for(var i=0; i )r rT rS entryZidselementZmpld3_idr r r rR s
z+InteractiveLegendPlugin._determine_mpld3ids)NrG rH Tr3 rI )r& r' r( r+ r r$ r0 rR r r r r rF s 5
rF c @ s e Zd ZdZdZdddZdS ) PointClickableHTMLTooltipa A plugin for pop-up windows with data with rich HTML
Parameters
----------
points : matplotlib Collection object
The figure element to apply the tooltip to
labels : list
The labels for each point in points, as strings of unescaped HTML.
targets : list
The target data or rich HTML to be displayed when each collection element is clicked
hoffset, voffset : integer, optional
The number of pixels to offset the tooltip text. Default is
hoffset = 0, voffset = 10
css : str, optional
css to be included, for styling the label html and target data/tables, if desired
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from mpld3 import plugins
>>> fig, ax = plt.subplots(1,1)
>>> xx = yy = range(10)
>>> scat = ax.scatter(xx, range(10))
>>> targets = map(lambda (x, y): "".format(x, y),
>>> zip(xx, yy))
>>> labels = map(lambda (x, y): "{}, {}".format(x,y), zip(xx, yy))
>>> from mpld3.plugins import PointClickableHTMLTooltip
>>> plugins.connect(fig, PointClickableHTMLTooltip(scat, labels=labels, targets=targets))
a
mpld3.register_plugin("clickablehtmltooltip", PointClickableHTMLTooltip);
PointClickableHTMLTooltip.prototype = Object.create(mpld3.Plugin.prototype);
PointClickableHTMLTooltip.prototype.constructor = PointClickableHTMLTooltip;
PointClickableHTMLTooltip.prototype.requiredProps = ["id"];
PointClickableHTMLTooltip.prototype.defaultProps = {labels:null,
targets:null,
hoffset:0,
voffset:10};
function PointClickableHTMLTooltip(fig, props){
mpld3.Plugin.call(this, fig, props);
};
PointClickableHTMLTooltip.prototype.draw = function(){
var obj = mpld3.get_element(this.props.id);
var labels = this.props.labels;
var targets = this.props.targets;
var tooltip = d3.select("body").append("div")
.attr("class", "mpld3-tooltip")
.style("position", "absolute")
.style("z-index", "10")
.style("visibility", "hidden");
obj.elements()
.on("mouseover", function(d, i){
if ($(obj.elements()[0][0]).css( "fill-opacity" ) > 0 || $(obj.elements()[0][0]).css( "stroke-opacity" ) > 0) {
tooltip.html(labels[i])
.style("visibility", "visible");
} })
.on("mousedown", function(d, i){
window.open().document.write(targets[i]);
})
.on("mousemove", function(d, i){
tooltip
.style("top", d3.event.pageY + this.props.voffset + "px")
.style("left",d3.event.pageX + this.props.hoffset + "px");
}.bind(this))
.on("mouseout", function(d, i){
tooltip.style("visibility", "hidden");});
};
N c s~ | _ | _| _| _| _|p$d _|d k rDt fdd|}nd }t|tj j
r\d}nd }dt ||||||d _ d S )Nr! c s
j | S )N)r$ )x)r r r ( z4PointClickableHTMLTooltip.__init__..r5 Zclickablehtmltooltip)r) r7 r8 rC r9 r: )
r? r8 rC r: r9 r$ mapr r r= r> r r ) r r? r8 rC r9 r: r% Zstyled_targetsr@ r )r r r0 s$
z"PointClickableHTMLTooltip.__init__)NNrX rY N)r& r' r( r+ r r0 r r r r rW s , rW c @ s e Zd ZdZdZdddZdS ) MouseXPositionz2Like MousePosition, but only show the X coordinatea
mpld3.register_plugin("mousexposition", MouseXPositionPlugin);
MouseXPositionPlugin.prototype = Object.create(mpld3.Plugin.prototype);
MouseXPositionPlugin.prototype.constructor = MouseXPositionPlugin;
MouseXPositionPlugin.prototype.requiredProps = [];
MouseXPositionPlugin.prototype.defaultProps = {
fontsize: 12,
fmt: "0d"
};
function MouseXPositionPlugin(fig, props) {
mpld3.Plugin.call(this, fig, props);
}
MouseXPositionPlugin.prototype.draw = function() {
var fig = this.fig;
var fmt = d3.format(this.props.fmt);
var coords = fig.canvas.append("text").attr("class", "mpld3-coordinates").style("text-anchor", "end").style("font-size", this.props.fontsize).attr("x", this.fig.width - 5).attr("y", this.fig.height - 5);
for (var i = 0; i < this.fig.axes.length; i++) {
var update_coords = function() {
var ax = fig.axes[i];
return function() {
var pos = d3.mouse(this), x = ax.x.invert(pos[0]), y = ax.y.invert(pos[1]);
coords.text(fmt(x));
};
}();
fig.axes[i].baseaxes.on("mousemove", update_coords).on("mouseout", function() {
coords.text("");
});
}
};r, 8.0fc C s d||d| _ d S )NZmousexposition)r) r. r/ )r )r r. r/ r r r r0 e s zMouseXPosition.__init__N)r, r_ )r& r' r( r+ r r0 r r r r r^ 9 s
r^ ) r+ __all__ collectionsjsonuuidr collections.abcr
ImportErrorutilsr r r r objectr r r r r r r
rB r rD rF rW r^ r r r r r s@ ($1[M d1