matplotlib.artist.Artist.set_contains

Artist.set_contains(self, picker) [source]

[Deprecated] Define a custom contains test for the artist.

The provided callable replaces the default contains method of the artist.

Parameters:
pickercallable

A custom picker function to evaluate if an event is within the artist. The function must have the signature:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

that returns:

  • a bool indicating if the event is within the artist
  • a dict of additional information. The dict should at least return the same information as the default contains() implementation of the respective artist, but may provide additional information.

Notes

Deprecated since version 3.3.

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/_as_gen/matplotlib.artist.Artist.set_contains.html