matplotlib 3.5.1

ParametersReturns
contains(self, mouseevent)

An event is deemed to have occurred "on" the line if it is less than self.pickradius (default: 5 points) away from it. Use ~.Line2D.get_pickradius or ~.Line2D.set_pickradius to get or set the pick radius.

Parameters

mouseevent : `matplotlib.backend_bases.MouseEvent`

Returns

contains : bool

Whether any values are within the radius.

details : dict

A dictionary {'ind': pointlist} , where pointlist is a list of points of the line that are within the pickradius around the event position.

TODO: sort returned indices by distance

Test whether mouseevent occurred on the line.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /matplotlib/lines.py#414
type: <class 'function'>
Commit: