track_click_position#

Plotter.track_click_position(callback=None, side='right', double=False, viewport=False)#

Keep track of the click position.

By default, it only tracks right clicks.

Parameters
callbackcallable(), optional

A callable method that will use the click position. Passes the click position as a length two tuple.

sidestr, optional

The mouse button to track (either 'left' or 'right'). Default is 'right'. Also accepts 'r' or 'l'.

doublebool, optional

Track single clicks if False, double clicks if True. Defaults to single clicks False.

viewportbool, optional

If True, uses the normalized viewport coordinate system (values between 0.0 and 1.0 and support for HiDPI) when passing the click position to the callback.