MCPcopy Index your code
hub / github.com/matplotlib/matplotlib / get_cursor_data

Method get_cursor_data

lib/matplotlib/artist.py:1382–1411  ·  view source on GitHub ↗

Return the cursor data for a given event. .. note:: This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself. Cursor data can be used by Artists to pro

(self, event)

Source from the content-addressed store, hash-verified

1380 return artists
1381
1382 def get_cursor_data(self, event):
1383 """
1384 Return the cursor data for a given event.
1385
1386 .. note::
1387 This method is intended to be overridden by artist subclasses.
1388 As an end-user of Matplotlib you will most likely not call this
1389 method yourself.
1390
1391 Cursor data can be used by Artists to provide additional context
1392 information for a given event. The default implementation just returns
1393 *None*.
1394
1395 Subclasses can override the method and return arbitrary data. However,
1396 when doing so, they must ensure that `.format_cursor_data` can convert
1397 the data to a string representation.
1398
1399 The only current use case is displaying the z-value of an `.AxesImage`
1400 in the status bar of a plot window, while moving the mouse.
1401
1402 Parameters
1403 ----------
1404 event : `~matplotlib.backend_bases.MouseEvent`
1405
1406 See Also
1407 --------
1408 format_cursor_data
1409
1410 """
1411 return None
1412
1413 def format_cursor_data(self, data):
1414 """

Calls

no outgoing calls